BObookingexperts
AgendaPeriods

PATCH maintenance_agenda_period

Changed on

Update an maintenance agenda period.

patch/v3/administrations/{administration_id}/maintenance_agenda_periods/{id}

Request

Path parameters

administration_idstring required

Administration ID

idstring required

Resource ID

Query parameters

fields[agenda_period]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'.

Request body

Example request

{
  "data": {
    "id": "1",
    "type": "agenda_period",
    "relationships": {
      "rentable": {
        "data": {
          "type": "rentable"
        }
      },
      "inventory_object": {
        "data": {
          "type": "inventory_object"
        }
      }
    }
  },
  "included": [
    {
      "id": "1",
      "type": "rentable",
      "relationships": {
        "category": {
          "data": {
            "type": "category"
          }
        },
        "rentable_type": {
          "data": {
            "type": "rentable_type"
          }
        },
        "rentable_identity": {
          "data": {
            "type": "rentable_identity"
          }
        },
        "inventory_object": {
          "data": {
            "type": "inventory_object"
          }
        },
        "rentable_amenities": {
          "data": [
            {
              "type": "rentable_amenity"
            }
          ]
        }
      }
    }
  ]
}

Response

AgendaPeriodResponse

Example response

{
  "data": {
    "id": "1",
    "type": "agenda_period",
    "relationships": {
      "rentable": {
        "data": {
          "type": "rentable"
        }
      },
      "inventory_object": {
        "data": {
          "type": "inventory_object"
        }
      },
      "reservation": {
        "data": {
          "type": "reservation"
        }
      }
    }
  },
  "included": [
    {
      "id": "1",
      "type": "rentable",
      "relationships": {
        "category": {
          "data": {
            "type": "category"
          }
        },
        "rentable_type": {
          "data": {
            "type": "rentable_type"
          }
        },
        "rentable_identity": {
          "data": {
            "type": "rentable_identity"
          }
        },
        "inventory_object": {
          "data": {
            "type": "inventory_object"
          }
        },
        "rentable_amenities": {
          "data": [
            {
              "type": "rentable_amenity"
            }
          ]
        }
      }
    }
  ]
}

Changes

  • ff81bc4fefa9Revision changes
    • warning

      added the new da-DK enum value to the /////// response property for the response status

    • warning

      added the new en-GB enum value to the /////// response property for the response status

    • warning

      added the new en-US enum value to the /////// response property for the response status

    • info

      added the new optional request property //

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • 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

    • info

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

    • info

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