Treatment Management

This guide will walk you through the entire suite of Treatment Management APIs.

​

Headers

Name	Type	Description
x-api-key	String	A string API key that is issued to each project or company that uses Auxia. This API key should have permission to call this API. This should be set in the header.

​

Status Codes

1. 200: OK.
2. 400: Invalid Request. Please ensure you review the error details and modify your request accordingly.
3. 403: Unauthorized Please ensure you have added the correct API key, projectId, and any other parameters in the request.

​

1) Insert/Update Treatment

Auxia allows clients to insert or update treatments via APIs. For more info, please click the link here.

​

2) Insert/Update Treatment Type

Auxia allows clients to insert or update treatment types via APIs. For more info, please click the link here.

​

3) Get DataFields

Auxia allows clients to get DataFields via APIs. For more info, please click the link here.

​

4) Get All Treatments

Auxia allows clients to retrieve all treatments for a project with filtering options. For more info, please click the link here.

​

5) Get Treatment

Auxia allows clients to retrieve a single treatment by its treatment ID. For more info, please click the link here.

​

6) Insert DataField

Auxia allows clients to register a DataField via API. For more info, please click the link here.

​

7) Insert Surface

Auxia allows clients to register a Surface via API. For more info, please click the link here.