A valid request URL is required to generate request examples{
"hasAdditional": true,
"views": [
{
"discriminator": "XHST",
"sysidResourceGroups": [
12345,
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
}
],
"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": "..."
}
],
"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": "XHST",
"sysidResourceGroups": [
12345,
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
}
],
"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": "..."
}
],
"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
}Post availabilityexhaustible resources
The Get Available Exhaustible Resources end point provides a list of available exhaustible 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 Exhaustible View Criteria value. This operation returns a Exhaustible View Wrapper with the following fields: Name Data Type Description views List of Exhaustible View values View of exhaustible 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 Exhaustible View Criteria value. This operation returns a Exhaustible View Wrapper with the following fields: Name Data Type Description views List of Exhaustible View values View of exhaustible 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 Exhaustible View Criteria value.
This operation returns a Exhaustible 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.
A valid request URL is required to generate request examples{
"hasAdditional": true,
"views": [
{
"discriminator": "XHST",
"sysidResourceGroups": [
12345,
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
}
],
"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": "..."
}
],
"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": "XHST",
"sysidResourceGroups": [
12345,
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
}
],
"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": "..."
}
],
"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
}Body
: Available Exhaustible View Criteria to use for retrieving exhaustible resources.
The body is of type any.