Authorization Access

Create Authorization Access

Create a new authorization access record.

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

If there is an existing data match for the new authorization access 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/access?authnumber=[authnumber]

{
    "idtype": "",
    "providerid": "",
    "role": ""
}

Sample Response Format


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

Update Authorization Access
Update an authorization access record.  
This is a sparse update; only fields being changed need to be included.  
The lookup keys for the authorization access record to update are included in the query parameters, authnumber, idtype, and providerid.
Sample Request Format

PATCH [base URL]/authorization/access?authnumber=[authnumber]&idtype=[idtype]&providerid=[providerid]
{
    "role": ""
}
Sample Response Format

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

Delete Authorization Access
Delete an authorization access record.
The lookup keys for the authorization access record to delete are included in the query parameters, authnumber, idtype, and providerid.
Sample Request Format

DELETE [base URL]/authorization/access?authnumber=[authnumber]&idtype=[idtype]&providerid=[providerid]
Sample Response Format

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