AbodeONE

<back to all web services

UploadCheck

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/check
UploadCheck Parameters:
NameParameterData TypeRequiredDescription
ResidentChecksbodyList<CheckDTO>No
CreateCheck Parameters:
NameParameterData TypeRequiredDescription
RoomStateIdformintNo
StudentIdformintNo
ReasonformstringNo
CommentsformstringNo
CheckTypeIdformintNo
CheckDtformDateTime?No
GraceformintNo
ExcusedByformintNo
StatusformstringNo
CheckClassformstringNo
LeaveIdformintNo
NightOfformDateTimeNo
ExcusedReasonformstringNo
ExcusedDtformDateTime?No
CheckTypeNameformstringNo
ExcusedByUserformstringNo
CheckDTO Parameters:
NameParameterData TypeRequiredDescription
CheckIdformintNo
RoomStateIdformintNo
EntryStampformDateTime?No
StudentIdformintNo
ReasonformstringNo
CommentsformstringNo
CheckTypeIdformintNo
CheckDtformDateTime?No
GraceformintNo
CurfewDtformDateTimeNo
ExcusedByformintNo
StatusformstringNo
CheckClassformstringNo
LeaveIdformintNo
NightOfformDateTimeNo
ViolationDtformDateTimeNo
ExcusedReasonformstringNo
ExcusedDtformDateTime?No
ImportedformintNo
CreatedDtformDateTimeNo
CreatedByformstringNo
ModifiedDtformDateTimeNo
ModifiedByformstringNo
CheckTypeNameformstringNo
ExcusedByUserformstringNo
IsPresentformbool?No
CheckResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformCheckDTONo
ResponseStatusformResponseStatusNo

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 //check HTTP/1.1 
Host: api.lsu-staging.abodehms.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"residentChecks":[{"checkId":0,"roomStateId":0,"entryStamp":"0001-01-01T00:00:00.0000000","studentId":0,"reason":"String","comments":"String","checkTypeId":0,"checkDt":"0001-01-01T00:00:00.0000000","grace":0,"curfewDt":"0001-01-01T00:00:00.0000000","excusedBy":0,"status":"String","checkClass":"String","leaveId":0,"nightOf":"0001-01-01T00:00:00.0000000","violationDt":"0001-01-01T00:00:00.0000000","excusedReason":"String","excusedDt":"0001-01-01T00:00:00.0000000","imported":0,"createdDt":"0001-01-01T00:00:00.0000000","createdBy":"String","modifiedDt":"0001-01-01T00:00:00.0000000","modifiedBy":"String","checkTypeName":"String","excusedByUser":"String","isPresent":false}],"roomStateId":0,"studentId":0,"reason":"String","comments":"String","checkTypeId":0,"checkDt":"0001-01-01T00:00:00.0000000","grace":0,"excusedBy":0,"status":"String","checkClass":"String","leaveId":0,"nightOf":"0001-01-01T00:00:00.0000000","excusedReason":"String","excusedDt":"0001-01-01T00:00:00.0000000","checkTypeName":"String","excusedByUser":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"result":{"checkId":0,"roomStateId":0,"entryStamp":"0001-01-01T00:00:00.0000000","studentId":0,"reason":"String","comments":"String","checkTypeId":0,"checkDt":"0001-01-01T00:00:00.0000000","grace":0,"curfewDt":"0001-01-01T00:00:00.0000000","excusedBy":0,"status":"String","checkClass":"String","leaveId":0,"nightOf":"0001-01-01T00:00:00.0000000","violationDt":"0001-01-01T00:00:00.0000000","excusedReason":"String","excusedDt":"0001-01-01T00:00:00.0000000","imported":0,"createdDt":"0001-01-01T00:00:00.0000000","createdBy":"String","modifiedDt":"0001-01-01T00:00:00.0000000","modifiedBy":"String","checkTypeName":"String","excusedByUser":"String","isPresent":false},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}