AbodeONE

<back to all web services

GetInspection

Requires Authentication
Required role:Admin
The following routes are available for this service:
GET/inspections/{InspectionId}
GET/student/{StudentId}/inspections/current
GetInspection Parameters:
NameParameterData TypeRequiredDescription
InspectionIdpathint?No
StudentIdpathint?No
SchoolidquerystringNo
ResidentIdqueryint?No
GetInspectionResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformInspectionDTONo
ResponseStatusformResponseStatusNo
InspectionDTO Parameters:
NameParameterData TypeRequiredDescription
InspectionIdformintNo
StudentIdformintNo
RoomIdformintNo
ResidentIdformintNo
ReservationIdformintNo
InspectionDtformDateTimeNo
RepairsNeededformstringNo
CommentsformstringNo
StudentSignatureTextformstringNo
RaSignatureTextformstringNo
CreatedDtformDateTimeNo
CreatedByformstringNo
ModifiedDtformDateTimeNo
ModifiedByformstringNo
DetailsformList<InspectionDetailDTO>No
InspectionDetailDTO Parameters:
NameParameterData TypeRequiredDescription
InspectionDetailIdformint?No
InspectionIdformintNo
NameformstringNo
OrderformintNo
ItemStateformInspectionStateEnum?No
NotesformstringNo
InspectionStateEnum Enum:
Good
Problem

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.

GET //inspections/{InspectionId} HTTP/1.1 
Host: api.lsu-staging.abodehms.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"result":{"inspectionId":0,"studentId":0,"roomId":0,"residentId":0,"reservationId":0,"inspectionDt":"0001-01-01T00:00:00.0000000","repairsNeeded":"String","comments":"String","studentSignatureText":"String","raSignatureText":"String","createdDt":"0001-01-01T00:00:00.0000000","createdBy":"String","modifiedDt":"0001-01-01T00:00:00.0000000","modifiedBy":"String","details":[{"inspectionDetailId":0,"inspectionId":0,"name":"String","order":0,"itemState":"Good","notes":"String"}]},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}