AbodeONE

<back to all web services

GetGuestEventResidencyReport

Requires Authentication
Required role:Admin
The following routes are available for this service:
GET/guest_event/{GuestEventId}/guest_residents/report
GetGuestEventResidencyReport Parameters:
NameParameterData TypeRequiredDescription
GuestEventIdpathintNo
GuestResidentStatusquerystringNo
GuestResidentStatusesqueryList<string>No
BuildingIdsqueryArrayOfIntNo
GuestEventResidencyReportResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformList<GuestEventResidencyReportDTO>No
ResponseStatusformResponseStatusNo
GuestEventResidencyReportDTO Parameters:
NameParameterData TypeRequiredDescription
BuildingNameformstringNo
RoomNameformstringNo
HostSchoolidformstringNo
HostFirstNameformstringNo
HostLastNameformstringNo
HostFullNameformstringNo
GuestFirstNameformstringNo
GuestLastNameformstringNo
GuestFullNameformstringNo
GuestResidencyStatusformstringNo
MoveInDateformDateTimeNo
MoveOutDateformDateTimeNo
SchoolOrgformstringNo
HostPaymentformdecimal?No
ChaperoneFirstNameformstringNo
ChaperoneLastNameformstringNo
ChaperoneFullNameformstringNo
ChaperonePhoneformstringNo
HostPhoneformstringNo
GuestTypeformstringNo

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_event/{GuestEventId}/guest_residents/report HTTP/1.1 
Host: api.lsu.abodehms.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"result":[{"buildingName":"String","roomName":"String","hostSchoolid":"String","hostFirstName":"String","hostLastName":"String","hostFullName":"String","guestFirstName":"String","guestLastName":"String","guestFullName":"String","guestResidencyStatus":"String","moveInDate":"0001-01-01T00:00:00.0000000","moveOutDate":"0001-01-01T00:00:00.0000000","schoolOrg":"String","hostPayment":0,"chaperoneFirstName":"String","chaperoneLastName":"String","chaperoneFullName":"String","chaperonePhone":"String","hostPhone":"String","guestType":"String"}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}