POST api/{programid}/Consumer/Enrollments

Returns the MCOs the consumer is enrolled to

Request Information

URI Parameters

Name	Description	Type	Additional information
programid	Program Id	string	Required

Body Parameters

List of consumer numbers

ConsumerEnrollmentsParams

Name	Description	Type	Additional information
consumerNos		Collection of string	None.

Request Formats

application/json, text/json

Sample:

{
  "consumerNos": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<ConsumerEnrollmentsParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.WebApi.Models.Consumer">
  <consumerNos xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </consumerNos>
</ConsumerEnrollmentsParams>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ConsumerEnrollmentsParams'.

Response Information

Resource Description

Collection of ConsumerEnrollment

Name	Type	Additional information
EnrollmentId	integer	None.
ConsumerNo	string	None.
StartDate	date	None.
EndDate	date	None.
EnrollmentType	EnrollmentType	None.
Organization	string	None.
SubOrganization	string	None.
ExternalReferenceId	string	None.
FeaId	integer	None.
DisEnrollmentReason	integer	None.
Active	boolean	None.
EnrollmentStatus	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "EnrollmentId": 1,
    "ConsumerNo": "sample string 2",
    "StartDate": "2024-11-16T05:08:25.4687876-05:00",
    "EndDate": "2024-11-16T05:08:25.4687876-05:00",
    "EnrollmentType": 0,
    "Organization": "sample string 5",
    "SubOrganization": "sample string 6",
    "ExternalReferenceId": "sample string 7",
    "FeaId": 8,
    "DisEnrollmentReason": 9,
    "Active": true,
    "EnrollmentStatus": "sample string 11"
  },
  {
    "EnrollmentId": 1,
    "ConsumerNo": "sample string 2",
    "StartDate": "2024-11-16T05:08:25.4687876-05:00",
    "EndDate": "2024-11-16T05:08:25.4687876-05:00",
    "EnrollmentType": 0,
    "Organization": "sample string 5",
    "SubOrganization": "sample string 6",
    "ExternalReferenceId": "sample string 7",
    "FeaId": 8,
    "DisEnrollmentReason": 9,
    "Active": true,
    "EnrollmentStatus": "sample string 11"
  }
]

application/xml, text/xml

Sample:

<ArrayOfConsumerEnrollment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.Models.NavisionData.CommonClasses">
  <ConsumerEnrollment>
    <Active>true</Active>
    <ConsumerNo>sample string 2</ConsumerNo>
    <DisEnrollmentReason>9</DisEnrollmentReason>
    <EndDate>2024-11-16T05:08:25.4687876-05:00</EndDate>
    <EnrollmentId>1</EnrollmentId>
    <EnrollmentStatus>sample string 11</EnrollmentStatus>
    <EnrollmentType>Blank</EnrollmentType>
    <ExternalReferenceId>sample string 7</ExternalReferenceId>
    <FeaId>8</FeaId>
    <Organization>sample string 5</Organization>
    <StartDate>2024-11-16T05:08:25.4687876-05:00</StartDate>
    <SubOrganization>sample string 6</SubOrganization>
  </ConsumerEnrollment>
  <ConsumerEnrollment>
    <Active>true</Active>
    <ConsumerNo>sample string 2</ConsumerNo>
    <DisEnrollmentReason>9</DisEnrollmentReason>
    <EndDate>2024-11-16T05:08:25.4687876-05:00</EndDate>
    <EnrollmentId>1</EnrollmentId>
    <EnrollmentStatus>sample string 11</EnrollmentStatus>
    <EnrollmentType>Blank</EnrollmentType>
    <ExternalReferenceId>sample string 7</ExternalReferenceId>
    <FeaId>8</FeaId>
    <Organization>sample string 5</Organization>
    <StartDate>2024-11-16T05:08:25.4687876-05:00</StartDate>
    <SubOrganization>sample string 6</SubOrganization>
  </ConsumerEnrollment>
</ArrayOfConsumerEnrollment>