This end-point will fetch overall availability for a list of constraints.

ApiScope: manage.calendar.read
API Scope Level: ServiceSubscriberScope

application/json

Request Body required

constraintFilters object
resources object
property name* string[]
Array [
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

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string
overallAvailabilityMap object
property name* object[]
Array [
startDateTime string
endDateTime string
isAvailable boolean
availabilityDetails object[]
Array [
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

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string
overallAvailabilityMap object
property name* object[]
Array [
startDateTime string
endDateTime string
isAvailable boolean
availabilityDetails object[]
Array [
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

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
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

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
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

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
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

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

POST /v2/calendar/overall-availability

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL

/manage

Username

Password

Body required

{
  "constraintFilters": {
    "resources": {},
    "purposeName": "string",
    "platform": "DEALER_APP",
    "startDateTime": "string",
    "endDateTime": "string"
  },
  "applicableConstraints": [
    "HOURS_OF_OPERATION"
  ]
}

Accept

application/jsonapplication/x-protobuf

curl / cURL

curl -L -X POST '/manage/v2/calendar/overall-availability' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "constraintFilters": {
    "resources": {},
    "purposeName": "string",
    "platform": "DEALER_APP",
    "startDateTime": "string",
    "endDateTime": "string"
  },
  "applicableConstraints": [
    "HOURS_OF_OPERATION"
  ]
}'

python / requests

curl -L -X POST '/manage/v2/calendar/overall-availability' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "constraintFilters": {
    "resources": {},
    "purposeName": "string",
    "platform": "DEALER_APP",
    "startDateTime": "string",
    "endDateTime": "string"
  },
  "applicableConstraints": [
    "HOURS_OF_OPERATION"
  ]
}'

go / native

curl -L -X POST '/manage/v2/calendar/overall-availability' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "constraintFilters": {
    "resources": {},
    "purposeName": "string",
    "platform": "DEALER_APP",
    "startDateTime": "string",
    "endDateTime": "string"
  },
  "applicableConstraints": [
    "HOURS_OF_OPERATION"
  ]
}'

nodejs / axios

curl -L -X POST '/manage/v2/calendar/overall-availability' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "constraintFilters": {
    "resources": {},
    "purposeName": "string",
    "platform": "DEALER_APP",
    "startDateTime": "string",
    "endDateTime": "string"
  },
  "applicableConstraints": [
    "HOURS_OF_OPERATION"
  ]
}'

ruby / Net::HTTP

curl -L -X POST '/manage/v2/calendar/overall-availability' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "constraintFilters": {
    "resources": {},
    "purposeName": "string",
    "platform": "DEALER_APP",
    "startDateTime": "string",
    "endDateTime": "string"
  },
  "applicableConstraints": [
    "HOURS_OF_OPERATION"
  ]
}'

csharp / RestSharp

curl -L -X POST '/manage/v2/calendar/overall-availability' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "constraintFilters": {
    "resources": {},
    "purposeName": "string",
    "platform": "DEALER_APP",
    "startDateTime": "string",
    "endDateTime": "string"
  },
  "applicableConstraints": [
    "HOURS_OF_OPERATION"
  ]
}'

php / cURL

curl -L -X POST '/manage/v2/calendar/overall-availability' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "constraintFilters": {
    "resources": {},
    "purposeName": "string",
    "platform": "DEALER_APP",
    "startDateTime": "string",
    "endDateTime": "string"
  },
  "applicableConstraints": [
    "HOURS_OF_OPERATION"
  ]
}'

java / OkHttp

curl -L -X POST '/manage/v2/calendar/overall-availability' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "constraintFilters": {
    "resources": {},
    "purposeName": "string",
    "platform": "DEALER_APP",
    "startDateTime": "string",
    "endDateTime": "string"
  },
  "applicableConstraints": [
    "HOURS_OF_OPERATION"
  ]
}'

powershell / RestMethod

curl -L -X POST '/manage/v2/calendar/overall-availability' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "constraintFilters": {
    "resources": {},
    "purposeName": "string",
    "platform": "DEALER_APP",
    "startDateTime": "string",
    "endDateTime": "string"
  },
  "applicableConstraints": [
    "HOURS_OF_OPERATION"
  ]
}'