---
openapi: 3.0.1
info:
  title: Court Data Adaptor
  description: |-
    CDA exposes API endpoints to the LAA's View Court Data and
                          MAAT/MLRA applications and the HMCTS Common Platform in order to
                          exchange criminal court data between the two organisations.
  version: v1
paths:
  "/api/external/v1/hearings":
    post:
      summary: post hearing
      description: Post Common Platform hearing data to CDA
      tags:
      - External - available to Common Platform
      security:
      - oAuth: []
      parameters: []
      responses:
        '202':
          description: Accepted
        '422':
          description: Unprocessable Entity
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
      requestBody:
        content:
          application/json:
            schema:
              "$ref": hearing_resulted.json#/definitions/new_resource
        description: The minimal Hearing Resulted payload
  "/api/external/v1/prosecution_conclusions":
    post:
      summary: post prosecution conclusion
      description: Post Common Platform prosecution concluded data to CDA
      tags:
      - External - available to Common Platform
      security:
      - oAuth: []
      parameters: []
      responses:
        '202':
          description: Accepted
        '422':
          description: Unprocessable Entity
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
      requestBody:
        content:
          application/json:
            schema:
              "$ref": prosecution_concluded_request.json#/definitions/resource
        required: true
        description: The minimal prosecution concluded payload
  "/api/internal/v1/representation_orders":
    post:
      summary: post representation_order
      description: Post a Representation Order to CDA to update the status on a MAAT
        case to a Common Platform case
      tags:
      - Internal - available to other LAA applications
      security:
      - oAuth: []
      parameters:
      - "$ref": "#/components/parameters/transaction_id_header"
      responses:
        '202':
          description: Accepted
        '422':
          description: Unprocessable entity
        '401':
          description: Unauthorized
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              "$ref": representation_order.json#/definitions/new_resource
        required: true
        description: The Representation Order for an offence
components:
  securitySchemes:
    oAuth:
      in: header
      type: oauth2
      description: OAuth2 client credentials flow
      flows:
        clientCredentials:
          scopes: []
          tokenUrl: "/oauth/token"
  parameters:
    transaction_id_header:
      type: uuid
      name: X-Request-ID
      in: header
      required: false
      description: A unique identifier for an individual request that can be traced
        across multiple systems
      example: d7f509e8-309c-4262-a41d-ebbb44deab9e