BObookingexperts
Channel Security Deposit Policies

GET security deposit policies

Changed on

Returns all security deposit policies belonging to the channel

get/v3/channels/{channel_id}/security_deposit_policies

Request

Path parameters

channel_idstring required

Channel ID

Query parameters

page[number]integer

Page number

page[size]integer

Page size

sortstring

Sort. Specify a comma separated list of attributes to sort on. Prefix attribute with a - to sort in descending order. Allowed attributes: id

fields[security_deposit_policy]string

Fieldset. Specify a comma separated list of attributes to return

includestring

Includes list. Specify a comma separated list of resources to include.

filter[id]string

Filter on ID

filter[name]string

Filter on name

filter[amount]string

Filter on amount

filter[autorelease_days]string

Filter on autorelease_days

filter[autorefund]string

Filter on autorefund

filter[deadline_strategy]string

Filter on deadline_strategy

filter[standalone_deadline_days]string

Filter on standalone_deadline_days

filter[period]string

Filter on period. Specify a comma separated list of IDs to filter on.

Headers

Accept-Languagestring

Supported languages. A comma separated list with one or more of the following locales: cs, da-DK, de, de-AT, de-CH, en-US, en-GB, es, fr, fr-BE, fr-LU, it, nb, nl, nl-BE, pl, pt, tr, en, da. Default: 'en'.

Response

SecurityDepositPolicyCollectionResponse

Example response

{
  "data": [
    {
      "id": "1",
      "type": "security_deposit_policy",
      "relationships": {
        "period": {
          "data": {
            "type": "period"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "1",
      "type": "period",
      "relationships": {
        "period_entries": {
          "data": [
            {
              "type": "period_entry"
            }
          ]
        }
      }
    }
  ]
}

Changes

  • ff81bc4fefa9Revision changes
    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status