| Required role: | Admin |
| GET | /guest_event/{GuestEventId}/guest_residents/report |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| GuestEventId | path | int | No | |
| GuestResidentStatus | query | string | No | |
| GuestResidentStatuses | query | List<string> | No | |
| BuildingIds | query | ArrayOfInt | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Result | form | List<GuestEventResidencyReportDTO> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BuildingName | form | string | No | |
| RoomName | form | string | No | |
| HostSchoolid | form | string | No | |
| HostFirstName | form | string | No | |
| HostLastName | form | string | No | |
| HostFullName | form | string | No | |
| GuestFirstName | form | string | No | |
| GuestLastName | form | string | No | |
| GuestFullName | form | string | No | |
| GuestResidencyStatus | form | string | No | |
| MoveInDate | form | DateTime | No | |
| MoveOutDate | form | DateTime | No | |
| SchoolOrg | form | string | No | |
| HostPayment | form | decimal? | No | |
| ChaperoneFirstName | form | string | No | |
| ChaperoneLastName | form | string | No | |
| ChaperoneFullName | form | string | No | |
| ChaperonePhone | form | string | No | |
| HostPhone | form | string | No | |
| GuestType | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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-staging.abodehms.com
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
moveOutDate: 0001-01-01,
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
}
}
}