openapi: 3.2.0
info:
  title: Audatex Get Documents API
  description: Retrieve documents from the Audatex system.
  contact:
    name: Audatex
    url: http://www.audatex.us/product.asp?pageid=zContact_us
  license:
    name: '@Audatex North America, Inc. All rights reserved'
    url: http://www.audatex.us/
  version: '1.0'
servers:
- url: /GetDocuments
security:
- oauth2:
  - readAccess
  - writeAccess
tags:
- name: GetDocuments
paths:
  /api/v{version}/GetDocument:
    get:
      tags:
      - GetDocuments
      parameters:
      - name: id
        in: query
        schema:
          type: string
      - name: version
        in: path
        description: The requested API version
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DocumentResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/DocumentResponse'
  /api/v{version}/claims/{assignmentId}/document/{locator}:
    get:
      tags:
      - GetDocuments
      parameters:
      - name: assignmentId
        in: path
        required: true
        schema:
          type: string
      - name: locator
        in: path
        required: true
        schema:
          type: string
      - name: version
        in: path
        description: The requested API version
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
components:
  schemas:
    DocumentResponseBody:
      type: object
      properties:
        claimNumber:
          type:
          - string
          - 'null'
        createdForProfileId:
          type:
          - string
          - 'null'
        imageId:
          type:
          - string
          - 'null'
        attachmentId:
          type:
          - string
          - 'null'
        requestNbr:
          type:
          - string
          - 'null'
        extension:
          type:
          - string
          - 'null'
        payload:
          type:
          - string
          - 'null'
        dataType:
          type:
          - string
          - 'null'
      additionalProperties: false
    DocumentResponseHeader:
      type: object
      properties:
        cid:
          type:
          - string
          - 'null'
        statusCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    DocumentResponse:
      type: object
      properties:
        header:
          $ref: '#/components/schemas/DocumentResponseHeader'
        body:
          $ref: '#/components/schemas/DocumentResponseBody'
      additionalProperties: false
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        password:
          tokenUrl: https://dispatch-login-demo.audatex.com/connect/token
          scopes:
            b2b.fnol.documents: Audatex Assignment API Access