AbodeONE

<back to all web services

CreateGuestHostResponse

Requires Authentication
Requires the role:Admin
The following routes are available for this service:
POST/guest_host_response
CreateGuestHostResponse Parameters:
NameParameterData TypeRequiredDescription
StudentIdbodyintNo
GuestEventIdbodyintNo
NumGuestsDesiredbodyintNo
RequestedGuest1bodystringNo
RequestedGuest2bodystringNo
CommentsbodystringNo
GuestHostResponseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformGuestHostResponseDTONo
ResponseStatusformResponseStatusNo
GuestHostResponseDTO Parameters:
NameParameterData TypeRequiredDescription
GuestHostResponseIdformintNo
RoomIdformintNo
GuestEventIdformintNo
StudentIdformintNo
AskResidentsToHostformshortNo
NumGuestsDesiredformintNo
RequestedGuest1formstringNo
RequestedGuest2formstringNo
CommentsformstringNo

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_host_response HTTP/1.1 
Host: api.lsu-staging.abodehms.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	studentId: 0,
	guestEventId: 0,
	numGuestsDesired: 0,
	requestedGuest1: String,
	requestedGuest2: String,
	comments: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	{
		guestHostResponseId: 0,
		roomId: 0,
		guestEventId: 0,
		studentId: 0,
		askResidentsToHost: 0,
		numGuestsDesired: 0,
		requestedGuest1: String,
		requestedGuest2: String,
		comments: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}