A valid request URL is required to generate request examples{
"aqEventEndTime": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"totalCost": 12345,
"name": "...",
"aqCreateTime": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"sysidConfirmationNumber": 12345,
"comment": "...",
"reservations": [
{
"discriminator": "...",
"chargeCodes": [
{
"percent": 12345,
"sysidReservationChargeCode": 12345,
"chargeCode": "..."
},
{
"percent": 12345,
"sysidReservationChargeCode": 12345,
"chargeCode": "..."
}
],
"qrCode": {
"sysidQRCode": 12345,
"sysidQRCodeType": 12345,
"codeValue": "...",
"sysidReference": 12345
},
"sysidColorCode": 12345,
"accessTokenExpirationTime": 12345,
"sysidUserOwner": 12345,
"emailComments": "...",
"startTime": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"roomConfiguration": {
"thumbnailSource": "...",
"breakDownMinutes": 12345,
"description": "...",
"name": "...",
"imageSource": "...",
"sysidRoomConfiguration": 12345,
"setupMinutes": 12345
},
"sysidResourcePricings": 12345,
"accessToken": "...",
"privateResv": true,
"userOwnerView": {
"privateProfile": true,
"lastName": "...",
"city": "...",
"postalCode": "...",
"middleInitial": "...",
"country": "...",
"roleName": "...",
"address1": "...",
"mobilePhone": "...",
"sysidUser": 12345,
"stateProvince": "...",
"department": "...",
"workPhone": "...",
"sysidStatus": 12345,
"images": [
{},
{}
],
"sysidHomeLocation": 12345,
"sysidLanguage": 12345,
"emailAddress": "...",
"firstName": "...",
"originalUser": true,
"locationName": "...",
"address2": "...",
"accountLocked": true,
"statusMessage": "...",
"title": "..."
},
"stateHistories": [
{
"sysidApplication": 12345,
"userPerformerView": {},
"sysidUserPerformer": 12345,
"aqStateDate": {},
"sysidReservationStateType": 12345,
"sysidReservationActionType": 12345
},
{
"sysidApplication": 12345,
"userPerformerView": {},
"sysidUserPerformer": 12345,
"aqStateDate": {},
"sysidReservationStateType": 12345,
"sysidReservationActionType": 12345
}
],
"name": "...",
"sysidPrevConfirmationNumber": 12345,
"sysidReservation": 12345,
"sysidParentReservation": 12345,
"suppressEmails": true,
"pricings": {
"aqActiveDate": {},
"sysidResource": 12345,
"sysidResourcePricings": 12345,
"pricings": [
{},
{}
]
},
"chargeBackAmount": 12345,
"sysidCategory": 12345,
"endTime": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"resourceType": "ROOM",
"locationNow": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"sysidResource": 12345,
"sysidCreatorApplication": 12345,
"children": [
{},
{}
],
"breakDownTime": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"setupTime": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"sysidRoomConfiguration": 12345,
"sysidConfirmationNumber": 12345,
"uuid": "...",
"comments": "...",
"recurrenceRule": {
"aqEndDate": {},
"sysidRecurrencePatternType": 12345,
"onSaturday": true,
"onMonday": true,
"onTuesday": true,
"sysidRecurrenceRule": 12345,
"onSunday": true,
"occurrences": 12345,
"sysidMonthlyDayOccurrenceType": 12345,
"theDate": 12345,
"onThursday": true,
"sysidMonthlyDayType": 12345,
"onFriday": true,
"aqStartDate": {},
"onWednesday": true,
"exceptions": [
{},
{}
],
"interval": 12345
},
"sysidResourceAccount": 12345
},
{
"discriminator": "...",
"chargeCodes": [
{
"percent": 12345,
"sysidReservationChargeCode": 12345,
"chargeCode": "..."
},
{
"percent": 12345,
"sysidReservationChargeCode": 12345,
"chargeCode": "..."
}
],
"qrCode": {
"sysidQRCode": 12345,
"sysidQRCodeType": 12345,
"codeValue": "...",
"sysidReference": 12345
},
"sysidColorCode": 12345,
"accessTokenExpirationTime": 12345,
"sysidUserOwner": 12345,
"emailComments": "...",
"startTime": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"roomConfiguration": {
"thumbnailSource": "...",
"breakDownMinutes": 12345,
"description": "...",
"name": "...",
"imageSource": "...",
"sysidRoomConfiguration": 12345,
"setupMinutes": 12345
},
"sysidResourcePricings": 12345,
"accessToken": "...",
"privateResv": true,
"userOwnerView": {
"privateProfile": true,
"lastName": "...",
"city": "...",
"postalCode": "...",
"middleInitial": "...",
"country": "...",
"roleName": "...",
"address1": "...",
"mobilePhone": "...",
"sysidUser": 12345,
"stateProvince": "...",
"department": "...",
"workPhone": "...",
"sysidStatus": 12345,
"images": [
{},
{}
],
"sysidHomeLocation": 12345,
"sysidLanguage": 12345,
"emailAddress": "...",
"firstName": "...",
"originalUser": true,
"locationName": "...",
"address2": "...",
"accountLocked": true,
"statusMessage": "...",
"title": "..."
},
"stateHistories": [
{
"sysidApplication": 12345,
"userPerformerView": {},
"sysidUserPerformer": 12345,
"aqStateDate": {},
"sysidReservationStateType": 12345,
"sysidReservationActionType": 12345
},
{
"sysidApplication": 12345,
"userPerformerView": {},
"sysidUserPerformer": 12345,
"aqStateDate": {},
"sysidReservationStateType": 12345,
"sysidReservationActionType": 12345
}
],
"name": "...",
"sysidPrevConfirmationNumber": 12345,
"sysidReservation": 12345,
"sysidParentReservation": 12345,
"suppressEmails": true,
"pricings": {
"aqActiveDate": {},
"sysidResource": 12345,
"sysidResourcePricings": 12345,
"pricings": [
{},
{}
]
},
"chargeBackAmount": 12345,
"sysidCategory": 12345,
"endTime": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"resourceType": "ROOM",
"locationNow": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"sysidResource": 12345,
"sysidCreatorApplication": 12345,
"children": [
{},
{}
],
"breakDownTime": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"setupTime": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"sysidRoomConfiguration": 12345,
"sysidConfirmationNumber": 12345,
"uuid": "...",
"comments": "...",
"recurrenceRule": {
"aqEndDate": {},
"sysidRecurrencePatternType": 12345,
"onSaturday": true,
"onMonday": true,
"onTuesday": true,
"sysidRecurrenceRule": 12345,
"onSunday": true,
"occurrences": 12345,
"sysidMonthlyDayOccurrenceType": 12345,
"theDate": 12345,
"onThursday": true,
"sysidMonthlyDayType": 12345,
"onFriday": true,
"aqStartDate": {},
"onWednesday": true,
"exceptions": [
{},
{}
],
"interval": 12345
},
"sysidResourceAccount": 12345
}
],
"discriminator": "...",
"sysidEventCreator": 12345,
"sysidEventOwner": 12345,
"recurrenceRule": {
"aqEndDate": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"sysidRecurrencePatternType": 12345,
"onSaturday": true,
"onMonday": true,
"onTuesday": true,
"sysidRecurrenceRule": 12345,
"onSunday": true,
"occurrences": 12345,
"sysidMonthlyDayOccurrenceType": 12345,
"theDate": 12345,
"onThursday": true,
"sysidMonthlyDayType": 12345,
"onFriday": true,
"aqStartDate": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"onWednesday": true,
"exceptions": [
{
"sysidReservation": 12345,
"exceptionType": "RESERVATION",
"relatedSysid": 12345,
"sysidRecurrenceRuleException": 12345,
"reservationDate": 12345
},
{
"sysidReservation": 12345,
"exceptionType": "EXCEPTION",
"relatedSysid": 12345,
"sysidRecurrenceRuleException": 12345,
"reservationDate": 12345
}
],
"interval": 12345
},
"aqEventStartTime": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"eventInfoUrl": "...",
"sysidColorCode": 12345
}Get reservationsevents
Retrieves an existing Reservation Event (or Reservation Group) based on the confirmation number path paramter. Reservation State Type values may be inclued as query parameters to further filter the reservations returned in the reservation event group. The Reservation Event Group includes all of the Resource Reservations for the event as well as additional information about the event itself.
This operation returns a Reservation Group value.
A valid request URL is required to generate request examples{
"aqEventEndTime": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"totalCost": 12345,
"name": "...",
"aqCreateTime": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"sysidConfirmationNumber": 12345,
"comment": "...",
"reservations": [
{
"discriminator": "...",
"chargeCodes": [
{
"percent": 12345,
"sysidReservationChargeCode": 12345,
"chargeCode": "..."
},
{
"percent": 12345,
"sysidReservationChargeCode": 12345,
"chargeCode": "..."
}
],
"qrCode": {
"sysidQRCode": 12345,
"sysidQRCodeType": 12345,
"codeValue": "...",
"sysidReference": 12345
},
"sysidColorCode": 12345,
"accessTokenExpirationTime": 12345,
"sysidUserOwner": 12345,
"emailComments": "...",
"startTime": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"roomConfiguration": {
"thumbnailSource": "...",
"breakDownMinutes": 12345,
"description": "...",
"name": "...",
"imageSource": "...",
"sysidRoomConfiguration": 12345,
"setupMinutes": 12345
},
"sysidResourcePricings": 12345,
"accessToken": "...",
"privateResv": true,
"userOwnerView": {
"privateProfile": true,
"lastName": "...",
"city": "...",
"postalCode": "...",
"middleInitial": "...",
"country": "...",
"roleName": "...",
"address1": "...",
"mobilePhone": "...",
"sysidUser": 12345,
"stateProvince": "...",
"department": "...",
"workPhone": "...",
"sysidStatus": 12345,
"images": [
{},
{}
],
"sysidHomeLocation": 12345,
"sysidLanguage": 12345,
"emailAddress": "...",
"firstName": "...",
"originalUser": true,
"locationName": "...",
"address2": "...",
"accountLocked": true,
"statusMessage": "...",
"title": "..."
},
"stateHistories": [
{
"sysidApplication": 12345,
"userPerformerView": {},
"sysidUserPerformer": 12345,
"aqStateDate": {},
"sysidReservationStateType": 12345,
"sysidReservationActionType": 12345
},
{
"sysidApplication": 12345,
"userPerformerView": {},
"sysidUserPerformer": 12345,
"aqStateDate": {},
"sysidReservationStateType": 12345,
"sysidReservationActionType": 12345
}
],
"name": "...",
"sysidPrevConfirmationNumber": 12345,
"sysidReservation": 12345,
"sysidParentReservation": 12345,
"suppressEmails": true,
"pricings": {
"aqActiveDate": {},
"sysidResource": 12345,
"sysidResourcePricings": 12345,
"pricings": [
{},
{}
]
},
"chargeBackAmount": 12345,
"sysidCategory": 12345,
"endTime": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"resourceType": "ROOM",
"locationNow": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"sysidResource": 12345,
"sysidCreatorApplication": 12345,
"children": [
{},
{}
],
"breakDownTime": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"setupTime": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"sysidRoomConfiguration": 12345,
"sysidConfirmationNumber": 12345,
"uuid": "...",
"comments": "...",
"recurrenceRule": {
"aqEndDate": {},
"sysidRecurrencePatternType": 12345,
"onSaturday": true,
"onMonday": true,
"onTuesday": true,
"sysidRecurrenceRule": 12345,
"onSunday": true,
"occurrences": 12345,
"sysidMonthlyDayOccurrenceType": 12345,
"theDate": 12345,
"onThursday": true,
"sysidMonthlyDayType": 12345,
"onFriday": true,
"aqStartDate": {},
"onWednesday": true,
"exceptions": [
{},
{}
],
"interval": 12345
},
"sysidResourceAccount": 12345
},
{
"discriminator": "...",
"chargeCodes": [
{
"percent": 12345,
"sysidReservationChargeCode": 12345,
"chargeCode": "..."
},
{
"percent": 12345,
"sysidReservationChargeCode": 12345,
"chargeCode": "..."
}
],
"qrCode": {
"sysidQRCode": 12345,
"sysidQRCodeType": 12345,
"codeValue": "...",
"sysidReference": 12345
},
"sysidColorCode": 12345,
"accessTokenExpirationTime": 12345,
"sysidUserOwner": 12345,
"emailComments": "...",
"startTime": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"roomConfiguration": {
"thumbnailSource": "...",
"breakDownMinutes": 12345,
"description": "...",
"name": "...",
"imageSource": "...",
"sysidRoomConfiguration": 12345,
"setupMinutes": 12345
},
"sysidResourcePricings": 12345,
"accessToken": "...",
"privateResv": true,
"userOwnerView": {
"privateProfile": true,
"lastName": "...",
"city": "...",
"postalCode": "...",
"middleInitial": "...",
"country": "...",
"roleName": "...",
"address1": "...",
"mobilePhone": "...",
"sysidUser": 12345,
"stateProvince": "...",
"department": "...",
"workPhone": "...",
"sysidStatus": 12345,
"images": [
{},
{}
],
"sysidHomeLocation": 12345,
"sysidLanguage": 12345,
"emailAddress": "...",
"firstName": "...",
"originalUser": true,
"locationName": "...",
"address2": "...",
"accountLocked": true,
"statusMessage": "...",
"title": "..."
},
"stateHistories": [
{
"sysidApplication": 12345,
"userPerformerView": {},
"sysidUserPerformer": 12345,
"aqStateDate": {},
"sysidReservationStateType": 12345,
"sysidReservationActionType": 12345
},
{
"sysidApplication": 12345,
"userPerformerView": {},
"sysidUserPerformer": 12345,
"aqStateDate": {},
"sysidReservationStateType": 12345,
"sysidReservationActionType": 12345
}
],
"name": "...",
"sysidPrevConfirmationNumber": 12345,
"sysidReservation": 12345,
"sysidParentReservation": 12345,
"suppressEmails": true,
"pricings": {
"aqActiveDate": {},
"sysidResource": 12345,
"sysidResourcePricings": 12345,
"pricings": [
{},
{}
]
},
"chargeBackAmount": 12345,
"sysidCategory": 12345,
"endTime": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"resourceType": "ROOM",
"locationNow": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"sysidResource": 12345,
"sysidCreatorApplication": 12345,
"children": [
{},
{}
],
"breakDownTime": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"setupTime": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"sysidRoomConfiguration": 12345,
"sysidConfirmationNumber": 12345,
"uuid": "...",
"comments": "...",
"recurrenceRule": {
"aqEndDate": {},
"sysidRecurrencePatternType": 12345,
"onSaturday": true,
"onMonday": true,
"onTuesday": true,
"sysidRecurrenceRule": 12345,
"onSunday": true,
"occurrences": 12345,
"sysidMonthlyDayOccurrenceType": 12345,
"theDate": 12345,
"onThursday": true,
"sysidMonthlyDayType": 12345,
"onFriday": true,
"aqStartDate": {},
"onWednesday": true,
"exceptions": [
{},
{}
],
"interval": 12345
},
"sysidResourceAccount": 12345
}
],
"discriminator": "...",
"sysidEventCreator": 12345,
"sysidEventOwner": 12345,
"recurrenceRule": {
"aqEndDate": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"sysidRecurrencePatternType": 12345,
"onSaturday": true,
"onMonday": true,
"onTuesday": true,
"sysidRecurrenceRule": 12345,
"onSunday": true,
"occurrences": 12345,
"sysidMonthlyDayOccurrenceType": 12345,
"theDate": 12345,
"onThursday": true,
"sysidMonthlyDayType": 12345,
"onFriday": true,
"aqStartDate": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"onWednesday": true,
"exceptions": [
{
"sysidReservation": 12345,
"exceptionType": "RESERVATION",
"relatedSysid": 12345,
"sysidRecurrenceRuleException": 12345,
"reservationDate": 12345
},
{
"sysidReservation": 12345,
"exceptionType": "EXCEPTION",
"relatedSysid": 12345,
"sysidRecurrenceRuleException": 12345,
"reservationDate": 12345
}
],
"interval": 12345
},
"aqEventStartTime": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"eventInfoUrl": "...",
"sysidColorCode": 12345
}Path Parameters
long confirmation number
Query Parameters
List of Integer values that correspond to ReservationStateType enumerations to use for search. Can be null.
Response
The requested Reservation Event Group, or a Not Found exception if the Reservation Event could not be found.
com.agilquest.phoenix.shared.data.reservation.ReservationGroup
Show child attributes
Show child attributes
{
"aqEndDate": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"sysidRecurrencePatternType": 12345,
"onSaturday": true,
"onMonday": true,
"onTuesday": true,
"sysidRecurrenceRule": 12345,
"onSunday": true,
"occurrences": 12345,
"sysidMonthlyDayOccurrenceType": 12345,
"theDate": 12345,
"onThursday": true,
"sysidMonthlyDayType": 12345,
"onFriday": true,
"aqStartDate": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"onWednesday": true,
"exceptions": [
{
"sysidReservation": 12345,
"exceptionType": "RESERVATION",
"relatedSysid": 12345,
"sysidRecurrenceRuleException": 12345,
"reservationDate": 12345
},
{
"sysidReservation": 12345,
"exceptionType": "EXCEPTION",
"relatedSysid": 12345,
"sysidRecurrenceRuleException": 12345,
"reservationDate": 12345
}
],
"interval": 12345
}

