| POST | /student/{StudentId}/move_in | ||
|---|---|---|---|
| PATCH | /student/{StudentId}/move_in |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StudentId | path | int? | No | |
| BedId | body | int? | No | |
| RoomRateId | body | int? | No | |
| ReservationId | body | int? | No | |
| MoveInDate | body | DateTime? | No | |
| DftBillingType | body | BillingTypeEnum? | No | |
| BillingStartOption | body | BillingStartOptionEnum? | No | |
| BillingEndOption | body | BillingEndOptionEnum? | No | |
| IsBillable | body | bool? | No | |
| MealPlanId | body | int? | No | |
| ParentalContact | body | string | No | |
| LeavePermissions | body | string | No | |
| RoomRatePeriod | body | string | No | |
| OverrideWarnings | body | bool? | No | |
| IsPreview | body | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Result | form | 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 .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /student/{StudentId}/move_in HTTP/1.1
Host: api.oau.abodehms.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"studentId":0,"bedId":0,"roomRateId":0,"reservationId":0,"moveInDate":"0001-01-01T00:00:00.0000000","dftBillingType":"None","billingStartOption":"Auto","billingEndOption":"Auto","isBillable":false,"mealPlanId":0,"parentalContact":"String","leavePermissions":"String","roomRatePeriod":"String","overrideWarnings":false,"isPreview":false}
HTTP/1.1 200 OK
Content-Type: text/csv
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-01T00:00:00.0000000","moveOutDate":"0001-01-01T00:00:00.0000000","reserveStartDt":"0001-01-01T00:00:00.0000000","reserveEndDt":"0001-01-01T00:00:00.0000000","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"}}}