BObookingexperts
Channel Security Deposit Policies

GET security deposit policy

Changed on

Returns a security deposit policy

get/v3/channels/{channel_id}/security_deposit_policies/{id}

Request

Path parameters

channel_idstring required

Channel ID

idstring required

Resource ID

Query parameters

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.

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

SecurityDepositPolicyResponse

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