This end-point will fetch overall availability for a list of constraints.
This end-point will fetch overall availability for a list of constraints.
application/json
Request Body required
- Array [
- ]
constraintFilters object
resources object
property name* string[]
string
purposeName string
platform string
Possible values: [DEALER_APP
, WEB
, MOBILE_APP
, DMS
, TRANSPORTATION_EVENTS_CONSUMER
]
startDateTime string
endDateTime string
applicableConstraints string[]
Possible values: [HOURS_OF_OPERATION
, AVAILABILITY
, MAX_COUNT
]
Responses
- 200
- 400
- 401
- 403
- 500
OK
application/json
application/x-protobuf
Schema
Example (from schema)
Schema
- Array [
- ]
- Array [
- ]
- Array [
- Array [
- ]
- ]
errors object[]
errorCode int32
errorTitle string
errorMessage string
warnings object[]
warningCode int32
warningTitle string
warningMessage string
apiRequestId string
overallAvailabilityMap object
property name* object[]
startDateTime string
endDateTime string
isAvailable boolean
availabilityDetails object[]
reason string
Possible values: [OUTSIDE_HOURS_OF_OPERATION
, WITHIN_HOURS_OF_OPERATION
, MAX_COUNT_EXCEEDED
, MARKED_UNAVAILABLE
, MARKED_AVAILABLE
, EXISTING_RESERVATION
]
constraintUuid string
{
"errors": [
{
"errorCode": 0,
"errorTitle": "string",
"errorMessage": "string"
}
],
"warnings": [
{
"warningCode": 0,
"warningTitle": "string",
"warningMessage": "string"
}
],
"apiRequestId": "string",
"overallAvailabilityMap": {}
}
Schema
Example (from schema)
Schema
- Array [
- ]
- Array [
- ]
- Array [
- Array [
- ]
- ]
errors object[]
errorCode int32
errorTitle string
errorMessage string
warnings object[]
warningCode int32
warningTitle string
warningMessage string
apiRequestId string
overallAvailabilityMap object
property name* object[]
startDateTime string
endDateTime string
isAvailable boolean
availabilityDetails object[]
reason string
Possible values: [OUTSIDE_HOURS_OF_OPERATION
, WITHIN_HOURS_OF_OPERATION
, MAX_COUNT_EXCEEDED
, MARKED_UNAVAILABLE
, MARKED_AVAILABLE
, EXISTING_RESERVATION
]
constraintUuid string
{
"errors": [
{
"errorCode": 0,
"errorTitle": "string",
"errorMessage": "string"
}
],
"warnings": [
{
"warningCode": 0,
"warningTitle": "string",
"warningMessage": "string"
}
],
"apiRequestId": "string",
"overallAvailabilityMap": {}
}
Bad Request
application/json
Schema
Example (from schema)
Schema
- Array [
- ]
- Array [
- ]
errors object[]
errorCode int32
errorTitle string
errorMessage string
warnings object[]
warningCode int32
warningTitle string
warningMessage string
apiRequestId string
{
"errors": [
{
"errorCode": 0,
"errorTitle": "string",
"errorMessage": "string"
}
],
"warnings": [
{
"warningCode": 0,
"warningTitle": "string",
"warningMessage": "string"
}
],
"apiRequestId": "string"
}
Unauthorized
application/json
Schema
Example (from schema)
Schema
- Array [
- ]
- Array [
- ]
errors object[]
errorCode int32
errorTitle string
errorMessage string
warnings object[]
warningCode int32
warningTitle string
warningMessage string
apiRequestId string
{
"errors": [
{
"errorCode": 0,
"errorTitle": "string",
"errorMessage": "string"
}
],
"warnings": [
{
"warningCode": 0,
"warningTitle": "string",
"warningMessage": "string"
}
],
"apiRequestId": "string"
}
Forbidden
application/json
Schema
Example (from schema)
Schema
- Array [
- ]
- Array [
- ]
errors object[]
errorCode int32
errorTitle string
errorMessage string
warnings object[]
warningCode int32
warningTitle string
warningMessage string
apiRequestId string
{
"errors": [
{
"errorCode": 0,
"errorTitle": "string",
"errorMessage": "string"
}
],
"warnings": [
{
"warningCode": 0,
"warningTitle": "string",
"warningMessage": "string"
}
],
"apiRequestId": "string"
}
Internal Server Error
application/json
Schema
Example (from schema)
Schema
- Array [
- ]
- Array [
- ]
errors object[]
errorCode int32
errorTitle string
errorMessage string
warnings object[]
warningCode int32
warningTitle string
warningMessage string
apiRequestId string
{
"errors": [
{
"errorCode": 0,
"errorTitle": "string",
"errorMessage": "string"
}
],
"warnings": [
{
"warningCode": 0,
"warningTitle": "string",
"warningMessage": "string"
}
],
"apiRequestId": "string"
}
Loading...