AbodeONE

<back to all web services

FindGuestEvents

Requires Authentication
The following routes are available for this service:
GET/guest_events
FindGuestEvents Parameters:
NameParameterData TypeRequiredDescription
StartDtqueryDateTime?No
EndDtqueryDateTime?No
FindOpenRegistrationqueryboolNo
TermIdqueryint?No
GuestEventsResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformList<GuestEventDTO>No
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET //guest_events HTTP/1.1 
Host: api.lsu-staging.abodehms.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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