| Required role: | Admin |
| GET | /inspections/{InspectionId} | ||
|---|---|---|---|
| GET | /student/{StudentId}/inspections/current |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| InspectionId | path | int? | No | |
| StudentId | path | int? | No | |
| Schoolid | query | string | No | |
| ResidentId | query | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Result | form | InspectionDTO | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| InspectionId | form | int | No | |
| StudentId | form | int | No | |
| RoomId | form | int | No | |
| ResidentId | form | int | No | |
| ReservationId | form | int | No | |
| InspectionDt | form | DateTime | No | |
| RepairsNeeded | form | string | No | |
| Comments | form | string | No | |
| StudentSignatureText | form | string | No | |
| RaSignatureText | form | string | No | |
| CreatedDt | form | DateTime | No | |
| CreatedBy | form | string | No | |
| ModifiedDt | form | DateTime | No | |
| ModifiedBy | form | string | No | |
| Details | form | List<InspectionDetailDTO> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| InspectionDetailId | form | int? | No | |
| InspectionId | form | int | No | |
| Name | form | string | No | |
| Order | form | int | No | |
| ItemState | form | InspectionStateEnum? | No | |
| Notes | form | string | No |
| Good |
| Problem |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
result:
{
inspectionId: 0,
studentId: 0,
roomId: 0,
residentId: 0,
reservationId: 0,
inspectionDt: 0001-01-01,
repairsNeeded: String,
comments: String,
studentSignatureText: String,
raSignatureText: String,
createdDt: 0001-01-01,
createdBy: String,
modifiedDt: 0001-01-01,
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
}
}
}