| All Verbs | /student/{StudentId}/residencies |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StudentId | path | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Result | form | List<ResidentDTO> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResidentId | form | int | No | |
| StudentId | form | int | No | |
| SchoolId | form | string | No | |
| FirstName | form | string | No | |
| LastName | form | string | No | |
| DisplayName | form | string | No | |
| BedId | form | int | No | |
| Mailbox | form | string | No | |
| RoomId | form | int | No | |
| RoomRateId | form | int? | No | |
| Room | form | string | No | |
| RoomCode | form | string | No | |
| Wing | form | string | No | |
| Building | form | string | No | |
| BuildingCode | form | string | No | |
| MoveInDate | form | DateTime? | No | |
| MoveOutDate | form | DateTime? | No | |
| ReserveStartDt | form | DateTime? | No | |
| ReserveEndDt | form | DateTime? | No | |
| CheckInUserId | form | int? | No | |
| CheckInUser | form | string | No | |
| Status | form | string | No | |
| TermCode | form | string | No | |
| DftBillingType | form | string | No | |
| BillingStartOption | form | string | No | |
| BillingEndOption | form | string | No | |
| IsBillable | 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 //student/{StudentId}/residencies HTTP/1.1
Host: api.lsu.abodehms.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
studentId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
result:
[
{
residentId: 0,
studentId: 0,
schoolId: String,
firstName: String,
lastName: String,
displayName: String,
bedId: 0,
mailbox: String,
roomId: 0,
roomRateId: 0,
room: String,
roomCode: String,
wing: String,
building: String,
buildingCode: String,
moveInDate: 0001-01-01,
moveOutDate: 0001-01-01,
reserveStartDt: 0001-01-01,
reserveEndDt: 0001-01-01,
checkInUserId: 0,
checkInUser: String,
status: String,
termCode: String,
dftBillingType: String,
billingStartOption: String,
billingEndOption: String,
isBillable: False
}
],
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}