AbodeONE

<back to all web services

CreateCharge

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/charges
CreateCharge Parameters:
NameParameterData TypeRequiredDescription
ChargeTypeIdbodyintNo
StudentIdbodyintNo
AmountbodydecimalNo
ChargeDatebodyDateTimeNo
DescriptionbodystringNo
BuildingIdbodyintNo
CheckedBybodystringNo
DisciplineIdbodyint?No
CashPaidbodydecimal?No
CashPaidDatebodyDateTime?No
AccountPaidbodydecimal?No
SubmittedDatebodyDateTime?No
AppliedDatebodyDateTime?No
CreateChargeResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformChargeDTONo
ResponseStatusformResponseStatusNo
ChargeDTO Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
ChargeTypeIdformintNo
StudentIdformintNo
AmountformdecimalNo
ChargeDateformDateTimeNo
DescriptionformstringNo
BuildingIdformintNo
CheckedByformstringNo
DisciplineIdformint?No
CashPaidformdecimal?No
CashPaidDateformDateTime?No
AccountPaidformdecimal?No
SubmittedDateformDateTime?No
AppliedDateformDateTime?No
Tracked Parameters:
NameParameterData TypeRequiredDescription
CreatedDtformDateTimeNo
CreatedByformstringNo
ModifiedDtformDateTime?No
ModifiedByformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST //charges HTTP/1.1 
Host: api.lsu-staging.abodehms.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"chargeTypeId":0,"studentId":0,"amount":0,"chargeDate":"0001-01-01T00:00:00.0000000","description":"String","buildingId":0,"checkedBy":"String","disciplineId":0,"cashPaid":0,"cashPaidDate":"0001-01-01T00:00:00.0000000","accountPaid":0,"submittedDate":"0001-01-01T00:00:00.0000000","appliedDate":"0001-01-01T00:00:00.0000000"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"result":{"id":0,"chargeTypeId":0,"studentId":0,"amount":0,"chargeDate":"0001-01-01T00:00:00.0000000","description":"String","buildingId":0,"checkedBy":"String","disciplineId":0,"cashPaid":0,"cashPaidDate":"0001-01-01T00:00:00.0000000","accountPaid":0,"submittedDate":"0001-01-01T00:00:00.0000000","appliedDate":"0001-01-01T00:00:00.0000000","createdDt":"0001-01-01T00:00:00.0000000","createdBy":"String","modifiedDt":"0001-01-01T00:00:00.0000000","modifiedBy":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}