Dfs

Dfs 1.0.0

forum Discuss this API in the forum
production
https://api.availity.com/availity

Custom API Endpoint

Paths

/dfs/{id}

get /dfs/{id}

Download a stored file using an encrypted URL.

oauth2
oauth2
(oauth2 application)
Token URL
https://api.availity.com/v1/token
Scopes
hipaa
Realtime - Live HIPAA API
id
Required in path
string

The ecrypted file identifier

Accept
Optional in header
string
application/json
application/xml
application/octet-stream
200

OK

400

Bad Request

ErrorResponse
401

Not Authorized

ErrorResponse
403

Forbidden

ErrorResponse
500

Internal Server Error

ErrorResponse
Example Request
Example Response
GET https://api.availity.com/availity/sdk/v1/dfs/{id}
Try this operation
https://api.availity.com/availity/sdk/v1/dfs/{id}
accept
id

Definitions 

{
    "type": "object",
    "properties": {
        "userMessage": {
            "type": "string",
            "description": "A high level error message."
        },
        "developerMessage": {
            "type": "string",
            "description": "A more technical error message."
        },
        "reasonCode": {
            "type": "integer",
            "description": "A reason code."
        },
        "statusCode": {
            "type": "integer",
            "description": "The status code."
        },
        "errors": {
            "type": "array",
            "description": "A list of detailed user friendly messages.",
            "items": {
                "$ref": "#\/definitions\/FieldError"
            }
        }
    }
}
              
{
    "type": "object",
    "properties": {
        "field": {
            "type": "string",
            "description": "The field or parameter associated with this error."
        },
        "code": {
            "type": "string",
            "description": "A code for the error."
        },
        "errorMessage": {
            "type": "string",
            "description": "The message associated with this error."
        },
        "index": {
            "type": "integer",
            "description": "The array index of the item associated with this error."
        }
    }
}