# Callout Server API #

This page renders the OpenAPI specification for the Callout Server (external test server) used by the A1 Simulator, directly inline.

All a1policies

GET /a1policies

Get all a1 policies

Example request:

GET /a1policies HTTP/1.1
Host: example.com

Status Codes:

• 200 OK –

  Array of all a1 policies

  Example response:

  HTTP/1.1 200 OK
  Content-Type: application/json
  
  [
      {}
  ]
  

• 429 Too Many Requests –

  Too many requests have been sent in a given amount of time

  Example response:

  HTTP/1.1 429 Too Many Requests
  Content-Type: application/problem+json
  
  {
      "type": "string",
      "title": "string",
      "status": 1.0,
      "detail": "string",
      "instance": "string"
  }
  

• 503 Service Unavailable –

  The provider is currently unable to handle the request due to a temporary overload

  Example response:

  HTTP/1.1 503 Service Unavailable
  Content-Type: application/problem+json
  
  {
      "type": "string",
      "title": "string",
      "status": 1.0,
      "detail": "string",
      "instance": "string"
  }
  

Single A1 Policy Object

GET /a1policy/{a1policyId}

Query for an A1 policy

Parameters:

• a1policyId (string)

Example request:

GET /a1policy/{a1policyId} HTTP/1.1
Host: example.com

Status Codes:

• 200 OK –

  The requested A1 policy object

  Example response:

  HTTP/1.1 200 OK
  Content-Type: application/json
  
  {}
  

• 404 Not Found –

  No resource found at the URI

  Example response:

  HTTP/1.1 404 Not Found
  Content-Type: application/problem+json
  
  {
      "type": "string",
      "title": "string",
      "status": 1.0,
      "detail": "string",
      "instance": "string"
  }
  

• 409 Conflict –

  Request could not be processed in the current state of the resource

  Example response:

  HTTP/1.1 409 Conflict
  Content-Type: application/problem+json
  
  {
      "type": "string",
      "title": "string",
      "status": 1.0,
      "detail": "string",
      "instance": "string"
  }
  

• 429 Too Many Requests –

  Too many requests have been sent in a given amount of time

  Example response:

  HTTP/1.1 429 Too Many Requests
  Content-Type: application/problem+json
  
  {
      "type": "string",
      "title": "string",
      "status": 1.0,
      "detail": "string",
      "instance": "string"
  }
  

• 503 Service Unavailable –

  The provider is currently unable to handle the request due to a temporary overload

  Example response:

  HTTP/1.1 503 Service Unavailable
  Content-Type: application/problem+json
  
  {
      "type": "string",
      "title": "string",
      "status": 1.0,
      "detail": "string",
      "instance": "string"
  }
  

Individual A1 policy Object

PUT /a1policy/{a1policyId}

Create an A1 policy

Parameters:

• a1policyId (string)

Example request:

PUT /a1policy/{a1policyId} HTTP/1.1
Host: example.com
Content-Type: application/json

{}

Status Codes:

• 200 OK –

  The A1 policy was updated

  Example response:

  HTTP/1.1 200 OK
  Content-Type: application/json
  
  {}
  

• 201 Created –

  The A1 policy was created

  Example response:

  HTTP/1.1 201 Created
  Content-Type: application/json
  
  {}
  

• 400 Bad Request –

  A1 policy not properly formulated or not related to the method

  Example response:

  HTTP/1.1 400 Bad Request
  Content-Type: application/problem+json
  
  {
      "type": "string",
      "title": "string",
      "status": 1.0,
      "detail": "string",
      "instance": "string"
  }
  

• 409 Conflict –

  Request could not be processed in the current state of the resource

  Example response:

  HTTP/1.1 409 Conflict
  Content-Type: application/problem+json
  
  {
      "type": "string",
      "title": "string",
      "status": 1.0,
      "detail": "string",
      "instance": "string"
  }
  

• 429 Too Many Requests –

  Too many requests have been sent in a given amount of time

  Example response:

  HTTP/1.1 429 Too Many Requests
  Content-Type: application/problem+json
  
  {
      "type": "string",
      "title": "string",
      "status": 1.0,
      "detail": "string",
      "instance": "string"
  }
  

• 503 Service Unavailable –

  The provider is currently unable to handle the request due to a temporary overload

  Example response:

  HTTP/1.1 503 Service Unavailable
  Content-Type: application/problem+json
  
  {
      "type": "string",
      "title": "string",
      "status": 1.0,
      "detail": "string",
      "instance": "string"
  }
  

• 507 Insufficient Storage –

  The method could not be performed on the resource because the provider is unable to store the representation needed to successfully complete the request

  Example response:

  HTTP/1.1 507 Insufficient Storage
  Content-Type: application/problem+json
  
  {
      "type": "string",
      "title": "string",
      "status": 1.0,
      "detail": "string",
      "instance": "string"
  }
  

Response Headers:

• Location – Contains the URI of the created A1 policy

Individual a1policy Object

DELETE /a1policy/{a1policyId}

Delete an A1 policy

Parameters:

• a1policyId (string)

Status Codes:

• 204 No Content – The A1 policy was deleted

• 404 Not Found –

  No resource found at the URI

  Example response:

  HTTP/1.1 404 Not Found
  Content-Type: application/problem+json
  
  {
      "type": "string",
      "title": "string",
      "status": 1.0,
      "detail": "string",
      "instance": "string"
  }
  

• 429 Too Many Requests –

  Too many requests have been sent in a given amount of time

  Example response:

  HTTP/1.1 429 Too Many Requests
  Content-Type: application/problem+json
  
  {
      "type": "string",
      "title": "string",
      "status": 1.0,
      "detail": "string",
      "instance": "string"
  }
  

• 503 Service Unavailable –

  The provider is currently unable to handle the request due to a temporary overload

  Example response:

  HTTP/1.1 503 Service Unavailable
  Content-Type: application/problem+json
  
  {
      "type": "string",
      "title": "string",
      "status": 1.0,
      "detail": "string",
      "instance": "string"
  }