AbodeONE

<back to all web services

FindChecks

Requires Authentication
Required role:Admin
The following routes are available for this service:
All Verbs/student/{StudentId}/checks
FindChecks Parameters:
NameParameterData TypeRequiredDescription
StudentIdpathint?No
LeaveIdqueryint?No
CheckClassquerystringNo
NightOfqueryDateTime?No
NightOfStartqueryDateTime?No
NightOfEndqueryDateTime?No
StatusquerystringNo
ChecksResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformList<CheckDTO>No
ResponseStatusformResponseStatusNo
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

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

HTTP + CSV

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

POST //student/{StudentId}/checks HTTP/1.1 
Host: api.lsu-staging.abodehms.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{Unable to show example output for type 'FindChecks' using the custom 'csv' filter}One or more errors occurred. (Unable to cast object of type 'ServiceStack.Host.BasicResponse' to type 'ServiceStack.Host.NetCore.NetCoreResponse'.)
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{Unable to show example output for type 'ChecksResponse' using the custom 'csv' filter}One or more errors occurred. (Unable to cast object of type 'ServiceStack.Host.BasicResponse' to type 'ServiceStack.Host.NetCore.NetCoreResponse'.)