Import Specifications

The Import Specification API will allow the athena’s customer and partner to download specification for an import type. This feature also allows the user to check the status of existing specification download request. 

POST   /v1/{practiceid}/import/downloadspecification performs the following actions:

  1. Creates a downloadspecificaiton request based on the input parameters. 
  2. Acknowledges the downloadspecification request. 
  3. Requests will be processed asynchronously. 
  4. Post processing, the specification files will be uploaded in the destination path. 
  5. Finally manifest.json file will be uploaded in the specified destination path. manifest.json will have information related to the request. 
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit

Download import type specification

POST
/v1/{practiceid}/import/downloadspecification
Generates import type specification and upload the specification to destination path
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
Content-Type string Content type of the payload

Output Parameters

Expand all
details array Results for each import type request
message string Request acknowledgement
requestid integer Request ID of the download request
status string Status of the API request. It could be SUCCESS or FAILURE or PARTIAL SUCCESS
Example Code

Get the status for the download specification request

GET
/v1/{practiceid}/import/downloadspecification/{requestid}/status
Retrieves the present status of the download specification request
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
requestid integer requestid

Output Parameters

Expand all
details array Each import type detail.
message string Error message (if any).
status string Whether the operation was successful.
Example Code