open-api-specification.yml

openapi: '3.0.0'
info:
  title: 'laa-ccms-caab-api'
  version: '1.0.0'
paths:
  /applications:
    get:
      tags:
        - applications
      summary: 'Get Applications'
      operationId: 'getApplications'
      x-spring-paginated: true
      parameters:
        - name: 'case-reference-number'
          in: 'query'
          schema:
            type: 'string'
            example: '1234567890'
        - name: 'provider-id'
          in: 'query'
          schema:
            type: 'string'
            example: '1234567890'
        - name: 'provider-case-ref'
          in: 'query'
          schema:
            type: 'string'
            example: '1234567890'
        - name: 'client-surname'
          in: 'query'
          schema:
            type: 'string'
            example: 'surname'
        - name: 'client-reference'
          in: 'query'
          schema:
            type: 'string'
            example: 'ref1234'
        - name: 'fee-earner'
          in: 'query'
          schema:
            type: 'string'
            example: 'fee earner'
        - name: 'office-id'
          in: 'query'
          schema:
            type: 'integer'
            example: 12345678
        - name: 'status'
          in: 'query'
          schema:
            type: 'string'
            example: 'status'
      responses:
        '200':
          description: 'Successful operation'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/applicationDetails"
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
    post:
      tags:
        - applications
      summary: 'Create Application'
      operationId: 'createApplication'
      requestBody:
        description: Create a application
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/applicationDetail'
      parameters:
        - $ref: '#/components/parameters/caabUserLoginId'
      responses:
        '200':
          description: 'Successful operation'
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
  /applications/{id}:
    get:
      tags:
        - applications
      summary: 'Get Application'
      operationId: 'getApplication'
      parameters:
        - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: 'Successful operation'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/applicationDetail"
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
    patch:
      tags:
        - applications
      summary: 'Update an Application'
      operationId: 'updateApplication'
      requestBody:
        description: Update an application
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/applicationDetail'
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/caabUserLoginId'
      responses:
        '204':
          description: 'Update successful'
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
    delete:
      tags:
        - applications
      summary: 'Remove an application'
      operationId: 'removeApplication'
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/caabUserLoginId'
      responses:
        '204':
          description: 'No Content'
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
  /applications/clients/{client-reference-id}:
    patch:
      tags:
          - applications
      summary: 'Update a client for all applications with matching client reference id'
      operationId: 'updateApplicationClient'
      requestBody:
        description: Update client
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/baseClientDetail'
      parameters:
        - name: 'client-reference-id'
          in: 'path'
          required: true
          schema:
            type: 'string'
            example: '1234567890'
        - $ref: '#/components/parameters/caabUserLoginId'
      responses:
        '204':
          description: 'No Content'
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
  /applications/{id}/application-type:
    get:
      tags:
        - applications
      summary: 'Get application type'
      operationId: 'getApplicationType'
      parameters:
        - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: 'Successful operation'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/applicationType"
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
    put:
      tags:
        - applications
      summary: 'Update application type'
      operationId: 'putApplicationType'
      requestBody:
        description: put an application's application type
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/applicationType'
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/caabUserLoginId'
      responses:
        '200':
          description: 'Successful operation'
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
  /applications/{id}/provider-details:
    get:
      tags:
        - applications
      summary: 'Get an application''s provider details'
      operationId: 'getApplicationProviderDetails'
      parameters:
        - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: 'Successful operation'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/applicationProviderDetails"
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
    put:
      tags:
        - applications
      summary: 'Update an application''s provider details'
      operationId: 'putApplicationProviderDetails'
      requestBody:
        description: put an application's provider details
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/applicationProviderDetails'
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/caabUserLoginId'
      responses:
        '200':
          description: 'Successful operation'
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
  /applications/{id}/correspondence-address:
    get:
      tags:
        - applications
      summary: 'Get an applications correspondence address'
      operationId: 'getApplicationCorrespondenceAddress'
      parameters:
        - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: 'Successful operation'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/addressDetail"
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
    put:
      tags:
        - applications
      summary: 'Update an application''s correspondence address'
      operationId: 'putApplicationCorrespondenceAddress'
      requestBody:
        description: put an application's correspondence address
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/addressDetail'
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/caabUserLoginId'
      responses:
        '200':
          description: 'Successful operation'
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
  /applications/{id}/cost-structure:
    get:
      tags:
        - applications
      summary: 'Get an application''s cost structure'
      operationId: 'getApplicationCostStructure'
      parameters:
        - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: 'Successful operation'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/costStructureDetail"
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
    put:
      tags:
        - applications
      summary: 'Update an applications cost structure'
      operationId: 'updateApplicationCostStructure'
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/caabUserLoginId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/costStructureDetail"
      responses:
        '200':
          description: 'Case updated successfully'
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
  /applications/{id}/linked-cases:
    get:
      tags:
        - applications
      summary: 'Get an application''s linked cases'
      operationId: 'getApplicationLinkedCases'
      parameters:
        - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: 'Successful operation'
          content:
            application/json:
              schema:
                type: 'array'
                items:
                  $ref: "#/components/schemas/linkedCaseDetail"
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
    post:
      tags:
        - applications
      summary: 'Add a linked case to an application'
      operationId: 'addApplicationLinkedCase'
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/caabUserLoginId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/linkedCaseDetail"
      responses:
        '201':
          description: 'Case added successfully'
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
  /linked-cases/{linked-case-id}:
    delete:
      tags:
        - linked cases
      summary: 'Remove a linked case'
      operationId: 'removeLinkedCase'
      parameters:
        - name: 'linked-case-id'
          in: 'path'
          required: true
          schema:
            type: 'integer'
            format: 'int64'
        - $ref: '#/components/parameters/caabUserLoginId'
      responses:
        '204':
          description: 'No Content'
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
    patch:
      tags:
        - linked cases
      summary: 'Update a linked case '
      operationId: 'updateLinkedCase'
      parameters:
        - name: 'linked-case-id'
          in: 'path'
          required: true
          schema:
            type: 'integer'
            format: 'int64'
        - $ref: '#/components/parameters/caabUserLoginId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/linkedCaseDetail"
      responses:
        '200':
          description: 'Case updated successfully'
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
  /applications/{id}/proceedings:
    get:
      tags:
        - applications
      summary: 'Get an application''s proceedings'
      operationId: 'getApplicationProceedings'
      parameters:
        - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: 'Successful operation'
          content:
            application/json:
              schema:
                type: 'array'
                items:
                  $ref: "#/components/schemas/proceedingDetail"
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
    post:
      tags:
        - applications
      summary: 'Add a proceeding to an application'
      operationId: 'addApplicationProceeding'
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/caabUserLoginId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/proceedingDetail"
      responses:
        '201':
          description: 'Case added successfully'
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
  /proceedings/{proceeding-id}:
    delete:
      tags:
        - proceedings
      summary: 'Remove a proceeding'
      operationId: 'removeProceeding'
      parameters:
        - name: 'proceeding-id'
          in: 'path'
          required: true
          schema:
            type: 'integer'
            format: 'int64'
        - $ref: '#/components/parameters/caabUserLoginId'
      responses:
        '204':
          description: 'No Content'
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
    patch:
      tags:
        - proceedings
      summary: 'Update a proceeding'
      operationId: 'updateProceeding'
      parameters:
        - name: 'proceeding-id'
          in: 'path'
          required: true
          schema:
            type: 'integer'
            format: 'int64'
        - $ref: '#/components/parameters/caabUserLoginId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/proceedingDetail"
      responses:
        '200':
          description: 'Case updated successfully'
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
  /proceedings/{proceeding-id}/scope-limitations:
    get:
      tags:
        - proceedings
      summary: 'Get a proceeding''s scope limitations'
      operationId: 'getProceedingsScopeLimitations'
      parameters:
        - name: 'proceeding-id'
          in: 'path'
          required: true
          schema:
            type: 'integer'
            format: 'int64'
            example: '1234567890'
      responses:
        '200':
          description: 'Successful operation'
          content:
            application/json:
              schema:
                type: 'array'
                items:
                  $ref: "#/components/schemas/scopeLimitationDetail"
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
    post:
      tags:
        - proceedings
      summary: 'Add a scope limitations to an proceeding'
      operationId: 'addProceedingScopeLimitation'
      parameters:
        - name: 'proceeding-id'
          in: 'path'
          required: true
          schema:
            type: 'integer'
            format: 'int64'
        - $ref: '#/components/parameters/caabUserLoginId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/scopeLimitationDetail"
      responses:
        '201':
          description: 'Case added successfully'
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
  /scope-limitations/{scope-limitation-id}:
    delete:
      tags:
        - scope limitations
      summary: 'Remove a scope limitations'
      operationId: 'removeScopeLimitation'
      parameters:
        - name: 'scope-limitation-id'
          in: 'path'
          required: true
          schema:
            type: 'integer'
            format: 'int64'
        - $ref: '#/components/parameters/caabUserLoginId'
      responses:
        '204':
          description: 'No Content'
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
    patch:
      tags:
        - scope limitations
      summary: 'Update a scope limitation'
      operationId: 'updateScopeLimitation'
      parameters:
        - name: 'scope-limitation-id'
          in: 'path'
          required: true
          schema:
            type: 'integer'
            format: 'int64'
        - $ref: '#/components/parameters/caabUserLoginId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/scopeLimitationDetail"
      responses:
        '200':
          description: 'Case updated successfully'
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
  /applications/{id}/prior-authorities:
    get:
      tags:
        - applications
      summary: 'Get an application''s prior authorities'
      operationId: 'getApplicationPriorAuthorities'
      parameters:
        - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: 'Successful operation'
          content:
            application/json:
              schema:
                type: 'array'
                items:
                  $ref: "#/components/schemas/priorAuthorityDetail"
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
    post:
      tags:
        - applications
      summary: 'Add a prior authority to an application'
      operationId: 'addApplicationPriorAuthority'
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/caabUserLoginId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/priorAuthorityDetail"
      responses:
        '201':
          description: 'Prior Authority added successfully'
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
  /prior-authorities/{prior-authority-id}:
    delete:
      tags:
        - prior authorities
      summary: 'Remove a prior authority'
      operationId: 'removePriorAuthority'
      parameters:
        - name: 'prior-authority-id'
          in: 'path'
          required: true
          schema:
            type: 'integer'
            format: 'int64'
        - $ref: '#/components/parameters/caabUserLoginId'
      responses:
        '204':
          description: 'No Content'
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
    patch:
      tags:
        - prior authorities
      summary: 'Update a prior authority'
      operationId: 'updatePriorAuthority'
      parameters:
        - name: 'prior-authority-id'
          in: 'path'
          required: true
          schema:
            type: 'integer'
            format: 'int64'
        - $ref: '#/components/parameters/caabUserLoginId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/priorAuthorityDetail"
      responses:
        '200':
          description: 'Case updated successfully'
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'

  /applications/{id}/opponents:
    get:
      tags:
        - applications
      summary: 'Get an application''s opponents'
      operationId: 'getApplicationOpponents'
      parameters:
        - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: 'Successful operation'
          content:
            application/json:
              schema:
                type: 'array'
                items:
                  $ref: "#/components/schemas/opponentDetail"
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
    post:
      tags:
        - applications
      summary: 'Add an opponent to an application'
      operationId: 'addApplicationOpponent'
      parameters:
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/caabUserLoginId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/opponentDetail"
      responses:
        '201':
          description: 'Opponent added successfully'
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
  /opponents/{opponent-id}:
    delete:
      tags:
        - opponents
      summary: 'Remove an opponent'
      operationId: 'removeOpponent'
      parameters:
        - name: 'opponent-id'
          in: 'path'
          required: true
          schema:
            type: 'integer'
            format: 'int64'
        - $ref: '#/components/parameters/caabUserLoginId'
      responses:
        '204':
          description: 'No Content'
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
    patch:
      tags:
        - opponents
      summary: 'Update an opponent'
      operationId: 'updateOpponent'
      parameters:
        - name: 'opponent-id'
          in: 'path'
          required: true
          schema:
            type: 'integer'
            format: 'int64'
        - $ref: '#/components/parameters/caabUserLoginId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/opponentDetail"
      responses:
        '200':
          description: 'Opponent updated successfully'
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
  /notification-attachments:
    get:
      tags:
        - notification attachments
      summary: 'Get Notification Attachments'
      operationId: 'getNotificationAttachments'
      x-spring-paginated: true
      parameters:
        - name: 'notification-reference'
          in: 'query'
          schema:
            type: 'string'
            example: '1234567890'
        - name: 'provider-id'
          in: 'query'
          schema:
            type: 'string'
            example: '1234567890'
        - name: 'document-type'
          in: 'query'
          schema:
            type: 'string'
            example: 'type'
        - name: 'send-by'
          in: 'query'
          schema:
            type: 'string'
            example: 'type'
      responses:
        '200':
          description: 'Successful operation'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/notificationAttachmentDetails"
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
    post:
      tags:
        - notification attachments
      summary: 'Create Notification Attachment'
      operationId: 'createNotificationAttachment'
      requestBody:
        description: Create Notification Attachment
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/notificationAttachmentDetail'
      parameters:
        - name: 'Caab-User-Login-Id'
          in: header
          required: true
          schema:
            type: 'string'
          example: 'SOMEUSER@COMPANY.CO.UK'
      responses:
        '200':
          description: 'Successful operation'
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
    delete:
      tags:
        - notification attachments
      summary: 'Remove Notification Attachments'
      operationId: 'removeNotificationAttachments'
      parameters:
        - name: 'notification-reference'
          in: 'query'
          schema:
            type: 'string'
            example: '1234567890'
        - name: 'provider-id'
          in: 'query'
          schema:
            type: 'string'
            example: '1234567890'
        - name: 'document-type'
          in: 'query'
          schema:
            type: 'string'
            example: 'type'
        - name: 'send-by'
          in: 'query'
          schema:
            type: 'string'
            example: 'type'
        - name: 'Caab-User-Login-Id'
          in: header
          required: true
          schema:
            type: 'string'
          example: 'SOMEUSER@COMPANY.CO.UK'
      responses:
        '204':
          description: 'No Content'
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
  /notification-attachments/{notification-attachment-id}:
    get:
      tags:
        - notification attachments
      summary: 'Get Notification Attachment'
      operationId: 'getNotificationAttachment'
      parameters:
        - name: 'notification-attachment-id'
          in: 'path'
          required: true
          schema:
            type: 'integer'
            format: 'int64'
            example: '1234567890'
      responses:
        '200':
          description: 'Successful operation'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/notificationAttachmentDetail"
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
    put:
      tags:
        - notification attachments
      summary: 'Update Notification Attachment'
      operationId: 'updateNotificationAttachment'
      requestBody:
        description: Update Notification Attachment
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/notificationAttachmentDetail'
      parameters:
        - name: 'notification-attachment-id'
          in: 'path'
          required: true
          schema:
            type: 'integer'
            format: 'int64'
        - name: 'Caab-User-Login-Id'
          in: header
          required: true
          schema:
            type: 'string'
          example: 'SOMEUSER@COMPANY.CO.UK'
      responses:
        '200':
          description: 'Successful operation'
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
    delete:
      tags:
        - notification attachments
      summary: 'Remove a Notification Attachment'
      operationId: 'removeNotificationAttachment'
      parameters:
        - name: 'notification-attachment-id'
          in: 'path'
          required: true
          schema:
            type: 'integer'
            format: 'int64'
        - name: 'Caab-User-Login-Id'
          in: header
          required: true
          schema:
            type: 'string'
          example: 'SOMEUSER@COMPANY.CO.UK'
      responses:
        '204':
          description: 'No Content'
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
  /evidence:
    get:
      tags:
        - evidence
      summary: 'Get Evidence Documents'
      operationId: 'getEvidenceDocuments'
      x-spring-paginated: true
      parameters:
        - name: 'application-or-outcome-id'
          in: 'query'
          schema:
            type: 'string'
            example: '1234567890'
        - name: 'case-reference-number'
          in: 'query'
          schema:
            type: 'string'
            example: '1234567890'
        - name: 'provider-id'
          in: 'query'
          schema:
            type: 'string'
            example: '1234567890'
        - name: 'document-type'
          in: 'query'
          schema:
            type: 'string'
            example: 'type'
        - name: 'ccms-module'
          in: 'query'
          schema:
            type: 'string'
            example: 'module'
        - name: 'transfer-pending'
          in: 'query'
          schema:
            type: 'boolean'
            example: 'true'
      responses:
        '200':
          description: 'Successful operation'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/evidenceDocumentDetails"
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
    post:
      tags:
        - evidence
      summary: 'Create Evidence Document'
      operationId: 'createEvidenceDocument'
      requestBody:
        description: Create Evidence Document
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/evidenceDocumentDetail'
      parameters:
        - $ref: '#/components/parameters/caabUserLoginId'
      responses:
        '200':
          description: 'Successful operation'
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
    delete:
      tags:
        - evidence
      summary: 'Remove Evidence Documents'
      operationId: 'removeEvidenceDocuments'
      parameters:
        - name: 'application-or-outcome-id'
          in: 'query'
          schema:
            type: 'string'
            example: '1234567890'
        - name: 'case-reference-number'
          in: 'query'
          schema:
            type: 'string'
            example: '1234567890'
        - name: 'provider-id'
          in: 'query'
          schema:
            type: 'string'
            example: '1234567890'
        - name: 'document-type'
          in: 'query'
          schema:
            type: 'string'
            example: 'type'
        - name: 'ccms-module'
          in: 'query'
          schema:
            type: 'string'
            example: 'module'
        - name: 'transfer-pending'
          in: 'query'
          schema:
            type: 'boolean'
            example: 'true'
        - $ref: '#/components/parameters/caabUserLoginId'
      responses:
        '204':
          description: 'No Content'
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
  /evidence/{evidence-document-id}:
    get:
      tags:
        - evidence
      summary: 'Get Evidence Document'
      operationId: 'getEvidenceDocument'
      parameters:
        - name: 'evidence-document-id'
          in: 'path'
          required: true
          schema:
            type: 'integer'
            format: 'int64'
            example: '1234567890'
      responses:
        '200':
          description: 'Successful operation'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/evidenceDocumentDetail"
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
    patch:
      tags:
        - evidence
      summary: 'Update Evidence Document'
      operationId: 'updateEvidenceDocument'
      requestBody:
        description: Update Evidence Document
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/evidenceDocumentDetail'
      parameters:
        - name: 'evidence-document-id'
          in: 'path'
          required: true
          schema:
            type: 'integer'
            format: 'int64'
            example: '1234567890'
        - $ref: '#/components/parameters/caabUserLoginId'
      responses:
        '200':
          description: 'Evidence updated successfully'
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
    delete:
      tags:
        - evidence
      summary: 'Remove an evidence document'
      operationId: 'removeEvidenceDocument'
      parameters:
        - name: 'evidence-document-id'
          in: 'path'
          required: true
          schema:
            type: 'integer'
            format: 'int64'
        - $ref: '#/components/parameters/caabUserLoginId'
      responses:
        '204':
          description: 'No Content'
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
  /case-outcomes:
    get:
      tags:
        - caseoutcome
      summary: 'Get Case Outcomes'
      operationId: 'getCaseOutcomes'
      x-spring-paginated: false
      parameters:
        - name: 'case-reference-number'
          in: 'query'
          schema:
            type: 'string'
            example: '1234567890'
        - name: 'provider-id'
          in: 'query'
          schema:
            type: 'string'
            example: '1234567890'
      responses:
        '200':
          description: 'Successful operation'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/caseOutcomeDetails"
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
    post:
      tags:
        - caseoutcome
      summary: 'Create Case Outcome'
      operationId: 'createCaseOutcome'
      requestBody:
        description: Create Case Outcome
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/caseOutcomeDetail'
      parameters:
        - $ref: '#/components/parameters/caabUserLoginId'
      responses:
        '200':
          description: 'Successful operation'
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
    delete:
      tags:
        - caseoutcome
      summary: 'Remove Case Outcomes'
      operationId: 'removeCaseOutcomes'
      parameters:
        - name: 'case-reference-number'
          in: 'query'
          schema:
            type: 'string'
            example: '1234567890'
        - name: 'provider-id'
          in: 'query'
          schema:
            type: 'string'
            example: '1234567890'
        - $ref: '#/components/parameters/caabUserLoginId'
      responses:
        '204':
          description: 'No Content'
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
  /case-outcomes/{case-outcome-id}:
    get:
      tags:
        - caseoutcome
      summary: 'Get Case Outcome'
      operationId: 'getCaseOutcome'
      x-spring-paginated: false
      parameters:
        - name: 'case-outcome-id'
          in: 'path'
          required: true
          schema:
            type: 'integer'
            format: 'int64'
            example: '1234567890'
      responses:
        '200':
          description: 'Successful operation'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/caseOutcomeDetail"
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'
    delete:
      tags:
        - caseoutcome
      summary: 'Remove a case outcome'
      operationId: 'removeCaseOutcome'
      parameters:
        - name: 'case-outcome-id'
          in: 'path'
          required: true
          schema:
            type: 'integer'
            format: 'int64'
        - $ref: '#/components/parameters/caabUserLoginId'
      responses:
        '204':
          description: 'No Content'
        '400':
          description: 'Bad request'
        '401':
          description: 'Unauthorized'
        '403':
          description: 'Forbidden'
        '404':
          description: 'Not found'
        '500':
          description: 'Internal server error'

components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
  parameters:
    id:
      in: 'path'
      name: 'id'
      required: true
      schema:
        type: 'integer'
        format: 'int64'
        example: '1234567890'
    caabUserLoginId:
      in: header
      name: 'Caab-User-Login-Id'
      required: true
      schema:
        type: 'string'
      example: 'SOMEUSER@COMPANY.CO.UK'
  schemas:
    intDisplayValue:
      type: 'object'
      properties:
        id:
          type: 'integer'
        display_value:
          type: 'string'
    stringDisplayValue:
      type: 'object'
      properties:
        id:
          type: 'string'
        display_value:
          type: 'string'
    applicationType:
      allOf:
        - $ref: "#/components/schemas/stringDisplayValue"
      type: 'object'
      properties:
        devolved_powers:
            $ref: "#/components/schemas/devolvedPowersDetail"
    booleanDisplayValue:
      type: 'object'
      properties:
        flag:
          type: 'boolean'
        display_value:
          type: 'string'
    costStructureDetail:
      type: 'object'
      properties:
        default_cost_limitation:
          type: 'number'
        granted_cost_limitation:
          type: 'number'
        requested_cost_limitation:
          type: 'number'
        cost_entries:
          type: 'array'
          items:
            $ref: "#/components/schemas/costEntryDetail"
        current_provider_billed_amount:
          type: 'number'
        audit_trail:
          $ref: "#/components/schemas/auditDetail"
    costEntryDetail:
      type: 'object'
      properties:
        amount_billed:
          type: 'number'
        requested_costs:
          type: 'number'
        cost_category:
          type: 'string'
        ebs_id:
          type: 'string'
        new_entry:
          type: 'boolean'
        lsc_resource_id:
          type: 'string'
        resource_name:
          type: 'string'
        submitted:
          type: 'boolean'
          default: 'true'
        audit_trail:
          $ref: "#/components/schemas/auditDetail"
    baseClientDetail:
      type: 'object'
      properties:
        first_name:
          type: 'string'
        surname:
          type: 'string'
    clientDetail:
      allOf:
        - $ref: "#/components/schemas/baseClientDetail"
      type: 'object'
      properties:
        reference:
          type: 'string'
          required:
            - reference
    costLimitDetail:
      type: 'object'
      properties:
        changed:
          type: 'boolean'
        limit_at_time_of_merits:
          type: 'number'
    devolvedPowersDetail:
      type: 'object'
      properties:
        used:
          type: 'boolean'
        date_used:
          type: 'string'
          format: 'date'
        contract_flag:
          type: 'string'
    addressDetail:
      type: 'object'
      properties:
        id:
          type: 'integer'
        no_fixed_abode:
          type: 'boolean'
        postcode:
          type: 'string'
        house_name_or_number:
          type: 'string'
        address_line_1:
          type: 'string'
        address_line_2:
          type: 'string'
        city:
          type: 'string'
        county:
          type: 'string'
        country:
          type: 'string'
        care_of:
          type: 'string'
        preferred_address:
          type: 'string'
        audit_trail:
          $ref: "#/components/schemas/auditDetail"
    scopeLimitationDetail:
      type: 'object'
      properties:
        id:
          type: 'integer'
        scope_limitation:
          $ref: "#/components/schemas/stringDisplayValue"
        ebs_id:
          type: 'string'
        scope_limitation_wording:
          type: 'string'
        default_ind:
          type: 'boolean'
        delegated_func_apply_ind:
          $ref: "#/components/schemas/booleanDisplayValue"
        non_default_wording_reqd:
          type: 'boolean'
        stage:
          type: 'string'
        audit_trail:
          $ref: "#/components/schemas/auditDetail"
    proceedingOutcomeDetail:
      type: 'object'
      properties:
        id:
          type: 'integer'
        date_of_issue:
          type: 'string'
          format: 'date'
        stage_end:
          $ref: "#/components/schemas/stringDisplayValue"
        resolution_method:
          type: 'string'
        date_of_final_work:
          type: 'string'
          format: 'date'
        result:
          $ref: "#/components/schemas/stringDisplayValue"
        result_info:
          type: 'string'
        alternative_resolution:
          type: 'string'
        adr_info:
          type: 'string'
        wider_benefits:
          type: 'string'
        court_code:
          type: 'string'
        court_name:
          type: 'string'
        description:
          type: 'string'
        proceeding_case_id:
          type: 'string'
        outcome_court_case_no:
          type: 'string'
        proceeding_type:
          $ref: "#/components/schemas/stringDisplayValue"
        matter_type:
          $ref: "#/components/schemas/stringDisplayValue"
        audit_trail:
          $ref: "#/components/schemas/auditDetail"
    proceedingDetail:
      type: 'object'
      properties:
        id:
          type: 'integer'
        ebs_id:
          type: 'string'
        matter_type:
          $ref: "#/components/schemas/stringDisplayValue"
        proceeding_type:
          $ref: "#/components/schemas/stringDisplayValue"
        level_of_service:
          $ref: "#/components/schemas/stringDisplayValue"
        client_involvement:
          $ref: "#/components/schemas/stringDisplayValue"
        type_of_order:
          $ref: "#/components/schemas/stringDisplayValue"
        cost_limitation:
          type: 'number'
        status:
          $ref: "#/components/schemas/stringDisplayValue"
        description:
          type: 'string'
        date_granted:
          type: 'string'
          format: 'date'
        date_costs_valid:
          type: 'string'
          format: 'date'
        edited:
          type: 'boolean'
        scope_limitations:
          type: 'array'
          items:
            $ref: "#/components/schemas/scopeLimitationDetail"
        default_scope_limitation:
          type: 'string'
        stage:
          type: 'string'
        lead_proceeding_ind:
          type: 'boolean'
        lar_scope:
          type: 'string'
        granted_using_devolved_powers:
          type: 'string'
        date_devolved_powers_used:
          type: 'string'
          format: 'date'
        proceeding_case_id:
          type: 'string'
        outcome:
          $ref: "#/components/schemas/proceedingOutcomeDetail"
        order_type_req_flag:
          type: 'boolean'
        order_type_display_flag:
          type: 'boolean'
        delete_scope_limitation_flag:
          type: 'boolean'
        available_functions:
          type: 'array'
          items:
            type: 'string'
        audit_trail:
          $ref: "#/components/schemas/auditDetail"
    linkedCaseDetail:
      type: 'object'
      properties:
        id:
          type: 'integer'
        lsc_case_reference:
          type: 'string'
        relation_to_case:
          type: 'string'
        client:
          $ref: "#/components/schemas/clientDetail"
        provider_case_reference:
          type: 'string'
        category_of_law:
          type: 'string'
        fee_earner:
          type: 'string'
        status:
          type: 'string'
        audit_trail:
          $ref: "#/components/schemas/auditDetail"
    priorAuthorityDetail:
      type: 'object'
      properties:
        id:
          type: 'integer'
        ebs_id:
          type: 'string'
        status:
          type: 'string'
        type:
          $ref: "#/components/schemas/stringDisplayValue"
        summary:
          type: 'string'
        justification:
          type: 'string'
        value_required:
          type: 'boolean'
        amount_requested:
          type: 'number'
        items:
          type: 'array'
          items:
            $ref: "#/components/schemas/referenceDataItemDetail"
        audit_trail:
          $ref: "#/components/schemas/auditDetail"
    referenceDataItemDetail:
      type: 'object'
      properties:
        id:
          type: 'integer'
        code:
          $ref: "#/components/schemas/stringDisplayValue"
        type:
          type: 'string'
        mandatory:
          type: 'boolean'
        lov_look_up:
          type: 'string'
        value:
          $ref: "#/components/schemas/stringDisplayValue"
    opponentDetail:
      type: 'object'
      properties:
        id:
          type: 'integer'
        ebs_id:
          type: 'string'
        type:
          type: 'string'
        title:
          type: 'string'
        first_name:
          type: 'string'
        middle_names:
          type: 'string'
        surname:
          type: 'string'
        date_of_birth:
          type: 'string'
          format: 'date'
        national_insurance_number:
          type: 'string'
        address:
          $ref: "#/components/schemas/addressDetail"
        relationship_to_case:
          type: 'string'
        relationship_to_client:
          type: 'string'
        telephone_home:
          type: 'string'
        telephone_work:
          type: 'string'
        telephone_mobile:
          type: 'string'
        fax_number:
          type: 'string'
        email_address:
          type: 'string'
        other_information:
          type: 'string'
        employment_status:
          type: 'string'
        employer_name:
          type: 'string'
        employer_address:
          type: 'string'
        legal_aided:
          type: 'boolean'
        certificate_number:
          type: 'string'
        court_ordered_means_assessment:
          type: 'boolean'
        assessed_income:
          type: 'number'
        assessed_income_frequency:
          type: 'string'
        assessed_assets:
          type: 'number'
        assessment_date:
          type: 'string'
          format: 'date'
        organisation_name:
          type: 'string'
        organisation_type:
          type: "string"
        currently_trading:
          type: 'boolean'
        contact_name_role:
          type: 'string'
        confirmed:
          type: 'boolean'
        app_mode:
          type: 'boolean'
        amendment:
          type: 'boolean'
        award:
          type: 'boolean'
        public_funding_applied:
          type: 'boolean'
        shared_ind:
          type: 'boolean'
        delete_ind:
          type: 'boolean'
        display_name:
          type: 'string'
        display_address:
          type: 'string'
        party_id:
          type: 'string'
        audit_trail:
          $ref: "#/components/schemas/auditDetail"
    recoveryDetail:
      type: 'object'
      properties:
        id:
          type: 'integer'
        award_amount:
          type: 'number'
          default: 0.00
        solicitor_recovery_amount:
          type: 'number'
          default: 0.00
        solicitor_recovery_date:
          type: 'string'
          format: 'date'
        solicitor_amount_paid_to_lsc:
          type: 'number'
          default: 0.00
        court_recovery_amount:
          type: 'number'
          default: 0.00
        court_recovery_date:
          type: 'string'
          format: 'date'
        court_amount_paid_to_lsc:
          type: 'number'
          default: 0.00
        recovered_amount:
          type: 'number'
          default: 0.00
        client_recovery_date:
          type: 'string'
          format: 'date'
        client_amount_paid_to_lsc:
          type: 'number'
          default: 0.00
        client_recovery_amount:
          type: 'number'
          default: 0.00
        unrecovered_amount:
          type: 'number'
          default: 0.00
        leave_of_court_required_ind:
          type: 'boolean'
        offered_amount:
          type: 'number'
          default: 0.00
        conditions_of_offer:
          type: 'string'
        offer_details:
          type: 'string'
        award_type:
          type: 'string'
        description:
          type: 'string'
        audit_trail:
          $ref: "#/components/schemas/auditDetail"
    timeRecoveryDetail:
      type: 'object'
      properties:
        id:
          type: 'integer'
        award_type:
          type: 'string'
        description:
          type: 'string'
        award_amount:
          type: 'number'
          default: 0.00
        triggering_event:
          type: 'string'
        effective_date:
          type: 'string'
          format: 'date'
        time_related_recovery_details:
          type: 'string'
        audit_trail:
          $ref: "#/components/schemas/auditDetail"
    liablePartyDetail:
      type: 'object'
      properties:
        id:
          type: 'integer'
        award_type:
          type: 'string'
        opponent_id:
          type: 'integer'
        audit_trail:
          $ref: "#/components/schemas/auditDetail"
    baseAwardDetail:
      type: 'object'
      discriminator:
        propertyName: 'discriminator'
      properties:
        id:
          type: 'integer'
        award_type:
          type: 'string'
        date_of_order:
          type: 'string'
          format: 'date'
        awarded_by:
          type: 'string'
        description:
          type: 'string'
        award_amount:
          type: 'number'
        update_allowed:
          type: 'boolean'
        delete_allowed:
          type: 'boolean'
          default: true
        ebs_id:
          type: 'string'
        award_code:
          type: 'string'
        effective_date:
          type: 'string'
          format: 'date'
        cost_or_financial:
          type: 'boolean'
          default: false
        opponents_to_select:
          type: 'boolean'
          default: false
        liable_parties:
          type: 'array'
          items:
            $ref: '#/components/schemas/liablePartyDetail'
        audit_trail:
          $ref: "#/components/schemas/auditDetail"
    costAwardDetail:
      allOf:
        - $ref: '#/components/schemas/baseAwardDetail'
      type: 'object'
      properties:
        court_assessment_status:
          type: 'string'
        pre_certificate_lsc_cost:
          type: 'number'
          default: 0.00
        pre_certificate_other_cost:
          type: 'number'
          default: 0.00
        certificate_cost_lsc:
          type: 'number'
          default: 0.00
        total_cert_costs_awarded:
          type: 'number'
          default: 0.00
        certificate_cost_market:
          type: 'number'
          default: 0.00
        interest_awarded_rate:
          type: 'number'
          default: 0.00
        order_served_date:
          type: 'string'
          format: 'date'
        interest_start_date:
          type: 'string'
          format: 'date'
        other_details:
          type: 'string'
        address_line_1:
          type: 'string'
        address_line_2:
          type: 'string'
        address_line_3:
          type: 'string'
        recovery:
          $ref: "#/components/schemas/recoveryDetail"
    financialAwardDetail:
      allOf:
        - $ref: '#/components/schemas/baseAwardDetail'
      type: 'object'
      properties:
        interim_award:
          type: 'string'
        amount:
          type: 'number'
          default: 0.00
        award_justifications:
          type: 'string'
        order_served_date:
          type: 'string'
          format: 'date'
        statutory_charge_exempt_reason:
          type: 'string'
        other_details:
          type: 'string'
        address_line_1:
          type: 'string'
        address_line_2:
          type: 'string'
        address_line_3:
          type: 'string'
        recovery:
          $ref: "#/components/schemas/recoveryDetail"
    landAwardDetail:
      allOf:
        - $ref: '#/components/schemas/baseAwardDetail'
      type: 'object'
      properties:
        description:
          type: 'string'
        title_number:
          type: 'string'
        valuation_amount:
          type: 'number'
          default: 0.00
        valuation_criteria:
          type: 'string'
        valuation_date:
          type: 'string'
          format: 'date'
        disputed_percentage:
          type: 'number'
          default: 0.00
        awarded_percentage:
          type: 'number'
          default: 0.00
        mortgage_amount_due:
          type: 'number'
          default: 0.00
        equity:
          type: 'number'
          default: 0.00
        recovery:
          type: 'string'
        no_recovery_details:
          type: 'string'
        statutory_charge_exempt_reason:
          type: 'string'
        land_charge_registration:
          type: 'string'
        registration_reference:
          type: 'string'
        recovery_of_award_time_related:
          type: 'boolean'
        address_line_1:
          type: 'string'
        address_line_2:
          type: 'string'
        address_line_3:
          type: 'string'
        time_recovery:
          $ref: "#/components/schemas/timeRecoveryDetail"
    otherAssetAwardDetail:
      allOf:
        - $ref: '#/components/schemas/baseAwardDetail'
      type: 'object'
      properties:
        description:
          type: 'string'
        valuation_amount:
          type: 'number'
          default: 0.00
        valuation_criteria:
          type: 'string'
        valuation_date:
          type: 'string'
          format: 'date'
        disputed_percentage:
          type: 'number'
        awarded_percentage:
          type: 'number'
        recovered_amount:
          type: 'number'
        disputed_amount:
          type: 'number'
        awarded_amount:
          type: 'number'
        recovered_percentage:
          type: 'number'
        recovery:
          type: 'string'
        no_recovery_details:
          type: 'string'
        statutory_charge_exempt_reason:
          type: 'string'
        recovery_of_award_time_related:
          type: 'boolean'
        time_recovery:
          $ref: "#/components/schemas/timeRecoveryDetail"
    caseOutcomeDetails:
      type: 'object'
      properties:
        content:
          type: 'array'
          default: [ ]
          items:
            $ref: '#/components/schemas/caseOutcomeDetail'
    caseOutcomeDetail:
      type: 'object'
      properties:
        id:
          type: 'integer'
        case_reference_number:
          type: 'string'
        cost_awards:
          type: 'array'
          items:
            $ref: "#/components/schemas/costAwardDetail"
        financial_awards:
          type: 'array'
          items:
            $ref: "#/components/schemas/financialAwardDetail"
        land_awards:
          type: 'array'
          items:
            $ref: "#/components/schemas/landAwardDetail"
        other_asset_awards:
          type: 'array'
          items:
            $ref: "#/components/schemas/otherAssetAwardDetail"
        proceeding_outcomes:
          type: 'array'
          items:
            $ref: "#/components/schemas/proceedingOutcomeDetail"
        opponent_ids:
          type: 'array'
          items:
            type: 'integer'
        pre_certificate_costs:
          type: 'number'
          default: 0.00
        legal_costs:
          type: 'number'
          default: 0.00
        discharge_reason:
          type: 'string'
        discharge_case_ind:
          type: 'boolean'
        client_continue_ind:
          type: 'boolean'
        other_details:
          type: 'string'
        office_code:
          type: 'string'
        unique_file_no:
          type: 'string'
        provider_id:
          type: 'string'
        audit_trail:
          $ref: "#/components/schemas/auditDetail"
    assessmentResult:
      type: object
      properties:
        assessment_id:
          type: 'string'
        default_ind:
          type: 'boolean'
        date:
          type: 'string'
          format: date
        results:
          type: 'array'
          items:
            $ref: '#/components/schemas/opaGoal'
        assessment_details:
          type: 'array'
          items:
            $ref: '#/components/schemas/assessmentScreen'
    opaGoal:
      type: 'object'
      properties:
        attribute:
          type: 'string'
        attribute_value:
          type: 'string'
    assessmentScreen:
      type: 'object'
      properties:
        screen_name:
          type: 'string'
        caption:
          type: 'string'
        entity:
          type: 'array'
          items:
            $ref: '#/components/schemas/opaEntity'
    opaEntity:
      type: 'object'
      properties:
        sequence_number:
          type: 'integer'
        entity_name:
          type: 'string'
        caption:
          type: 'string'
        instances:
          type: 'array'
          items:
            $ref: '#/components/schemas/opaInstance'
    opaInstance:
      type: 'object'
      properties:
        instance_label:
          type: 'string'
        caption:
          type: 'string'
        attributes:
          type: 'array'
          items:
            $ref: '#/components/schemas/opaAttribute'
    opaAttribute:
      type: 'object'
      properties:
        attribute:
          type: 'string'
        caption:
          type: 'string'
        response_type:
          type: 'string'
        response_value:
          type: 'string'
        response_text:
          type: 'string'
        user_defined_ind:
          type: 'boolean'
    applicationDetails:
      allOf:
        - $ref: "#/components/schemas/page"
      type: 'object'
      properties:
        content:
          type: 'array'
          default: []
          items:
            $ref: '#/components/schemas/baseApplicationDetail'
    baseApplicationDetail:
      type: 'object'
      properties:
        id:
          type: 'integer'
        case_reference_number:
          type: 'string'
        category_of_law:
          $ref: "#/components/schemas/stringDisplayValue"
        status:
          $ref: "#/components/schemas/stringDisplayValue"
        client:
          $ref: "#/components/schemas/clientDetail"
        provider_details:
          $ref: "#/components/schemas/applicationProviderDetails"
    applicationDetail:
      allOf:
        - $ref: "#/components/schemas/baseApplicationDetail"
      type: 'object'
      properties:
        relation_to_linked_case:
          type: 'string'
        opponent_applied_for_funding:
          type: 'boolean'
        amendment:
          type: 'boolean'
        means_assessment_amended:
          type: 'boolean'
        merits_assessment_amended:
          type: 'boolean'
        cost_limit:
          $ref: "#/components/schemas/costLimitDetail"
        application_type:
          $ref: "#/components/schemas/applicationType"
        merits_reassessment_required:
            type: 'boolean'
        correspondence_address:
          $ref: "#/components/schemas/addressDetail"
        costs:
          $ref: "#/components/schemas/costStructureDetail"
        proceedings:
          type: 'array'
          items:
            $ref: "#/components/schemas/proceedingDetail"
        lead_proceeding_changed:
          type: 'boolean'
        app_mode:
          type: 'boolean'
          default: true
        award:
          type: 'boolean'
          default: false
        opponent_mode:
          type: 'string'
          default: "application"
        means_assessment_status:
          type: 'string'
        merits_assessment_status:
          type: 'string'
        all_sections_complete:
          type: 'boolean'
        quick_edit_type:
          type: 'string'
        linked_cases:
          type: 'array'
          items:
            $ref: "#/components/schemas/linkedCaseDetail"
        prior_authorities:
          type: 'array'
          items:
            $ref: "#/components/schemas/priorAuthorityDetail"
        opponents:
          type: 'array'
          items:
            $ref: "#/components/schemas/opponentDetail"
        certificate:
          $ref: "#/components/schemas/stringDisplayValue"
        date_created:
          type: 'string'
          format: 'date'
        amendment_proceedings_in_ebs:
          type: 'array'
          items:
            $ref: "#/components/schemas/proceedingDetail"
        available_functions:
          type: 'array'
          items:
            type: 'string'
        case_outcome:
          $ref: "#/components/schemas/caseOutcomeDetail"
        means_assessment:
          $ref: "#/components/schemas/assessmentResult"
        merits_assessment:
          $ref: "#/components/schemas/assessmentResult"
        edit_proceedings_and_costs_allowed:
          type: 'boolean'
          default: true
        lar_scope_flag:
          type: 'boolean'
        submitted:
          type: 'boolean'
        audit_trail:
          $ref: "#/components/schemas/auditDetail"
#      required:
#        - case_reference_number
#        - provider
#        - category_of_law
#        - client
    applicationProviderDetails:
      type: 'object'
      properties:
        provider:
          $ref: "#/components/schemas/intDisplayValue"
        office:
          $ref: "#/components/schemas/intDisplayValue"
        fee_earner:
          $ref: "#/components/schemas/stringDisplayValue"
        supervisor:
          $ref: "#/components/schemas/stringDisplayValue"
        provider_contact:
          $ref: "#/components/schemas/stringDisplayValue"
        provider_case_reference:
          type: 'string'
    notificationAttachmentDetails:
      allOf:
        - $ref: "#/components/schemas/page"
      type: 'object'
      properties:
        content:
          type: 'array'
          default: [ ]
          items:
            $ref: '#/components/schemas/baseNotificationAttachmentDetail'
    baseNotificationAttachmentDetail:
      type: 'object'
      properties:
        id:
          type: 'integer'
        provider_id:
          type: 'string'
        document_type:
          $ref: '#/components/schemas/stringDisplayValue'
        description:
          type: 'string'
        file_name:
          type: 'string'
        send_by:
          type: 'string'
        status:
          type: 'string'
        number:
          type: 'integer'
          format: 'int64'
        notification_reference:
          type: 'string'
        audit_trail:
          $ref: '#/components/schemas/auditDetail'
    notificationAttachmentDetail:
      type: 'object'
      allOf:
        - $ref: "#/components/schemas/baseNotificationAttachmentDetail"
      properties:
        file_data:
          type: 'string'
    evidenceDocumentDetails:
      allOf:
        - $ref: "#/components/schemas/page"
      type: 'object'
      properties:
        content:
          type: 'array'
          default: []
          items:
            $ref: '#/components/schemas/baseEvidenceDocumentDetail'
    baseEvidenceDocumentDetail:
      type: 'object'
      properties:
        id:
          type: 'integer'
        application_or_outcome_id:
          type: 'string'
        case_reference_number:
          type: 'string'
        provider_id:
          type: 'string'
        document_type:
          $ref: '#/components/schemas/stringDisplayValue'
        description:
          type: 'string'
        file_name:
          type: 'string'
        file_extension:
          type: 'string'
        evidence_descriptions:
          type: 'string'
        registered_document_id:
          type: 'string'
        notification_reference:
          type: 'string'
        transfer_retry_count:
          type: 'integer'
        transfer_response_code:
          type: 'string'
        transfer_response_description:
          type: 'string'
        transfer_status:
          type: 'string'
        document_sender:
          type: 'string'
        ccms_module:
          type: 'string'
        audit_trail:
          $ref: '#/components/schemas/auditDetail'
    evidenceDocumentDetail:
      type: 'object'
      allOf:
        - $ref: "#/components/schemas/baseEvidenceDocumentDetail"
      properties:
        file_data:
          type: 'string'
    auditDetail:
      type: 'object'
      properties:
        created:
          type: 'string'
          format: 'date'
        created_by:
          type: 'string'
        last_saved:
          type: 'string'
          format: 'date'
        last_saved_by:
          type: 'string'
    page:
      type: 'object'
      properties:
        total_pages:
          type: 'integer'
        total_elements:
          type: 'integer'
        number:
          type: 'integer'
        size:
          type: 'integer'

security:
  - ApiKeyAuth: []