request

Changed on
get/api/v1/request/

Request

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

Query parameters

campaigninteger
categoriesstring
checkedboolean
classificationstring
costs_maxstring decimal
costs_minstring decimal
created_at_afterstring date
created_at_beforestring date
followerstring
format'csv' | 'json'
has_sameboolean
is_foiboolean
jurisdictioninteger
lawinteger
limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

projectinteger
public_bodyinteger
referencestring
resolution'not_held' | 'partially_successful' | 'refused' | 'successful' | 'user_withdrew' | 'user_withdrew_costs'
  • successful - Request Successful
  • partially_successful - Request partially successful
  • not_held - Information not held
  • refused - Request refused
  • user_withdrew_costs - Request was withdrawn due to costs
  • user_withdrew - Request was withdrawn
slugstring
status'asleep' | 'awaiting_classification' | 'awaiting_publicbody_confirmation' | 'awaiting_response' | 'awaiting_user_confirmation' | 'publicbody_needed' | 'resolved'
  • awaiting_user_confirmation - Awaiting user confirmation
  • publicbody_needed - Public Body needed
  • awaiting_publicbody_confirmation - Awaiting Public Body confirmation
  • awaiting_response - Awaiting response
  • awaiting_classification - Request awaits classification
  • asleep - Request asleep
  • resolved - Request resolved
tagsstring
userinteger

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

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
    • 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)