AbodeONE

<back to all web services

GetGuest

Requires Authentication
Requires any of the roles:Admin, Guest, HeadChaperone
The following routes are available for this service:
GET/guest
GetGuest Parameters:
NameParameterData TypeRequiredDescription
GuestIdqueryint?No
ChaperoneIdqueryint?No
StudentIdqueryint?No
GuestEventIdqueryint?No
GuestResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformGuestDTONo
ResponseStatusformResponseStatusNo
GuestDTO Parameters:
NameParameterData TypeRequiredDescription
GuestIdformintNo
StudentIdformint?No
SchoolidformstringNo
ChaperoneIdformint?No
GuestEventIdformint?No
UsernameformstringNo
FirstNameformstringNo
LastNameformstringNo
GuestTypeformstringNo
GenderformstringNo
Address1formstringNo
Address2formstringNo
CityformstringNo
StateformstringNo
PostalformstringNo
CountryformstringNo
PhoneformstringNo
EmailformstringNo
SchoolOrgformstringNo
CodeformstringNo
NotesformstringNo
GroupStatusformstringNo
PaidAmountformdecimalNo
IsPaidformboolNo
AppliedAmountformdecimal?No
AppliedByformdecimal?No
TshirtSizeformstringNo
InvitedDtformDateTime?No
LastLoginDtformDateTime?No
FullNameformstringNo
StudentFullNameformstringNo
ChaperoneFullNameformstringNo
ChaperonePhoneformstringNo
ChaperoneHotelformstringNo
ChaperoneHotelPhoneformstringNo
GuestEventNameformstringNo
PasswordResetLinkformstringNo

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 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":{"guestId":0,"studentId":0,"schoolid":"String","chaperoneId":0,"guestEventId":0,"username":"String","firstName":"String","lastName":"String","guestType":"String","gender":"String","address1":"String","address2":"String","city":"String","state":"String","postal":"String","country":"String","phone":"String","email":"String","schoolOrg":"String","code":"String","notes":"String","groupStatus":"String","paidAmount":0,"isPaid":false,"appliedAmount":0,"appliedBy":0,"tshirtSize":"String","invitedDt":"0001-01-01T00:00:00.0000000","lastLoginDt":"0001-01-01T00:00:00.0000000","fullName":"String","studentFullName":"String","chaperoneFullName":"String","chaperonePhone":"String","chaperoneHotel":"String","chaperoneHotelPhone":"String","guestEventName":"String","passwordResetLink":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}