AbodeONE

<back to all web services

GetGuestEvent

Requires Authentication
Requires the role:Admin
The following routes are available for this service:
GET/guest_event
GetGuestEvent Parameters:
NameParameterData TypeRequiredDescription
GuestEventIdqueryintNo
GuestEventResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformGuestEventDTONo
ResponseStatusformResponseStatusNo
GuestEventDTO Parameters:
NameParameterData TypeRequiredDescription
GuestEventIdformintNo
TermIdformint?No
NameformstringNo
DescriptionformstringNo
HostingTextformstringNo
OpenDtformDateTime?No
CloseDtformDateTime?No
StartDtformDateTime?No
EndDtformDateTime?No
DefaultAutoMoveoutformshort?No
DefaultHostPaymentformdecimal?No
RegistrationOpenDtformDateTime?No
RegistrationLateDtformDateTime?No
RegistrationCloseDtformDateTime?No

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.

GET //guest_event HTTP/1.1 
Host: api.lsu.abodehms.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	{
		guestEventId: 0,
		termId: 0,
		name: String,
		description: String,
		hostingText: String,
		openDt: 0001-01-01,
		closeDt: 0001-01-01,
		startDt: 0001-01-01,
		endDt: 0001-01-01,
		defaultAutoMoveout: 0,
		defaultHostPayment: 0,
		registrationOpenDt: 0001-01-01,
		registrationLateDt: 0001-01-01,
		registrationCloseDt: 0001-01-01
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}