{
  "openapi": "3.1.1",
  "info": {
    "title": "Aurora Client API",
    "description": "API for client integration. For documentation see: https://client.integration.aurora.co.uk/documentation/",
    "contact": {
      "name": "Aurora IT",
      "url": "https://client.integration.aurora.co.uk/documentation/",
      "email": "client.integration@aurora.co.uk"
    },
    "version": "v1"
  },
  "servers": [
    {
      "url": "https://dev.client.integration.aurora.co.uk",
      "description": "Dev"
    },
    {
      "url": "https://api.client.integration.aurora.co.uk",
      "description": "Live"
    }
  ],
  "paths": {
    "/accounts": {
      "get": {
        "tags": [
          "Account"
        ],
        "summary": "Get all Accounts",
        "description": "Get all Accounts",
        "operationId": "GetAllAccounts",
        "parameters": [
          {
            "name": "orderBy",
            "in": "query",
            "description": "The sorting query expression can be built with a comma-delimited sorted list of field/property names, followed by `asc` or `desc` keywords. \n        If you don't add these keywords, the API assumes you need Ascending sorting.",
            "required": true,
            "schema": {
              "minLength": 1,
              "type": "string",
              "default": "id asc"
            }
          },
          {
            "name": "skip",
            "in": "query",
            "description": "The number of results to skip, used for pagination",
            "schema": {
              "maximum": 2147483647,
              "minimum": 0,
              "type": "integer",
              "format": "int32",
              "default": 0
            }
          },
          {
            "name": "take",
            "in": "query",
            "description": "The number of results to return",
            "schema": {
              "maximum": 100,
              "minimum": 1,
              "type": "integer",
              "format": "int32",
              "default": 10
            }
          },
          {
            "name": "filter",
            "in": "query",
            "description": "Filter expression, see: https://client.integration.aurora.co.uk/documentation/reference/filtering/",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "count",
            "in": "query",
            "description": "Whether to include the total number of results in the response",
            "schema": {
              "type": "boolean",
              "default": false
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PageOfAccount"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "429": {
            "$ref": "#/components/responses/429"
          },
          "500": {
            "$ref": "#/components/responses/500"
          }
        }
      }
    },
    "/accounts/{id}": {
      "get": {
        "tags": [
          "Account"
        ],
        "summary": "Get Account",
        "description": "Get a specific Account",
        "operationId": "GetAccount",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Id of the Account",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Account"
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "429": {
            "$ref": "#/components/responses/429"
          },
          "500": {
            "$ref": "#/components/responses/500"
          }
        }
      }
    },
    "/sites": {
      "get": {
        "tags": [
          "Site"
        ],
        "summary": "Get all Sites",
        "description": "Get all Sites",
        "operationId": "GetAllSites",
        "parameters": [
          {
            "name": "orderBy",
            "in": "query",
            "description": "The sorting query expression can be built with a comma-delimited sorted list of field/property names, followed by `asc` or `desc` keywords. \n        If you don't add these keywords, the API assumes you need Ascending sorting.",
            "required": true,
            "schema": {
              "minLength": 1,
              "type": "string",
              "default": "id asc"
            }
          },
          {
            "name": "skip",
            "in": "query",
            "description": "The number of results to skip, used for pagination",
            "schema": {
              "maximum": 2147483647,
              "minimum": 0,
              "type": "integer",
              "format": "int32",
              "default": 0
            }
          },
          {
            "name": "take",
            "in": "query",
            "description": "The number of results to return",
            "schema": {
              "maximum": 100,
              "minimum": 1,
              "type": "integer",
              "format": "int32",
              "default": 10
            }
          },
          {
            "name": "filter",
            "in": "query",
            "description": "Filter expression, see: https://client.integration.aurora.co.uk/documentation/reference/filtering/",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "count",
            "in": "query",
            "description": "Whether to include the total number of results in the response",
            "schema": {
              "type": "boolean",
              "default": false
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PageOfSite"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "429": {
            "$ref": "#/components/responses/429"
          },
          "500": {
            "$ref": "#/components/responses/500"
          }
        }
      }
    },
    "/sites/{id}": {
      "get": {
        "tags": [
          "Site"
        ],
        "summary": "Get Site",
        "description": "Get a specific Site",
        "operationId": "GetSite",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Id of the Site",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Site"
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "429": {
            "$ref": "#/components/responses/429"
          },
          "500": {
            "$ref": "#/components/responses/500"
          }
        }
      }
    },
    "/assets": {
      "get": {
        "tags": [
          "Asset"
        ],
        "summary": "Get all Assets",
        "description": "Get all Assets",
        "operationId": "GetAllAssets",
        "parameters": [
          {
            "name": "orderBy",
            "in": "query",
            "description": "The sorting query expression can be built with a comma-delimited sorted list of field/property names, followed by `asc` or `desc` keywords. \n        If you don't add these keywords, the API assumes you need Ascending sorting.",
            "required": true,
            "schema": {
              "minLength": 1,
              "type": "string",
              "default": "id asc"
            }
          },
          {
            "name": "skip",
            "in": "query",
            "description": "The number of results to skip, used for pagination",
            "schema": {
              "maximum": 2147483647,
              "minimum": 0,
              "type": "integer",
              "format": "int32",
              "default": 0
            }
          },
          {
            "name": "take",
            "in": "query",
            "description": "The number of results to return",
            "schema": {
              "maximum": 100,
              "minimum": 1,
              "type": "integer",
              "format": "int32",
              "default": 10
            }
          },
          {
            "name": "filter",
            "in": "query",
            "description": "Filter expression, see: https://client.integration.aurora.co.uk/documentation/reference/filtering/",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "count",
            "in": "query",
            "description": "Whether to include the total number of results in the response",
            "schema": {
              "type": "boolean",
              "default": false
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PageOfAsset"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "429": {
            "$ref": "#/components/responses/429"
          },
          "500": {
            "$ref": "#/components/responses/500"
          }
        }
      }
    },
    "/assets/{id}": {
      "get": {
        "tags": [
          "Asset"
        ],
        "summary": "Get Asset",
        "description": "Get a specific Asset",
        "operationId": "GetAsset",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Id of the Asset",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Asset"
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "429": {
            "$ref": "#/components/responses/429"
          },
          "500": {
            "$ref": "#/components/responses/500"
          }
        }
      }
    },
    "/tickets": {
      "get": {
        "tags": [
          "Ticket"
        ],
        "summary": "Get all Tickets",
        "description": "Get all Tickets",
        "operationId": "GetAllTickets",
        "parameters": [
          {
            "name": "orderBy",
            "in": "query",
            "description": "The sorting query expression can be built with a comma-delimited sorted list of field/property names, followed by `asc` or `desc` keywords. \n        If you don't add these keywords, the API assumes you need Ascending sorting.",
            "required": true,
            "schema": {
              "minLength": 1,
              "type": "string",
              "default": "id asc"
            }
          },
          {
            "name": "skip",
            "in": "query",
            "description": "The number of results to skip, used for pagination",
            "schema": {
              "maximum": 2147483647,
              "minimum": 0,
              "type": "integer",
              "format": "int32",
              "default": 0
            }
          },
          {
            "name": "take",
            "in": "query",
            "description": "The number of results to return",
            "schema": {
              "maximum": 100,
              "minimum": 1,
              "type": "integer",
              "format": "int32",
              "default": 10
            }
          },
          {
            "name": "filter",
            "in": "query",
            "description": "Filter expression, see: https://client.integration.aurora.co.uk/documentation/reference/filtering/",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "count",
            "in": "query",
            "description": "Whether to include the total number of results in the response",
            "schema": {
              "type": "boolean",
              "default": false
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PageOfTicket"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "429": {
            "$ref": "#/components/responses/429"
          },
          "500": {
            "$ref": "#/components/responses/500"
          }
        }
      }
    },
    "/tickets/{id}": {
      "get": {
        "tags": [
          "Ticket"
        ],
        "summary": "Get Ticket",
        "description": "Get a specific Ticket",
        "operationId": "GetTicket",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Id of the Ticket",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Ticket"
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "429": {
            "$ref": "#/components/responses/429"
          },
          "500": {
            "$ref": "#/components/responses/500"
          }
        }
      }
    },
    "/assets/{assetId}/tickets": {
      "post": {
        "tags": [
          "Ticket"
        ],
        "summary": "Create a Ticket",
        "description": "Create a new Ticket for the specified Asset",
        "operationId": "CreateTicket",
        "parameters": [
          {
            "name": "assetId",
            "in": "path",
            "description": "Id of the Asset",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TicketCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Ticket"
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "429": {
            "$ref": "#/components/responses/429"
          },
          "500": {
            "$ref": "#/components/responses/500"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Account": {
        "required": [
          "id",
          "reference",
          "name",
          "dateCreated",
          "dateModified"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "reference": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "dateCreated": {
            "type": "string",
            "format": "date-time"
          },
          "dateModified": {
            "type": "string",
            "format": "date-time"
          }
        },
        "additionalProperties": false
      },
      "Asset": {
        "required": [
          "id",
          "name",
          "dateCreated",
          "dateModified"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "name": {
            "type": "string"
          },
          "serialNumber": {
            "type": [
              "null",
              "string"
            ]
          },
          "assetNumber": {
            "type": [
              "null",
              "string"
            ]
          },
          "manufacturer": {
            "type": [
              "null",
              "string"
            ]
          },
          "model": {
            "type": [
              "null",
              "string"
            ]
          },
          "description": {
            "type": [
              "null",
              "string"
            ]
          },
          "location": {
            "type": [
              "null",
              "string"
            ]
          },
          "site": {
            "oneOf": [
              {
                "type": "null"
              },
              {
                "$ref": "#/components/schemas/Site"
              }
            ]
          },
          "dateCreated": {
            "type": "string",
            "format": "date-time"
          },
          "dateModified": {
            "type": "string",
            "format": "date-time"
          }
        },
        "additionalProperties": false
      },
      "PageOfAccount": {
        "required": [
          "count"
        ],
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Account"
            }
          },
          "count": {
            "type": [
              "null",
              "integer"
            ],
            "description": "The total number of results available",
            "format": "int32"
          }
        },
        "additionalProperties": false
      },
      "PageOfAsset": {
        "required": [
          "count"
        ],
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Asset"
            }
          },
          "count": {
            "type": [
              "null",
              "integer"
            ],
            "description": "The total number of results available",
            "format": "int32"
          }
        },
        "additionalProperties": false
      },
      "PageOfSite": {
        "required": [
          "count"
        ],
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Site"
            }
          },
          "count": {
            "type": [
              "null",
              "integer"
            ],
            "description": "The total number of results available",
            "format": "int32"
          }
        },
        "additionalProperties": false
      },
      "PageOfTicket": {
        "required": [
          "count"
        ],
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Ticket"
            }
          },
          "count": {
            "type": [
              "null",
              "integer"
            ],
            "description": "The total number of results available",
            "format": "int32"
          }
        },
        "additionalProperties": false
      },
      "Problem": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "status": {
            "type": "number"
          },
          "detail": {
            "type": [
              "null",
              "string"
            ]
          },
          "instance": {
            "type": "string"
          },
          "traceId": {
            "type": "string"
          },
          "errors": {
            "type": [
              "null",
              "object"
            ],
            "additionalProperties": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        }
      },
      "Site": {
        "required": [
          "id",
          "reference",
          "name",
          "account",
          "dateCreated",
          "dateModified"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "reference": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "addressLine1": {
            "type": [
              "null",
              "string"
            ]
          },
          "addressLine2": {
            "type": [
              "null",
              "string"
            ]
          },
          "addressLine3": {
            "type": [
              "null",
              "string"
            ]
          },
          "city": {
            "type": [
              "null",
              "string"
            ]
          },
          "county": {
            "type": [
              "null",
              "string"
            ]
          },
          "postCode": {
            "type": [
              "null",
              "string"
            ]
          },
          "account": {
            "$ref": "#/components/schemas/Account"
          },
          "dateCreated": {
            "type": "string",
            "format": "date-time"
          },
          "dateModified": {
            "type": "string",
            "format": "date-time"
          }
        },
        "additionalProperties": false
      },
      "Ticket": {
        "required": [
          "id",
          "dateOpened",
          "title",
          "description",
          "dateCreated",
          "dateModified"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "number": {
            "type": [
              "null",
              "string"
            ]
          },
          "dateOpened": {
            "type": "string",
            "format": "date-time"
          },
          "dateClosed": {
            "type": [
              "null",
              "string"
            ],
            "format": "date-time"
          },
          "title": {
            "type": "string"
          },
          "description": {
            "type": [
              "null",
              "string"
            ]
          },
          "status": {
            "$ref": "#/components/schemas/TicketStatusEnum"
          },
          "asset": {
            "oneOf": [
              {
                "type": "null"
              },
              {
                "$ref": "#/components/schemas/Asset"
              }
            ]
          },
          "site": {
            "oneOf": [
              {
                "type": "null"
              },
              {
                "$ref": "#/components/schemas/Site"
              }
            ]
          },
          "dateCreated": {
            "type": "string",
            "format": "date-time"
          },
          "dateModified": {
            "type": "string",
            "format": "date-time"
          }
        },
        "additionalProperties": false
      },
      "TicketCreate": {
        "required": [
          "description",
          "contact"
        ],
        "type": "object",
        "properties": {
          "description": {
            "maxLength": 10000,
            "minLength": 0,
            "type": "string",
            "description": "Full ticket details"
          },
          "clientReferenceNumber": {
            "maxLength": 100,
            "minLength": 0,
            "type": [
              "null",
              "string"
            ],
            "description": "A reference number that can be used to refer to this Ticket in the client's system"
          },
          "priority": {
            "$ref": "#/components/schemas/TicketPriorityEnum"
          },
          "contact": {
            "$ref": "#/components/schemas/TicketCreateContact"
          }
        },
        "additionalProperties": false
      },
      "TicketCreateContact": {
        "required": [
          "firstName",
          "lastName"
        ],
        "type": "object",
        "properties": {
          "firstName": {
            "maxLength": 250,
            "minLength": 0,
            "type": "string"
          },
          "lastName": {
            "maxLength": 250,
            "minLength": 0,
            "type": "string"
          },
          "phoneNumber": {
            "maxLength": 250,
            "minLength": 0,
            "type": [
              "null",
              "string"
            ]
          },
          "emailAddress": {
            "maxLength": 500,
            "minLength": 0,
            "type": [
              "null",
              "string"
            ]
          }
        },
        "additionalProperties": false
      },
      "TicketPriorityEnum": {
        "enum": [
          "P1",
          "P2",
          "P3",
          "P4",
          "P5"
        ]
      },
      "TicketStatusEnum": {
        "enum": [
          "Open",
          "InProgress",
          "Closed"
        ]
      }
    },
    "responses": {
      "400": {
        "description": "Bad request",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Problem"
            }
          }
        }
      },
      "401": {
        "description": "Unauthorized",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Problem"
            }
          }
        }
      },
      "404": {
        "description": "Not Found",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Problem"
            }
          }
        }
      },
      "429": {
        "description": "Too many requests",
        "headers": {
          "Retry-After": {
            "description": "The number of seconds to wait before retrying the request.",
            "schema": {
              "type": "integer"
            }
          }
        },
        "content": {
          "text/plain": {
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "500": {
        "description": "Internal Server Error",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Problem"
            }
          }
        }
      }
    },
    "securitySchemes": {
      "liveOauth2": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://auth.aurora.co.uk/oauth/token",
            "scopes": { }
          }
        }
      },
      "liveOpenIdConnect": {
        "type": "openIdConnect",
        "openIdConnectUrl": "https://auth.aurora.co.uk/.well-known/openid-configuration"
      },
      "devOauth2": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://aurora-dev.uk.auth0.com/oauth/token",
            "scopes": { }
          }
        }
      },
      "devOpenIdConnect": {
        "type": "openIdConnect",
        "openIdConnectUrl": "https://aurora-dev.uk.auth0.com/.well-known/openid-configuration"
      }
    }
  },
  "security": [
    {
      "liveOauth2": [ ]
    },
    {
      "liveOpenIdConnect": [ ]
    },
    {
      "devOauth2": [ ]
    },
    {
      "devOpenIdConnect": [ ]
    }
  ],
  "tags": [
    {
      "name": "Account",
      "description": "Operations for interacting with Accounts"
    },
    {
      "name": "Site",
      "description": "Operations for interacting with Sites"
    },
    {
      "name": "Asset",
      "description": "Operations for interacting with Assets"
    },
    {
      "name": "Ticket",
      "description": "Operations for interacting with Tickets"
    }
  ]
}