Program Enrollments: Required Attributes and Path Parameters
This section lists the required attributes and path parameters for the request payloads of the Program Enrollments resource and its child resources.
The following table shows the relation between the parent resource and its child resources.
|
Parent Level |
Program Enrollments |
|
Child Resources |
PartnerProgram |
|
ProgramBenefitDetails |
|
|
Notes |
The following table lists the attributes required for the POST method for Program Enrollments resource.
| Resource | Attribute | Attribute Description |
|---|---|---|
|
Program Enrollments |
PartnerProgramId |
The unique identifier of a partner program. |
|
PartnerPartyId |
The unique identifier of a partner. |
The following table lists the attributes required for the POST method for Program Enrollment child resources.
| Resource | Attribute | Attribute Description |
|---|---|---|
|
Program Enrollments > Partner Program |
The Partner Program Child resource does not support Post and Patch. |
The Partner Program Child resource does not support Post and Patch. |
|
Program Enrollments > Program Benefit Details |
The Partner Program Child resource does not support Post and Patch. |
The Partner Program Child resource does not support Post and Patch. |
|
Program Enrollments > Notes |
NoteTxt |
The actual note text. |
|
NoteTypeCode |
This code for categorization of the note type. The list of values for note type codes is available in the NoteSourceTypeVA. |
The following table lists the path parameters required for the PATCH method for Program Enrollments resource.
| Resource | Path | Path Parameters |
|---|---|---|
|
Program Enrollments |
/crmRestApi/resources/11.13.18.10/programEnrollments/ {EnrollmentNumber} |
EnrollmentNumber |
The following table lists the path parameters required for the PATCH method for Program Enrollments child resources.
| Resource | Path | Path Parameters |
|---|---|---|
|
Program Enrollments > Partner Program |
The Partner Program child resource supports only GET action. |
The Partner Program child resource supports only GET action. |
|
Program Enrollments > Program Benefit Details |
The Program Benefit Details child resource supports only GET action. |
The Program Benefit Details child resource supports only GET action. |
|
Program Enrollments > Notes |
/crmRestApi/resources/11.13.18.10/programEnrollments /{ProgramEnrollment}/child/Notes |
ProgramEnrollment |