Error

A valid request URL is required to generate request examples

{
  "nextStartRow": 12345,
  "views": [
    {
      "discriminator": "...",
      "resourceTypeName": "...",
      "resourceLocations": [
        {
          "postalCode": "...",
          "sysidVenueNode": 12345,
          "sysidLocatorNode": 12345,
          "address2": "...",
          "country": "...",
          "address1": "...",
          "city": "...",
          "venueName": "...",
          "stateProvince": "...",
          "locationName": "..."
        },
        {
          "postalCode": "...",
          "sysidVenueNode": 12345,
          "sysidLocatorNode": 12345,
          "address2": "...",
          "country": "...",
          "address1": "...",
          "city": "...",
          "venueName": "...",
          "stateProvince": "...",
          "locationName": "..."
        }
      ],
      "privateReservation": true,
      "sysidResourceAccount": 12345,
      "resourceImage": "...",
      "sysidOrgDurationType": 12345,
      "activeEndTime": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "sysidParentReservation": 12345,
      "sysidAccountResource": 12345,
      "leadTimeMinutes": 12345,
      "creatorLastName": "...",
      "creatorPrivateProfile": true,
      "reservationComments": "...",
      "sysidColorCode": 12345,
      "sysidDurationType": 12345,
      "children": [
        {
          "sysidResource": 12345,
          "sysidCategory": 12345,
          "resourceCategoryName": "...",
          "quantity": 12345,
          "sysidPurposeType": 12345,
          "sysidStateType": 12345,
          "resourceName": "...",
          "sysidReservation": 12345
        },
        {
          "sysidResource": 12345,
          "sysidCategory": 12345,
          "resourceCategoryName": "...",
          "quantity": 12345,
          "sysidPurposeType": 12345,
          "sysidStateType": 12345,
          "resourceName": "...",
          "sysidReservation": 12345
        }
      ],
      "sysidCreator": 12345,
      "endTime": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "ownerFirstName": "...",
      "ownerMiddleInitial": "...",
      "creatorFirstName": "...",
      "resourceCategoryName": "...",
      "setupTime": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "sysidDependentReservation": 12345,
      "createdTime": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "ownerLastName": "...",
      "sysidOwner": 12345,
      "privateProfile": true,
      "reservationName": "...",
      "resourceName": "...",
      "setupMinutes": 12345,
      "reservationEmailComments": "...",
      "activeStartTime": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "sysidResource": 12345,
      "sysidReservation": 12345,
      "ownerThumbnailSource": "...",
      "resourceThumbnail": "...",
      "sysidPurposeType": 12345,
      "confirmationNumber": 12345,
      "sysidEventType": 12345,
      "breakDownMinutes": 12345,
      "sysidResourceType": 12345,
      "sysidCategory": 12345,
      "startTime": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "reservationResourceType": "EXHAUSTIBLE",
      "sysidReservationState": 12345,
      "breakDownTime": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "ownerPhone": "..."
    },
    {
      "discriminator": "...",
      "resourceTypeName": "...",
      "resourceLocations": [
        {
          "postalCode": "...",
          "sysidVenueNode": 12345,
          "sysidLocatorNode": 12345,
          "address2": "...",
          "country": "...",
          "address1": "...",
          "city": "...",
          "venueName": "...",
          "stateProvince": "...",
          "locationName": "..."
        },
        {
          "postalCode": "...",
          "sysidVenueNode": 12345,
          "sysidLocatorNode": 12345,
          "address2": "...",
          "country": "...",
          "address1": "...",
          "city": "...",
          "venueName": "...",
          "stateProvince": "...",
          "locationName": "..."
        }
      ],
      "privateReservation": true,
      "sysidResourceAccount": 12345,
      "resourceImage": "...",
      "sysidOrgDurationType": 12345,
      "activeEndTime": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "sysidParentReservation": 12345,
      "sysidAccountResource": 12345,
      "leadTimeMinutes": 12345,
      "creatorLastName": "...",
      "creatorPrivateProfile": true,
      "reservationComments": "...",
      "sysidColorCode": 12345,
      "sysidDurationType": 12345,
      "children": [
        {
          "sysidResource": 12345,
          "sysidCategory": 12345,
          "resourceCategoryName": "...",
          "quantity": 12345,
          "sysidPurposeType": 12345,
          "sysidStateType": 12345,
          "resourceName": "...",
          "sysidReservation": 12345
        },
        {
          "sysidResource": 12345,
          "sysidCategory": 12345,
          "resourceCategoryName": "...",
          "quantity": 12345,
          "sysidPurposeType": 12345,
          "sysidStateType": 12345,
          "resourceName": "...",
          "sysidReservation": 12345
        }
      ],
      "sysidCreator": 12345,
      "endTime": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "ownerFirstName": "...",
      "ownerMiddleInitial": "...",
      "creatorFirstName": "...",
      "resourceCategoryName": "...",
      "setupTime": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "sysidDependentReservation": 12345,
      "createdTime": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "ownerLastName": "...",
      "sysidOwner": 12345,
      "privateProfile": true,
      "reservationName": "...",
      "resourceName": "...",
      "setupMinutes": 12345,
      "reservationEmailComments": "...",
      "activeStartTime": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "sysidResource": 12345,
      "sysidReservation": 12345,
      "ownerThumbnailSource": "...",
      "resourceThumbnail": "...",
      "sysidPurposeType": 12345,
      "confirmationNumber": 12345,
      "sysidEventType": 12345,
      "breakDownMinutes": 12345,
      "sysidResourceType": 12345,
      "sysidCategory": 12345,
      "startTime": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "reservationResourceType": "ROOM",
      "sysidReservationState": 12345,
      "breakDownTime": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "ownerPhone": "..."
    }
  ],
  "count": 12345,
  "hasAdditional": true
}

ReservationViewsService

Post reservationsviewsby names

Searches for existing Reservations in the agilquest System. Reservations may be searched for based on a number of criteria, defined in the Reservation View Name Criteria value. The returned Reservation View results will have the total count of the matching Reservation Views with an array of Reservation View values that fulfills the start and max row criteria of the POSTed criteria argument.

This operation requires a Reservation View Name Criteria value.

This operation returns a Reservation View Wrapper with the following fields:

POST

reservations

views

by-names

Error

A valid request URL is required to generate request examples

{
  "nextStartRow": 12345,
  "views": [
    {
      "discriminator": "...",
      "resourceTypeName": "...",
      "resourceLocations": [
        {
          "postalCode": "...",
          "sysidVenueNode": 12345,
          "sysidLocatorNode": 12345,
          "address2": "...",
          "country": "...",
          "address1": "...",
          "city": "...",
          "venueName": "...",
          "stateProvince": "...",
          "locationName": "..."
        },
        {
          "postalCode": "...",
          "sysidVenueNode": 12345,
          "sysidLocatorNode": 12345,
          "address2": "...",
          "country": "...",
          "address1": "...",
          "city": "...",
          "venueName": "...",
          "stateProvince": "...",
          "locationName": "..."
        }
      ],
      "privateReservation": true,
      "sysidResourceAccount": 12345,
      "resourceImage": "...",
      "sysidOrgDurationType": 12345,
      "activeEndTime": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "sysidParentReservation": 12345,
      "sysidAccountResource": 12345,
      "leadTimeMinutes": 12345,
      "creatorLastName": "...",
      "creatorPrivateProfile": true,
      "reservationComments": "...",
      "sysidColorCode": 12345,
      "sysidDurationType": 12345,
      "children": [
        {
          "sysidResource": 12345,
          "sysidCategory": 12345,
          "resourceCategoryName": "...",
          "quantity": 12345,
          "sysidPurposeType": 12345,
          "sysidStateType": 12345,
          "resourceName": "...",
          "sysidReservation": 12345
        },
        {
          "sysidResource": 12345,
          "sysidCategory": 12345,
          "resourceCategoryName": "...",
          "quantity": 12345,
          "sysidPurposeType": 12345,
          "sysidStateType": 12345,
          "resourceName": "...",
          "sysidReservation": 12345
        }
      ],
      "sysidCreator": 12345,
      "endTime": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "ownerFirstName": "...",
      "ownerMiddleInitial": "...",
      "creatorFirstName": "...",
      "resourceCategoryName": "...",
      "setupTime": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "sysidDependentReservation": 12345,
      "createdTime": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "ownerLastName": "...",
      "sysidOwner": 12345,
      "privateProfile": true,
      "reservationName": "...",
      "resourceName": "...",
      "setupMinutes": 12345,
      "reservationEmailComments": "...",
      "activeStartTime": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "sysidResource": 12345,
      "sysidReservation": 12345,
      "ownerThumbnailSource": "...",
      "resourceThumbnail": "...",
      "sysidPurposeType": 12345,
      "confirmationNumber": 12345,
      "sysidEventType": 12345,
      "breakDownMinutes": 12345,
      "sysidResourceType": 12345,
      "sysidCategory": 12345,
      "startTime": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "reservationResourceType": "EXHAUSTIBLE",
      "sysidReservationState": 12345,
      "breakDownTime": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "ownerPhone": "..."
    },
    {
      "discriminator": "...",
      "resourceTypeName": "...",
      "resourceLocations": [
        {
          "postalCode": "...",
          "sysidVenueNode": 12345,
          "sysidLocatorNode": 12345,
          "address2": "...",
          "country": "...",
          "address1": "...",
          "city": "...",
          "venueName": "...",
          "stateProvince": "...",
          "locationName": "..."
        },
        {
          "postalCode": "...",
          "sysidVenueNode": 12345,
          "sysidLocatorNode": 12345,
          "address2": "...",
          "country": "...",
          "address1": "...",
          "city": "...",
          "venueName": "...",
          "stateProvince": "...",
          "locationName": "..."
        }
      ],
      "privateReservation": true,
      "sysidResourceAccount": 12345,
      "resourceImage": "...",
      "sysidOrgDurationType": 12345,
      "activeEndTime": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "sysidParentReservation": 12345,
      "sysidAccountResource": 12345,
      "leadTimeMinutes": 12345,
      "creatorLastName": "...",
      "creatorPrivateProfile": true,
      "reservationComments": "...",
      "sysidColorCode": 12345,
      "sysidDurationType": 12345,
      "children": [
        {
          "sysidResource": 12345,
          "sysidCategory": 12345,
          "resourceCategoryName": "...",
          "quantity": 12345,
          "sysidPurposeType": 12345,
          "sysidStateType": 12345,
          "resourceName": "...",
          "sysidReservation": 12345
        },
        {
          "sysidResource": 12345,
          "sysidCategory": 12345,
          "resourceCategoryName": "...",
          "quantity": 12345,
          "sysidPurposeType": 12345,
          "sysidStateType": 12345,
          "resourceName": "...",
          "sysidReservation": 12345
        }
      ],
      "sysidCreator": 12345,
      "endTime": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "ownerFirstName": "...",
      "ownerMiddleInitial": "...",
      "creatorFirstName": "...",
      "resourceCategoryName": "...",
      "setupTime": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "sysidDependentReservation": 12345,
      "createdTime": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "ownerLastName": "...",
      "sysidOwner": 12345,
      "privateProfile": true,
      "reservationName": "...",
      "resourceName": "...",
      "setupMinutes": 12345,
      "reservationEmailComments": "...",
      "activeStartTime": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "sysidResource": 12345,
      "sysidReservation": 12345,
      "ownerThumbnailSource": "...",
      "resourceThumbnail": "...",
      "sysidPurposeType": 12345,
      "confirmationNumber": 12345,
      "sysidEventType": 12345,
      "breakDownMinutes": 12345,
      "sysidResourceType": 12345,
      "sysidCategory": 12345,
      "startTime": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "reservationResourceType": "ROOM",
      "sysidReservationState": 12345,
      "breakDownTime": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "ownerPhone": "..."
    }
  ],
  "count": 12345,
  "hasAdditional": true
}

Body

application/json

ReservationViewNameCriteria

startRow

integer<int32>

required

maxRows

integer<int32>

required

onlyParents

boolean

required

sortAscending

boolean

required

onlyPublic

boolean

required

dates

DateRangeData · object[]

Show child attributes

resourceName

string

sortColumn

enum<string>

Available options:

CONFIRMATION_NUMBER,

END_TIME,

RESERVATION_NAME,

RESERVATION_STATE,

RESOURCE_NAME,

START_TIME,

USER_NAME,

CREATED_TIME

searchString

string

reservationStates

integer[]

Response

201 - application/json

ReservationViewWrapper containing Reservation Views.

com.agilquest.phoenix.shared.data.rest.wrapper.ReservationViewWrapper

nextStartRow

integer<int32>

required

count

integer<int32>

required

hasAdditional

boolean

required

views

any[]

Reserve REST API

Reserve Authentication API

Reserve Criteria

Reserve Constants

Post reservationsviewsby names

Body

Response