This end-point fetches effective availability for list of resources.

Fetches effective availabilities on the basis of various filters.
ApiScope: manage.calendar.read
API Scope Level: ServiceSubscriberScope

application/json

Request Body required

resources object
property name* string[]
Array [
string
]
startDateTime string
endDateTime string
purposeName string
platform string

Possible values: [DEALER_APP, WEB, MOBILE_APP, DMS, TRANSPORTATION_EVENTS_CONSUMER]

timezone string
isAvailable boolean

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
availabilityMap object
property name* object[]
Array [
constraintUuid string
startDateTime string
endDateTime string
isAvailable boolean
]

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

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
availabilityMap object
property name* object[]
Array [
constraintUuid string
startDateTime string
endDateTime string
isAvailable boolean
]

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

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/availability/effective

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL

/manage

Username

Password

Body required

{
  "resources": {},
  "startDateTime": "string",
  "endDateTime": "string",
  "purposeName": "string",
  "platform": "DEALER_APP",
  "timezone": "string",
  "isAvailable": true
}

Accept

application/jsonapplication/x-protobuf

curl / cURL

curl -L -X POST '/manage/v2/calendar/availability/effective' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "resources": {},
  "startDateTime": "string",
  "endDateTime": "string",
  "purposeName": "string",
  "platform": "DEALER_APP",
  "timezone": "string",
  "isAvailable": true
}'

python / requests

curl -L -X POST '/manage/v2/calendar/availability/effective' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "resources": {},
  "startDateTime": "string",
  "endDateTime": "string",
  "purposeName": "string",
  "platform": "DEALER_APP",
  "timezone": "string",
  "isAvailable": true
}'

go / native

curl -L -X POST '/manage/v2/calendar/availability/effective' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "resources": {},
  "startDateTime": "string",
  "endDateTime": "string",
  "purposeName": "string",
  "platform": "DEALER_APP",
  "timezone": "string",
  "isAvailable": true
}'

nodejs / axios

curl -L -X POST '/manage/v2/calendar/availability/effective' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "resources": {},
  "startDateTime": "string",
  "endDateTime": "string",
  "purposeName": "string",
  "platform": "DEALER_APP",
  "timezone": "string",
  "isAvailable": true
}'

ruby / Net::HTTP

curl -L -X POST '/manage/v2/calendar/availability/effective' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "resources": {},
  "startDateTime": "string",
  "endDateTime": "string",
  "purposeName": "string",
  "platform": "DEALER_APP",
  "timezone": "string",
  "isAvailable": true
}'

csharp / RestSharp

curl -L -X POST '/manage/v2/calendar/availability/effective' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "resources": {},
  "startDateTime": "string",
  "endDateTime": "string",
  "purposeName": "string",
  "platform": "DEALER_APP",
  "timezone": "string",
  "isAvailable": true
}'

php / cURL

curl -L -X POST '/manage/v2/calendar/availability/effective' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "resources": {},
  "startDateTime": "string",
  "endDateTime": "string",
  "purposeName": "string",
  "platform": "DEALER_APP",
  "timezone": "string",
  "isAvailable": true
}'

java / OkHttp

curl -L -X POST '/manage/v2/calendar/availability/effective' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "resources": {},
  "startDateTime": "string",
  "endDateTime": "string",
  "purposeName": "string",
  "platform": "DEALER_APP",
  "timezone": "string",
  "isAvailable": true
}'

powershell / RestMethod

curl -L -X POST '/manage/v2/calendar/availability/effective' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "resources": {},
  "startDateTime": "string",
  "endDateTime": "string",
  "purposeName": "string",
  "platform": "DEALER_APP",
  "timezone": "string",
  "isAvailable": true
}'