request

Changed on
patch/api/v1/request/{id}/

Request

  • The document declares no server URL.
  • Auth: one of:
    • OAuth 2 (scopes: make:request)
    • API key in cookie sessionid

Path parameters

idinteger required

A unique integer value identifying this Freedom of Information Request.

Query parameters

format'csv' | 'json'

Request body

resource_uristring uri
idinteger
urlstring
jurisdictionstring uri
jurisdiction_namestring
is_foiboolean
checkedboolean
refusal_reasonstring
costsstring decimal
publicboolean
lawstring uri
descriptionstring
redacted_descriptionstring
summarystring
same_as_countinteger
same_asstring uri
due_datestring date-time nullable
resolved_onstring date-time nullable
last_messagestring date-time nullable
created_atstring date-time nullable
last_modified_atstring date-time
status'awaiting_response' | 'resolved'
  • awaiting_response - awaiting_response
  • resolved - resolved
status_representationstring
readable_statusstring
slugstring
titlestring
referencestring
userstring
projectinteger
project_site_urlstring
project_request_countstring
campaignstring uri
tagsstring[]

Response

resource_uristring uri required
idinteger required
urlstring required
jurisdictionstring uri required
jurisdiction_namestring required
is_foiboolean required
checkedboolean required
refusal_reasonstring required
costsstring decimal required
publicboolean required
lawstring uri required
descriptionstring required
redacted_descriptionstring required
summarystring
same_as_countinteger required
same_asstring uri required
due_datestring date-time nullable required
resolved_onstring date-time nullable required
last_messagestring date-time nullable required
created_atstring date-time nullable required
last_modified_atstring date-time required
status'awaiting_response' | 'resolved' required
  • awaiting_response - awaiting_response
  • resolved - resolved
status_representationstring required
readable_statusstring required
slugstring required
titlestring required
referencestring required
userstring required
projectinteger required
project_site_urlstring required
project_request_countstring required
campaignstring uri required
tagsstring[] required

Changes

  • 195a255a499bRevision changes
    • info

      added the required property to the response with the status (media type: application/json)

    • info

      added the required property to the response with the status (media type: text/csv)

    • info

      added the required property to the response with the status (media type: application/json)

    • info

      added the required property to the response with the status (media type: text/csv)

    • info

      added the required property to the response with the status (media type: application/json)

    • info

      added the required property to the response with the status (media type: text/csv)

    • info

      added the required property to the response with the status (media type: application/json)

    • info

      added the required property to the response with the status (media type: text/csv)

    • info

      added the required property to the response with the status (media type: application/json)

    • info

      added the required property to the response with the status (media type: text/csv)

  • f66b5d75cfd8Revision changes
    • breaking

      removed the enum value asleep of the request property (media type: application/json)

    • breaking

      removed the enum value asleep of the request property (media type: application/x-www-form-urlencoded)

    • breaking

      removed the enum value asleep of the request property (media type: multipart/form-data)

    • breaking

      removed the enum value awaiting_classification of the request property (media type: application/json)

    • breaking

      removed the enum value awaiting_classification of the request property (media type: application/x-www-form-urlencoded)

    • breaking

      removed the enum value awaiting_classification of the request property (media type: multipart/form-data)

    • breaking

      removed the enum value awaiting_publicbody_confirmation of the request property (media type: application/json)

    • breaking

      removed the enum value awaiting_publicbody_confirmation of the request property (media type: application/x-www-form-urlencoded)

    • breaking

      removed the enum value awaiting_publicbody_confirmation of the request property (media type: multipart/form-data)

    • breaking

      removed the enum value awaiting_user_confirmation of the request property (media type: application/json)

    • breaking

      removed the enum value awaiting_user_confirmation of the request property (media type: application/x-www-form-urlencoded)

    • breaking

      removed the enum value awaiting_user_confirmation of the request property (media type: multipart/form-data)

    • breaking

      removed the enum value publicbody_needed of the request property (media type: application/json)

    • breaking

      removed the enum value publicbody_needed of the request property (media type: application/x-www-form-urlencoded)

    • breaking

      removed the enum value publicbody_needed of the request property (media type: multipart/form-data)

    • info

      removed the asleep enum value from the response property for the response status (media type: application/json)

    • info

      removed the asleep enum value from the response property for the response status (media type: text/csv)

    • info

      removed the awaiting_classification enum value from the response property for the response status (media type: application/json)

    • info

      removed the awaiting_classification enum value from the response property for the response status (media type: text/csv)

    • info

      removed the awaiting_publicbody_confirmation enum value from the response property for the response status (media type: application/json)

    • info

      removed the awaiting_publicbody_confirmation enum value from the response property for the response status (media type: text/csv)

    • info

      removed the awaiting_user_confirmation enum value from the response property for the response status (media type: application/json)

    • info

      removed the awaiting_user_confirmation enum value from the response property for the response status (media type: text/csv)

    • info

      removed the publicbody_needed enum value from the response property for the response status (media type: application/json)

    • info

      removed the publicbody_needed enum value from the response property for the response status (media type: text/csv)