AbodeONE

<back to all web services

MoveInResident

Requires Authentication
The following routes are available for this service:
POST/student/{StudentId}/move_in
PATCH/student/{StudentId}/move_in
MoveInResident Parameters:
NameParameterData TypeRequiredDescription
StudentIdpathint?No
BedIdbodyint?No
RoomRateIdbodyint?No
ReservationIdbodyint?No
MoveInDatebodyDateTime?No
DftBillingTypebodyBillingTypeEnum?No
BillingStartOptionbodyBillingStartOptionEnum?No
BillingEndOptionbodyBillingEndOptionEnum?No
IsBillablebodybool?No
MealPlanIdbodyint?No
ParentalContactbodystringNo
LeavePermissionsbodystringNo
RoomRatePeriodbodystringNo
OverrideWarningsbodybool?No
IsPreviewbodyboolNo
BillingTypeEnum Enum:
None
Full
Prorate
Schedule
BillingStartOptionEnum Enum:
Auto
Term
MoveIn
BillingEndOptionEnum Enum:
Auto
Term
MoveOut
ResidentResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformResidentDTONo
ResponseStatusformResponseStatusNo
ResidentDTO Parameters:
NameParameterData TypeRequiredDescription
ResidentIdformintNo
StudentIdformintNo
SchoolIdformstringNo
FirstNameformstringNo
LastNameformstringNo
DisplayNameformstringNo
BedIdformintNo
MailboxformstringNo
RoomIdformintNo
RoomRateIdformint?No
RoomformstringNo
RoomCodeformstringNo
WingformstringNo
BuildingformstringNo
BuildingCodeformstringNo
MoveInDateformDateTime?No
MoveOutDateformDateTime?No
ReserveStartDtformDateTime?No
ReserveEndDtformDateTime?No
CheckInUserIdformint?No
CheckInUserformstringNo
StatusformstringNo
TermCodeformstringNo
DftBillingTypeformstringNo
BillingStartOptionformstringNo
BillingEndOptionformstringNo
IsBillableformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + 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.lsu-staging.abodehms.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{Unable to show example output for type 'MoveInResident' using the custom 'csv' filter}One or more errors occurred. (Unable to cast object of type 'ServiceStack.Host.BasicResponse' to type 'ServiceStack.Host.NetCore.NetCoreResponse'.)
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{Unable to show example output for type 'ResidentResponse' using the custom 'csv' filter}One or more errors occurred. (Unable to cast object of type 'ServiceStack.Host.BasicResponse' to type 'ServiceStack.Host.NetCore.NetCoreResponse'.)