Error

A valid request URL is required to generate request examples

{
  "hasAdditional": true,
  "views": [
    {
      "typeDescription": "...",
      "name": "...",
      "sysidResourceType": 12345,
      "minChargeCodeRequired": 12345,
      "sysidStatus": 12345,
      "price": 12345,
      "maxFutureReservationDays": 12345,
      "sysidCategory": 12345,
      "chargeCodeType": 12345,
      "mapImageLocators": [
        {
          "left": 12345,
          "height": 12345,
          "top": 12345,
          "sysidMapLocator": 12345,
          "transparency": 12345,
          "locatorImage": {},
          "sysidMapImage": 12345,
          "rotation": 12345,
          "width": 12345,
          "sysidLocatorImage": 12345
        },
        {
          "left": 12345,
          "height": 12345,
          "top": 12345,
          "sysidMapLocator": 12345,
          "transparency": 12345,
          "locatorImage": {},
          "sysidMapImage": 12345,
          "rotation": 12345,
          "width": 12345,
          "sysidLocatorImage": 12345
        }
      ],
      "sysidCurrencyType": 12345,
      "leadTimeMinutes": 12345,
      "originalResource": true,
      "minDurationMinutes": 12345,
      "discriminator": "...",
      "breakDownMinutes": 12345,
      "setupMinutes": 12345,
      "allocRelationship": 12345,
      "sysidCostUnitType": 12345,
      "sysidResource": 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": "..."
        }
      ],
      "maxDurationMinutes": 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": "..."
        }
      ]
    },
    {
      "typeDescription": "...",
      "name": "...",
      "sysidResourceType": 12345,
      "minChargeCodeRequired": 12345,
      "sysidStatus": 12345,
      "price": 12345,
      "maxFutureReservationDays": 12345,
      "sysidCategory": 12345,
      "chargeCodeType": 12345,
      "mapImageLocators": [
        {
          "left": 12345,
          "height": 12345,
          "top": 12345,
          "sysidMapLocator": 12345,
          "transparency": 12345,
          "locatorImage": {},
          "sysidMapImage": 12345,
          "rotation": 12345,
          "width": 12345,
          "sysidLocatorImage": 12345
        },
        {
          "left": 12345,
          "height": 12345,
          "top": 12345,
          "sysidMapLocator": 12345,
          "transparency": 12345,
          "locatorImage": {},
          "sysidMapImage": 12345,
          "rotation": 12345,
          "width": 12345,
          "sysidLocatorImage": 12345
        }
      ],
      "sysidCurrencyType": 12345,
      "leadTimeMinutes": 12345,
      "originalResource": true,
      "minDurationMinutes": 12345,
      "discriminator": "...",
      "breakDownMinutes": 12345,
      "setupMinutes": 12345,
      "allocRelationship": 12345,
      "sysidCostUnitType": 12345,
      "sysidResource": 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": "..."
        }
      ],
      "maxDurationMinutes": 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": "..."
        }
      ]
    }
  ],
  "nextStartRow": 12345
}

ResourceViewsService

Post resourcesviewsall resource views

Searches all Resources within the requesting User’s associated Forum using the provided search criteria.

This operation requires a Resource View Criteria value.

This operation returns a Resource View Wrapper with the following fields: Name Data Type Description views List of Resource View values Room Views describe a Room resource. These views will be in the order requested by the submitted criteria search value. hasAdditional Boolean value Flag indicating that additional results may be queried from the agilquest system. Additional calls to the operation that update the criteria Start Row to the next start row value included in this result will retrieve the additional results for this query. nextStartRow Integer value Numeric Index of the next result set row to use for retrieving additional results for the same query. Used for pagination.

POST

resources

views

all-resource-views

Error

A valid request URL is required to generate request examples

{
  "hasAdditional": true,
  "views": [
    {
      "typeDescription": "...",
      "name": "...",
      "sysidResourceType": 12345,
      "minChargeCodeRequired": 12345,
      "sysidStatus": 12345,
      "price": 12345,
      "maxFutureReservationDays": 12345,
      "sysidCategory": 12345,
      "chargeCodeType": 12345,
      "mapImageLocators": [
        {
          "left": 12345,
          "height": 12345,
          "top": 12345,
          "sysidMapLocator": 12345,
          "transparency": 12345,
          "locatorImage": {},
          "sysidMapImage": 12345,
          "rotation": 12345,
          "width": 12345,
          "sysidLocatorImage": 12345
        },
        {
          "left": 12345,
          "height": 12345,
          "top": 12345,
          "sysidMapLocator": 12345,
          "transparency": 12345,
          "locatorImage": {},
          "sysidMapImage": 12345,
          "rotation": 12345,
          "width": 12345,
          "sysidLocatorImage": 12345
        }
      ],
      "sysidCurrencyType": 12345,
      "leadTimeMinutes": 12345,
      "originalResource": true,
      "minDurationMinutes": 12345,
      "discriminator": "...",
      "breakDownMinutes": 12345,
      "setupMinutes": 12345,
      "allocRelationship": 12345,
      "sysidCostUnitType": 12345,
      "sysidResource": 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": "..."
        }
      ],
      "maxDurationMinutes": 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": "..."
        }
      ]
    },
    {
      "typeDescription": "...",
      "name": "...",
      "sysidResourceType": 12345,
      "minChargeCodeRequired": 12345,
      "sysidStatus": 12345,
      "price": 12345,
      "maxFutureReservationDays": 12345,
      "sysidCategory": 12345,
      "chargeCodeType": 12345,
      "mapImageLocators": [
        {
          "left": 12345,
          "height": 12345,
          "top": 12345,
          "sysidMapLocator": 12345,
          "transparency": 12345,
          "locatorImage": {},
          "sysidMapImage": 12345,
          "rotation": 12345,
          "width": 12345,
          "sysidLocatorImage": 12345
        },
        {
          "left": 12345,
          "height": 12345,
          "top": 12345,
          "sysidMapLocator": 12345,
          "transparency": 12345,
          "locatorImage": {},
          "sysidMapImage": 12345,
          "rotation": 12345,
          "width": 12345,
          "sysidLocatorImage": 12345
        }
      ],
      "sysidCurrencyType": 12345,
      "leadTimeMinutes": 12345,
      "originalResource": true,
      "minDurationMinutes": 12345,
      "discriminator": "...",
      "breakDownMinutes": 12345,
      "setupMinutes": 12345,
      "allocRelationship": 12345,
      "sysidCostUnitType": 12345,
      "sysidResource": 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": "..."
        }
      ],
      "maxDurationMinutes": 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": "..."
        }
      ]
    }
  ],
  "nextStartRow": 12345
}

Body

application/json

startRow

integer<int32>

required

maxRows

integer<int32>

required

exactMatchOnName

boolean

required

sortAscending

boolean

required

distanceUnit

enum<string>

Available options:

miles,

kilometers

sysidResources

integer[]

sysidLocationMapImages

integer[]

latitude

number

oredSysidResources

integer[]

resourceName

string

sortColumn

enum<string>

Available options:

RESOURCE_NAME,

CATEGORY,

RESOURCE_TYPE,

STATUS,

PRICE

sysidStatuses

integer[]

venueName

string

priceRange

PriceRangeData · object

Show child attributes

Example:

{
  "fromPrice": 12345,
  "sysidCostUnitType": 12345,
  "sysidCurrencyType": 12345,
  "toPrice": 12345
}

sysidAccount

integer<int32>

sysidLocatorNodes

integer[]

distance

integer<int32>

longitude

number

sysidDepartments

integer[]

sysidUserAlloc

integer<int32>

sysidAllocRelationships

integer[]

viewport

Viewport · object

Show child attributes

Example:

{
  "southwest": { "lat": 12345, "lng": 12345 },
  "northeast": { "lat": 12345, "lng": 12345 }
}

sysidCategories

integer[]

sysidResourceTypes

integer[]

Response

201 - application/json

ResourceViewWrapper

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

hasAdditional

boolean

required

nextStartRow

integer<int32>

required

views

ResourceView · object[]

Show child attributes

Reserve REST API

Reserve Authentication API

Reserve Criteria

Reserve Constants

Post resourcesviewsall resource views

Body

Response