Authorization Lines

Create Authorization Line

Create a new authorization line record with associated access records.

The authorization line data is specified in the body of the request. The data is a JSON object conforming to the DI file specification for authorization lines and access records accordingly.  All field names must be lowercase.

If there is an existing data match for the new authorization line record, the record is not created. When the call is accepted it returns an operations URL that the requesting client uses to track the status of the request.

The lookup keys for the authorization record to update are included in the query parameters, authnumber.

Sample Request Format

Required key fields are highlighted.
POST [base URL]/authorization/line?authnumber=[authnumber]
{
    "authlinenumber": "",
"authtype": "",
"authdecision": "",
"access":
[
{
"idtype": "",
"providerid": "",
"role": ""
}
]
}

Sample Response Format


HTTP/1.1 202 Accepted
Operation-Location: [base URL]/operation/[operationId]
 

Update Authorization Line
Update an authorization line record with associated access records.  
This is a sparse update; only fields being changed need to be included.  
The lookup keys for the authorization line record to update are included in the query parameters, authnumber and authlinenumber.
Any child records being updated (accesses) must include a "record_action" field with the action being taken on them (n - new, m - modify, d - delete).
Child records must also include the appropriate necessary keys.

Sample Request Format

Required key fields are highlighted.
PATCH [base URL]/authorization/line?authnumber=[authnumber]&authlinenumber=[authlinenumber]
{
    "authtype": "",
"authdecision": "",
"access":
[
{
"record_action": "n",
            "idtype": "",
"providerid": "",
"role": "",
}
]
}


Sample Response Format


HTTP/1.1 202 Accepted
Operation-Location: [base URL]/operation/[operationId]

Delete Authorization Line
Delete an authorization line record and all associated child records (access records).
The lookup keys for the authorization line record to delete are included in the query parameters, authnumber and authlinenumber.

Sample Request Format


DELETE [base URL]/authorization/line?authnumber=[authnumber]&authlinenumber=[authlinenumber]

Sample Response Format


HTTP/1.1 202 Accepted
Operation-Location: [base URL]/operation/[operationId]
Comments