AbodeONE

<back to all web services

ReserveGuestResident

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/guest_resident/reserve
ReserveGuestResident Parameters:
NameParameterData TypeRequiredDescription
GuestRoomSlotIdbodyintNo
StudentIdbodyint?No
GuestIdbodyint?No
IsAutoMoveOutbodyshort?No
StartDtbodyDateTimeNo
EndDtbodyDateTimeNo
OverrideWarningsbodybool?No
GuestResidentResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformGuestResidentDTONo
ResponseStatusformResponseStatusNo
GuestResidentDTO Parameters:
NameParameterData TypeRequiredDescription
GuestResidentIdformintNo
GuestRoomSlotIdformintNo
RoomIdformintNo
GuestEventIdformint?No
StudentIdformint?No
GuestIdformint?No
IsAutoMoveoutformshortNo
StatusformstringNo
StartDtformDateTimeNo
EndDtformDateTimeNo
LastStatusUserformstringNo
LastStatusDtformDateTimeNo
MoveInUserformstringNo
MoveOutUserformstringNo
CreatedByformstringNo
CreatedDtformDateTimeNo
LastModifiedByformstringNo
LastModifiedDtformDateTimeNo
FirstNameformstringNo
LastNameformstringNo
FullNameformstringNo
BuildingIdformintNo
BuildingNameformstringNo
WingIdformintNo
WingNameformstringNo
RoomNameformstringNo

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST //guest_resident/reserve HTTP/1.1 
Host: api.lsu-staging.abodehms.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	guestRoomSlotId: 0,
	studentId: 0,
	guestId: 0,
	isAutoMoveOut: 0,
	startDt: 0001-01-01,
	endDt: 0001-01-01,
	overrideWarnings: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	{
		guestResidentId: 0,
		guestRoomSlotId: 0,
		roomId: 0,
		guestEventId: 0,
		studentId: 0,
		guestId: 0,
		isAutoMoveout: 0,
		status: String,
		startDt: 0001-01-01,
		endDt: 0001-01-01,
		lastStatusUser: String,
		lastStatusDt: 0001-01-01,
		moveInUser: String,
		moveOutUser: String,
		createdBy: String,
		createdDt: 0001-01-01,
		lastModifiedBy: String,
		lastModifiedDt: 0001-01-01,
		firstName: String,
		lastName: String,
		fullName: String,
		buildingId: 0,
		buildingName: String,
		wingId: 0,
		wingName: String,
		roomName: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}