Enrollment API v1
/rxcdi/api/v1/enrollment
Before You Start
Please enroll with Engagedmedia
Limitations
- Must have valid Client credentials
- Must have valid medication code
- Must have valid trigger
Parameters
| Key | Desc. | |
|---|---|---|
| Auth | Username | ***** |
| Password | ***** | |
| Authorization | Basic | |
| Required | trigger | |
| medCode | Program ID | |
| Optional | memberID | The patient’s member ID |
| memberIDAlt | ||
| groupNumber | The patient’s group number | |
| groupNumberAlt | ||
| mobileID | Valid 10-digit mobile number | |
| msgClass | ||
| enrollment | ||
| subMedCode | ||
| careGiver | ||
| dosage | ||
| engLevel | ||
| govEnroll | ||
| firstName | ||
| lastName | ||
| gender | ||
| optional1 | Flexible optional parameter | |
| optional2 | Flexible optional parameter | |
| optional3 | Flexible optional parameter | |
| optional4 | Flexible optional parameter | |
| optional5 | Flexible optional parameter | |
| optional6 | Flexible optional parameter | |
| optional7 | Flexible optional parameter | |
| optional8 | Flexible optional parameter | |
| optional9 | Flexible optional parameter |
Request Sample
PUT /rxcdi/api/v1/enrollment HTTP/1.1
Host: https://engagedmedia.com:8443
Authorization: Basic LkeweuNOIh3uNLi=
Content-Type: application/json
{
"medCode": "XYZ",
"mobileID": "5556667777",
"trigger": "XYZweb4a",
"memberID": "1234567890",
"groupNumber": "ABC123456"
}
Response Sample
HTTP/1.1 200 OK
Content-Type: application/json
{
"medCode": "XYZ",
"mobileID": "5556667777",
"trigger": "XYZweb4a",
"memberID": "1234567890",
"groupNumber": "ABC123456"
}