Error

A valid request URL is required to generate request examples

{
  "views": [
    {
      "discriminator": "POOL",
      "availableCount": 12345,
      "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": "..."
        }
      ],
      "quantity": 12345,
      "sysidAccount": 12345,
      "sysidAccountResource": 12345,
      "sysidResourceType": 12345,
      "typeDescription": "...",
      "fqn": "...",
      "sysidResource": 12345,
      "sysidCurrencyType": 12345,
      "averageRating": 12345,
      "sysidStatus": 12345,
      "minDurationMinutes": 12345,
      "maxDurationMinutes": 12345,
      "leadTimeMinutes": 12345,
      "images": [
        {
          "thumbnailSource": "...",
          "height": 12345,
          "imageSource": "...",
          "sysidResourceImage": 12345,
          "width": 12345,
          "defaultImage": true,
          "name": "...",
          "displayOrder": 12345,
          "description": "..."
        },
        {
          "thumbnailSource": "...",
          "height": 12345,
          "imageSource": "...",
          "sysidResourceImage": 12345,
          "width": 12345,
          "defaultImage": true,
          "name": "...",
          "displayOrder": 12345,
          "description": "..."
        }
      ],
      "sysidCategory": 12345,
      "name": "...",
      "chargeCodeType": 12345,
      "allocRelationship": 12345,
      "sysidCostUnitType": 12345,
      "price": 12345,
      "breakDownMinutes": 12345,
      "serialversionuid": 12345,
      "setupMinutes": 12345,
      "minChargeCodeRequired": 12345,
      "maxFutureReservationDays": 12345
    },
    {
      "discriminator": "POOL",
      "availableCount": 12345,
      "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": "..."
        }
      ],
      "quantity": 12345,
      "sysidAccount": 12345,
      "sysidAccountResource": 12345,
      "sysidResourceType": 12345,
      "typeDescription": "...",
      "fqn": "...",
      "sysidResource": 12345,
      "sysidCurrencyType": 12345,
      "averageRating": 12345,
      "sysidStatus": 12345,
      "minDurationMinutes": 12345,
      "maxDurationMinutes": 12345,
      "leadTimeMinutes": 12345,
      "images": [
        {
          "thumbnailSource": "...",
          "height": 12345,
          "imageSource": "...",
          "sysidResourceImage": 12345,
          "width": 12345,
          "defaultImage": true,
          "name": "...",
          "displayOrder": 12345,
          "description": "..."
        },
        {
          "thumbnailSource": "...",
          "height": 12345,
          "imageSource": "...",
          "sysidResourceImage": 12345,
          "width": 12345,
          "defaultImage": true,
          "name": "...",
          "displayOrder": 12345,
          "description": "..."
        }
      ],
      "sysidCategory": 12345,
      "name": "...",
      "chargeCodeType": 12345,
      "allocRelationship": 12345,
      "sysidCostUnitType": 12345,
      "price": 12345,
      "breakDownMinutes": 12345,
      "serialversionuid": 12345,
      "setupMinutes": 12345,
      "minChargeCodeRequired": 12345,
      "maxFutureReservationDays": 12345
    }
  ],
  "nextStartRow": 12345,
  "hasAdditional": true
}

AvailabilityService

Post availabilitypooled resources

The Get Available Pooled Resources end point provides a list of available pooled resources for a length of time as described by the passed in Criteria value. Alternatively, it can provide the status of a current resource for the given time period if the resource is identified in the Criteria parameter. This operation requires a Available Pooled View Criteria value. This operation returns a Pooled View Wrapper with the following fields: Name Data Type Description views List of Pooled View values View of pooled resources matching the search criteria. hasAdditional Boolean value Indicates in paginated calls if there are additional views which can be requested. nextStartRow Integer value Index of next row at which to start request for additional values. unavailabilityCode Integer value Sub code of type Availability Exception which gives the reason for an empty availability list being returned. Note: If no availabilities are returned, the returned object may include an unavailability code value indicating the reason for the empty list. This code matches the sub error codes defined for the Availability Exception type.

This operation requires a Available Pooled View Criteria value. This operation returns a Pooled View Wrapper with the following fields: Name Data Type Description views List of Pooled View values View of pooled resources matching the search criteria. hasAdditional Boolean value Indicates in paginated calls if there are additional views which can be requested. nextStartRow Integer value Index of next row at which to start request for additional values. unavailabilityCode Integer value Sub code of type Availability Exception which gives the reason for an empty availability list being returned. Note: If no availabilities are returned, the returned object may include an unavailability code value indicating the reason for the empty list. This code matches the sub error codes defined for the Availability Exception type.

This operation requires a Available Pooled View Criteria value.

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

Note: If no availabilities are returned, the returned object may include an unavailability code value indicating the reason for the empty list. This code matches the sub error codes defined for the Availability Exception type.

POST

availability

pooled-resources

Error

A valid request URL is required to generate request examples

{
  "views": [
    {
      "discriminator": "POOL",
      "availableCount": 12345,
      "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": "..."
        }
      ],
      "quantity": 12345,
      "sysidAccount": 12345,
      "sysidAccountResource": 12345,
      "sysidResourceType": 12345,
      "typeDescription": "...",
      "fqn": "...",
      "sysidResource": 12345,
      "sysidCurrencyType": 12345,
      "averageRating": 12345,
      "sysidStatus": 12345,
      "minDurationMinutes": 12345,
      "maxDurationMinutes": 12345,
      "leadTimeMinutes": 12345,
      "images": [
        {
          "thumbnailSource": "...",
          "height": 12345,
          "imageSource": "...",
          "sysidResourceImage": 12345,
          "width": 12345,
          "defaultImage": true,
          "name": "...",
          "displayOrder": 12345,
          "description": "..."
        },
        {
          "thumbnailSource": "...",
          "height": 12345,
          "imageSource": "...",
          "sysidResourceImage": 12345,
          "width": 12345,
          "defaultImage": true,
          "name": "...",
          "displayOrder": 12345,
          "description": "..."
        }
      ],
      "sysidCategory": 12345,
      "name": "...",
      "chargeCodeType": 12345,
      "allocRelationship": 12345,
      "sysidCostUnitType": 12345,
      "price": 12345,
      "breakDownMinutes": 12345,
      "serialversionuid": 12345,
      "setupMinutes": 12345,
      "minChargeCodeRequired": 12345,
      "maxFutureReservationDays": 12345
    },
    {
      "discriminator": "POOL",
      "availableCount": 12345,
      "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": "..."
        }
      ],
      "quantity": 12345,
      "sysidAccount": 12345,
      "sysidAccountResource": 12345,
      "sysidResourceType": 12345,
      "typeDescription": "...",
      "fqn": "...",
      "sysidResource": 12345,
      "sysidCurrencyType": 12345,
      "averageRating": 12345,
      "sysidStatus": 12345,
      "minDurationMinutes": 12345,
      "maxDurationMinutes": 12345,
      "leadTimeMinutes": 12345,
      "images": [
        {
          "thumbnailSource": "...",
          "height": 12345,
          "imageSource": "...",
          "sysidResourceImage": 12345,
          "width": 12345,
          "defaultImage": true,
          "name": "...",
          "displayOrder": 12345,
          "description": "..."
        },
        {
          "thumbnailSource": "...",
          "height": 12345,
          "imageSource": "...",
          "sysidResourceImage": 12345,
          "width": 12345,
          "defaultImage": true,
          "name": "...",
          "displayOrder": 12345,
          "description": "..."
        }
      ],
      "sysidCategory": 12345,
      "name": "...",
      "chargeCodeType": 12345,
      "allocRelationship": 12345,
      "sysidCostUnitType": 12345,
      "price": 12345,
      "breakDownMinutes": 12345,
      "serialversionuid": 12345,
      "setupMinutes": 12345,
      "minChargeCodeRequired": 12345,
      "maxFutureReservationDays": 12345
    }
  ],
  "nextStartRow": 12345,
  "hasAdditional": true
}

Body

application/json

: Available Pooled View Criteria to use for retrieving pooled resources.

The body is of type any.

Response

201 - application/json

Array of Pooled View results matching the given criteria. com.agilquest.phoenix.shared.data.rest.wrapper.PooledViewWrapper

nextStartRow

integer<int32>

required

hasAdditional

boolean

required

views

any[]

Reserve REST API

Reserve Authentication API

Reserve Criteria

Reserve Constants

Post availabilitypooled resources

Body

Response