| Required role: | Admin |
| POST | /check |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RoomStateId | body | int | No | |
| StudentId | body | int | No | |
| Reason | body | string | No | |
| Comments | body | string | No | |
| CheckTypeId | body | int | No | |
| CheckDt | body | DateTime? | No | |
| Grace | body | int | No | |
| ExcusedBy | body | int | No | |
| Status | body | string | No | |
| CheckClass | body | string | No | |
| LeaveId | body | int | No | |
| NightOf | body | DateTime | No | |
| ExcusedReason | body | string | No | |
| ExcusedDt | body | DateTime? | No | |
| CheckTypeName | body | string | No | |
| ExcusedByUser | body | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Result | form | CheckDTO | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CheckId | form | int | No | |
| RoomStateId | form | int | No | |
| EntryStamp | form | DateTime? | No | |
| StudentId | form | int | No | |
| Reason | form | string | No | |
| Comments | form | string | No | |
| CheckTypeId | form | int | No | |
| CheckDt | form | DateTime? | No | |
| Grace | form | int | No | |
| CurfewDt | form | DateTime | No | |
| ExcusedBy | form | int | No | |
| Status | form | string | No | |
| CheckClass | form | string | No | |
| LeaveId | form | int | No | |
| NightOf | form | DateTime | No | |
| ViolationDt | form | DateTime | No | |
| ExcusedReason | form | string | No | |
| ExcusedDt | form | DateTime? | No | |
| Imported | form | int | No | |
| CreatedDt | form | DateTime | No | |
| CreatedBy | form | string | No | |
| ModifiedDt | form | DateTime | No | |
| ModifiedBy | form | string | No | |
| CheckTypeName | form | string | No | |
| ExcusedByUser | form | string | No | |
| IsPresent | form | bool? | No |
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.
POST //check HTTP/1.1
Host: api.lsu.abodehms.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
roomStateId: 0,
studentId: 0,
reason: String,
comments: String,
checkTypeId: 0,
checkDt: 0001-01-01,
grace: 0,
excusedBy: 0,
status: String,
checkClass: String,
leaveId: 0,
nightOf: 0001-01-01,
excusedReason: String,
excusedDt: 0001-01-01,
checkTypeName: String,
excusedByUser: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
result:
{
checkId: 0,
roomStateId: 0,
entryStamp: 0001-01-01,
studentId: 0,
reason: String,
comments: String,
checkTypeId: 0,
checkDt: 0001-01-01,
grace: 0,
curfewDt: 0001-01-01,
excusedBy: 0,
status: String,
checkClass: String,
leaveId: 0,
nightOf: 0001-01-01,
violationDt: 0001-01-01,
excusedReason: String,
excusedDt: 0001-01-01,
imported: 0,
createdDt: 0001-01-01,
createdBy: String,
modifiedDt: 0001-01-01,
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
}
}
}