Menu
Conventions Used on This Site
To make your developer experience a pleasant one, this site utilizes consistent formatting and layouts.
Below are some examples:
Feedback
At RxWare, we are all about receiving feedback from our partners. Located at the bottom of each page is a feedback field where you can tell us how we might improve that page:
Code Formatting
When applicable, code elements will be formatted like this:
"supportProgramId": "{{partners-support-program-id}}"
Endpoints
When using RESTful APIs and Webhooks in conjunction with a valid URL, each API will have the following information at the top of each page:
Example:
ENDPOINT: POST /v1/patients/invite
Curly Braces
Whenever you see something inside of curly braces, this is a variable that needs to be populated with information specific to the specific support program that you’re implementing with RxWare.
Example:
ENDPOINT: POST /v1/patients/{patientId}/event
In this example, the {patientId} is a variable and needs to be populated with a specific patient ID:
ENDPOINT: POST /v1/patients/ha64fdee8cf1e29/event
Tables
All tables on this site include the ability to download to CSV or Excel as well as the ability to perform a search:
Response Codes
When developing against a RESTful API, it’s beneficial to know all the possible responses that one might receive when submitting a call to that API. To that end, this site will always include standard response codes and their corresponding meanings after each JSON example presented.
Example:
| Status | Code | Message | Description |
|---|---|---|---|
200 | N/A | Patient updated successfully | Patient updated successfully |
401 | 0 | Unauthorized | Please verify with RxWare that you are authorized to use the RxWare API. |
400 | 1006 | Patient Not Found | Patient cannot be found in the system. |
400 | 2002 | Invalid Support Program ID | This means that the supportProgramId you provided is invalid.Please check your Support Program ID. |
400 | 1005 | User Previously Unsubscribed | |
403 | 403 | Invalid Token | This means that the bearer token you supplied is not valid for this Support Program. Please verify your credentials. |