Cancel an outstanding request

DELETE /requests/{requestId}
O auth

The request with the supplied requestId is cancelled and deleted. Any information that has already been gathered from on part of the organisation must be deleted. The user must be able to submit a new data request immediately.

Path parameters

  • requestId string Required

    A random identifier that uniquely identifies a request. A version 4 UUID is strongly recommended. Note: the generated identifier must be random. The identifier must not include any information that can be related to the requester. Additionally, requestIds must not be incremental.

Responses

  • 200

    OK

    Value is OK.
  • 401

    Unauthorized

    Hide response attributes Show response attributes object
    • error string

      Value is Unauthorized.

    • message string

      Value is You are not authorized. Generate authentication tokens via OAuth to access this resource..
  • 404

    Not Found

    Hide response attributes Show response attributes object
    • error string

      Value is Not Found.

    • message string

      Value is Could not find a data request with this id..
DELETE /requests/{requestId} 
curl \
 -X DELETE http://api.example.com/requests/{requestId} \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
"OK"
Response examples (200) 
OK
Response examples (401) 
{
  "error": "Unauthorized",
  "message": "You are not authorized. Generate authentication tokens via OAuth to access this resource."
}
Response examples (401) 
{
  "error": "Unauthorized",
  "message": "You are not authorized. Generate authentication tokens via OAuth to access this resource."
}
Response examples (404) 
{
  "error": "Not Found",
  "message": "Could not find a data request with this id."
}
Response examples (404) 
{
  "error": "Not Found",
  "message": "Could not find a data request with this id."
}