{
  "openapi": "3.0.1",
  "info": {
    "title": "Audatex GetDocuments 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"
    }
  ],
  "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"
          }
        }
      }
    },
    "/api/v{version}/GetValuation": {
      "get": {
        "tags": [
          "GetValuation"
        ],
        "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/ValuationResponse"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValuationResponse"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValuationResponse"
                }
              }
            }
          }
        }
      }
    },
    "/api/Version": {
      "get": {
        "tags": [
          "Version"
        ],
        "parameters": [
          {
            "name": "api-version",
            "in": "query",
            "description": "The requested API version",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "DocumentResponse": {
        "type": "object",
        "properties": {
          "header": {
            "$ref": "#/components/schemas/DocumentResponseHeader"
          },
          "body": {
            "$ref": "#/components/schemas/DocumentResponseBody"
          }
        },
        "additionalProperties": false
      },
      "DocumentResponseBody": {
        "type": "object",
        "properties": {
          "claimNumber": {
            "type": "string",
            "nullable": true
          },
          "createdForProfileId": {
            "type": "string",
            "nullable": true
          },
          "imageId": {
            "type": "string",
            "nullable": true
          },
          "attachmentId": {
            "type": "string",
            "nullable": true
          },
          "requestNbr": {
            "type": "string",
            "nullable": true
          },
          "extension": {
            "type": "string",
            "nullable": true
          },
          "payload": {
            "type": "string",
            "nullable": true
          },
          "dataType": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "DocumentResponseHeader": {
        "type": "object",
        "properties": {
          "cid": {
            "type": "string",
            "nullable": true
          },
          "statusCode": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "ValuationResponse": {
        "type": "object",
        "properties": {
          "header": {
            "$ref": "#/components/schemas/ValuationResponseHeader"
          },
          "body": {
            "$ref": "#/components/schemas/ValuationResponseBody"
          }
        },
        "additionalProperties": false
      },
      "ValuationResponseBody": {
        "type": "object",
        "properties": {
          "claimNumber": {
            "type": "string",
            "nullable": true
          },
          "payload": {
            "type": "string",
            "nullable": true
          },
          "dataType": {
            "type": "string",
            "nullable": true
          },
          "extension": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "ValuationResponseHeader": {
        "type": "object",
        "properties": {
          "cid": {
            "type": "string",
            "nullable": true
          },
          "statusCode": {
            "type": "string",
            "nullable": true
          }
        },
        "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"
            }
          }
        }
      }
    }
  },
  "security": [
    {
      "oauth2": [
        "readAccess",
        "writeAccess"
      ]
    }
  ]
}