GET v1/edi-benefits/export/clients/{clientCode}/enrollments
Retrieve EDI Benefit Enrollments
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
clientCode | string |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of EDIEnrollmentDTOName | Description | Type | Additional information |
---|---|---|---|
SSN | string |
None. |
|
BenefitEnrollmentType | BenefitEnrollmentType |
None. |
|
BenefitPlanType | BenefitPlanType |
None. |
|
PayFrequencyAnnualFactor | decimal number |
None. |
|
ClientKey | GlobalEntityKeyOfISBClient |
None. |
|
EmployeeContribution | decimal number |
None. |
|
EmployerDeduction | decimal number |
None. |
|
BenefitProviderId | EntityKeyOfISBBenefitProviderAndInt32 |
None. |
|
BenefitProviderName | string |
None. |
|
BenefitProviderDescription | string |
None. |
|
BenefitPlanId | GlobalEntityKeyOfIClientBenefitPlan |
None. |
|
BenefitPlanName | string |
None. |
|
BenefitPlanDescription | string |
None. |
|
BenefitPlanStartDate | date |
None. |
|
BenefitPlanEndDate | date |
None. |
|
CoverageLevel | CoverageLevel |
None. |
|
EnrollmentSignatureDate | date |
None. |
|
EligibilityDate | date |
None. |
|
AnnualElectionAmount | decimal number |
None. |
|
DependentEnrollments | Collection of EDIDependentEnrollmentDTO |
None. |
|
BenefitEnrollmentReasonType | BenefitEnrollmentReasonType |
None. |
|
BenefitEnrollmentReasonCode | string |
None. |
|
IsDiscontinued | boolean |
None. |
|
StartDate | date |
None. |
|
EndDate | date |
None. |
Response Formats
application/json, text/json
Sample:
[ { "ssn": "sample string 1", "benefitEnrollmentType": "Enrollment", "benefitPlanType": "Other", "payFrequencyAnnualFactor": 2.0, "clientKey": "<empty>", "employeeContribution": 1.0, "employerDeduction": 1.0, "benefitProviderId": "<empty>", "benefitProviderName": "sample string 3", "benefitProviderDescription": "sample string 4", "benefitPlanId": "<empty>", "benefitPlanName": "sample string 5", "benefitPlanDescription": "sample string 6", "benefitPlanStartDate": "0001-02-03", "benefitPlanEndDate": "0001-02-03", "coverageLevel": "EmployeeOnly", "enrollmentSignatureDate": "0001-02-03", "eligibilityDate": "0001-02-03", "annualElectionAmount": 1.0, "dependentEnrollments": [ { "dependentKey": "<empty>", "relationship": "Other", "ssn": "sample string 1", "lastName": "sample string 2", "firstName": "sample string 3", "middleInitial": "sample string 4", "gender": "Male", "birthDate": "0001-02-03", "address": { "address1": "sample string 1", "address2": "sample string 2", "city": "sample string 3", "state": "sample string 4", "zip": "sample string 5", "country": "sample string 6", "county": "sample string 7" }, "phone": "sample string 5", "isSmoker": true, "isDisabled": true, "isStudent": true, "eligibilityDate": "0001-02-03", "startDate": "0001-02-03", "endDate": "0001-02-03" }, { "dependentKey": "<empty>", "relationship": "Other", "ssn": "sample string 1", "lastName": "sample string 2", "firstName": "sample string 3", "middleInitial": "sample string 4", "gender": "Male", "birthDate": "0001-02-03", "address": { "address1": "sample string 1", "address2": "sample string 2", "city": "sample string 3", "state": "sample string 4", "zip": "sample string 5", "country": "sample string 6", "county": "sample string 7" }, "phone": "sample string 5", "isSmoker": true, "isDisabled": true, "isStudent": true, "eligibilityDate": "0001-02-03", "startDate": "0001-02-03", "endDate": "0001-02-03" } ], "benefitEnrollmentReasonType": "OpenEnrollment", "benefitEnrollmentReasonCode": "sample string 7", "isDiscontinued": true, "startDate": "0001-02-03", "endDate": "0001-02-03" }, { "ssn": "sample string 1", "benefitEnrollmentType": "Enrollment", "benefitPlanType": "Other", "payFrequencyAnnualFactor": 2.0, "clientKey": "<empty>", "employeeContribution": 1.0, "employerDeduction": 1.0, "benefitProviderId": "<empty>", "benefitProviderName": "sample string 3", "benefitProviderDescription": "sample string 4", "benefitPlanId": "<empty>", "benefitPlanName": "sample string 5", "benefitPlanDescription": "sample string 6", "benefitPlanStartDate": "0001-02-03", "benefitPlanEndDate": "0001-02-03", "coverageLevel": "EmployeeOnly", "enrollmentSignatureDate": "0001-02-03", "eligibilityDate": "0001-02-03", "annualElectionAmount": 1.0, "dependentEnrollments": [ { "dependentKey": "<empty>", "relationship": "Other", "ssn": "sample string 1", "lastName": "sample string 2", "firstName": "sample string 3", "middleInitial": "sample string 4", "gender": "Male", "birthDate": "0001-02-03", "address": { "address1": "sample string 1", "address2": "sample string 2", "city": "sample string 3", "state": "sample string 4", "zip": "sample string 5", "country": "sample string 6", "county": "sample string 7" }, "phone": "sample string 5", "isSmoker": true, "isDisabled": true, "isStudent": true, "eligibilityDate": "0001-02-03", "startDate": "0001-02-03", "endDate": "0001-02-03" }, { "dependentKey": "<empty>", "relationship": "Other", "ssn": "sample string 1", "lastName": "sample string 2", "firstName": "sample string 3", "middleInitial": "sample string 4", "gender": "Male", "birthDate": "0001-02-03", "address": { "address1": "sample string 1", "address2": "sample string 2", "city": "sample string 3", "state": "sample string 4", "zip": "sample string 5", "country": "sample string 6", "county": "sample string 7" }, "phone": "sample string 5", "isSmoker": true, "isDisabled": true, "isStudent": true, "eligibilityDate": "0001-02-03", "startDate": "0001-02-03", "endDate": "0001-02-03" } ], "benefitEnrollmentReasonType": "OpenEnrollment", "benefitEnrollmentReasonCode": "sample string 7", "isDiscontinued": true, "startDate": "0001-02-03", "endDate": "0001-02-03" } ]
text/xml
Sample:
<ArrayOfEDIEnrollmentDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models"> <EDIEnrollmentDTO> <AnnualElectionAmount>1</AnnualElectionAmount> <BenefitEnrollmentReasonCode>sample string 7</BenefitEnrollmentReasonCode> <BenefitEnrollmentReasonType>OpenEnrollment</BenefitEnrollmentReasonType> <BenefitEnrollmentType>Enrollment</BenefitEnrollmentType> <BenefitPlanDescription>sample string 6</BenefitPlanDescription> <BenefitPlanEndDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates"> <d3p1:Year>1</d3p1:Year> <d3p1:Month>2</d3p1:Month> <d3p1:Day>3</d3p1:Day> </BenefitPlanEndDate> <BenefitPlanId xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys"> <d3p1:_entityKey> <d3p1:_hasValue>false</d3p1:_hasValue> <d3p1:_value>00000000-0000-0000-0000-000000000000</d3p1:_value> </d3p1:_entityKey> </BenefitPlanId> <BenefitPlanName>sample string 5</BenefitPlanName> <BenefitPlanStartDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates"> <d3p1:Year>1</d3p1:Year> <d3p1:Month>2</d3p1:Month> <d3p1:Day>3</d3p1:Day> </BenefitPlanStartDate> <BenefitPlanType>Other</BenefitPlanType> <BenefitProviderDescription>sample string 4</BenefitProviderDescription> <BenefitProviderId xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys"> <d3p1:_hasValue>false</d3p1:_hasValue> <d3p1:_value>0</d3p1:_value> </BenefitProviderId> <BenefitProviderName>sample string 3</BenefitProviderName> <ClientKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys"> <d3p1:_entityKey> <d3p1:_hasValue>false</d3p1:_hasValue> <d3p1:_value>00000000-0000-0000-0000-000000000000</d3p1:_value> </d3p1:_entityKey> </ClientKey> <CoverageLevel>EmployeeOnly</CoverageLevel> <DependentEnrollments> <EDIDependentEnrollmentDTO> <Address xmlns:d5p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models"> <d5p1:Address1>sample string 1</d5p1:Address1> <d5p1:Address2>sample string 2</d5p1:Address2> <d5p1:City>sample string 3</d5p1:City> <d5p1:Country>sample string 6</d5p1:Country> <d5p1:County>sample string 7</d5p1:County> <d5p1:State>sample string 4</d5p1:State> <d5p1:Zip>sample string 5</d5p1:Zip> </Address> <BirthDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates"> <d5p1:Year>1</d5p1:Year> <d5p1:Month>2</d5p1:Month> <d5p1:Day>3</d5p1:Day> </BirthDate> <DependentKey xmlns:d5p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys"> <d5p1:_entityKey> <d5p1:_hasValue>false</d5p1:_hasValue> <d5p1:_value>00000000-0000-0000-0000-000000000000</d5p1:_value> </d5p1:_entityKey> </DependentKey> <EligibilityDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates"> <d5p1:Year>1</d5p1:Year> <d5p1:Month>2</d5p1:Month> <d5p1:Day>3</d5p1:Day> </EligibilityDate> <EndDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates"> <d5p1:Year>1</d5p1:Year> <d5p1:Month>2</d5p1:Month> <d5p1:Day>3</d5p1:Day> </EndDate> <FirstName>sample string 3</FirstName> <Gender>Male</Gender> <IsDisabled>true</IsDisabled> <IsSmoker>true</IsSmoker> <IsStudent>true</IsStudent> <LastName>sample string 2</LastName> <MiddleInitial>sample string 4</MiddleInitial> <Phone>sample string 5</Phone> <Relationship>Other</Relationship> <SSN>sample string 1</SSN> <StartDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates"> <d5p1:Year>1</d5p1:Year> <d5p1:Month>2</d5p1:Month> <d5p1:Day>3</d5p1:Day> </StartDate> </EDIDependentEnrollmentDTO> <EDIDependentEnrollmentDTO> <Address xmlns:d5p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models"> <d5p1:Address1>sample string 1</d5p1:Address1> <d5p1:Address2>sample string 2</d5p1:Address2> <d5p1:City>sample string 3</d5p1:City> <d5p1:Country>sample string 6</d5p1:Country> <d5p1:County>sample string 7</d5p1:County> <d5p1:State>sample string 4</d5p1:State> <d5p1:Zip>sample string 5</d5p1:Zip> </Address> <BirthDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates"> <d5p1:Year>1</d5p1:Year> <d5p1:Month>2</d5p1:Month> <d5p1:Day>3</d5p1:Day> </BirthDate> <DependentKey xmlns:d5p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys"> <d5p1:_entityKey> <d5p1:_hasValue>false</d5p1:_hasValue> <d5p1:_value>00000000-0000-0000-0000-000000000000</d5p1:_value> </d5p1:_entityKey> </DependentKey> <EligibilityDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates"> <d5p1:Year>1</d5p1:Year> <d5p1:Month>2</d5p1:Month> <d5p1:Day>3</d5p1:Day> </EligibilityDate> <EndDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates"> <d5p1:Year>1</d5p1:Year> <d5p1:Month>2</d5p1:Month> <d5p1:Day>3</d5p1:Day> </EndDate> <FirstName>sample string 3</FirstName> <Gender>Male</Gender> <IsDisabled>true</IsDisabled> <IsSmoker>true</IsSmoker> <IsStudent>true</IsStudent> <LastName>sample string 2</LastName> <MiddleInitial>sample string 4</MiddleInitial> <Phone>sample string 5</Phone> <Relationship>Other</Relationship> <SSN>sample string 1</SSN> <StartDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates"> <d5p1:Year>1</d5p1:Year> <d5p1:Month>2</d5p1:Month> <d5p1:Day>3</d5p1:Day> </StartDate> </EDIDependentEnrollmentDTO> </DependentEnrollments> <EligibilityDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates"> <d3p1:Year>1</d3p1:Year> <d3p1:Month>2</d3p1:Month> <d3p1:Day>3</d3p1:Day> </EligibilityDate> <EmployeeContribution>1</EmployeeContribution> <EmployerDeduction>1</EmployerDeduction> <EndDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates"> <d3p1:Year>1</d3p1:Year> <d3p1:Month>2</d3p1:Month> <d3p1:Day>3</d3p1:Day> </EndDate> <EnrollmentSignatureDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates"> <d3p1:Year>1</d3p1:Year> <d3p1:Month>2</d3p1:Month> <d3p1:Day>3</d3p1:Day> </EnrollmentSignatureDate> <IsDiscontinued>true</IsDiscontinued> <PayFrequencyAnnualFactor>2</PayFrequencyAnnualFactor> <SSN>sample string 1</SSN> <StartDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates"> <d3p1:Year>1</d3p1:Year> <d3p1:Month>2</d3p1:Month> <d3p1:Day>3</d3p1:Day> </StartDate> </EDIEnrollmentDTO> <EDIEnrollmentDTO> <AnnualElectionAmount>1</AnnualElectionAmount> <BenefitEnrollmentReasonCode>sample string 7</BenefitEnrollmentReasonCode> <BenefitEnrollmentReasonType>OpenEnrollment</BenefitEnrollmentReasonType> <BenefitEnrollmentType>Enrollment</BenefitEnrollmentType> <BenefitPlanDescription>sample string 6</BenefitPlanDescription> <BenefitPlanEndDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates"> <d3p1:Year>1</d3p1:Year> <d3p1:Month>2</d3p1:Month> <d3p1:Day>3</d3p1:Day> </BenefitPlanEndDate> <BenefitPlanId xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys"> <d3p1:_entityKey> <d3p1:_hasValue>false</d3p1:_hasValue> <d3p1:_value>00000000-0000-0000-0000-000000000000</d3p1:_value> </d3p1:_entityKey> </BenefitPlanId> <BenefitPlanName>sample string 5</BenefitPlanName> <BenefitPlanStartDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates"> <d3p1:Year>1</d3p1:Year> <d3p1:Month>2</d3p1:Month> <d3p1:Day>3</d3p1:Day> </BenefitPlanStartDate> <BenefitPlanType>Other</BenefitPlanType> <BenefitProviderDescription>sample string 4</BenefitProviderDescription> <BenefitProviderId xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys"> <d3p1:_hasValue>false</d3p1:_hasValue> <d3p1:_value>0</d3p1:_value> </BenefitProviderId> <BenefitProviderName>sample string 3</BenefitProviderName> <ClientKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys"> <d3p1:_entityKey> <d3p1:_hasValue>false</d3p1:_hasValue> <d3p1:_value>00000000-0000-0000-0000-000000000000</d3p1:_value> </d3p1:_entityKey> </ClientKey> <CoverageLevel>EmployeeOnly</CoverageLevel> <DependentEnrollments> <EDIDependentEnrollmentDTO> <Address xmlns:d5p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models"> <d5p1:Address1>sample string 1</d5p1:Address1> <d5p1:Address2>sample string 2</d5p1:Address2> <d5p1:City>sample string 3</d5p1:City> <d5p1:Country>sample string 6</d5p1:Country> <d5p1:County>sample string 7</d5p1:County> <d5p1:State>sample string 4</d5p1:State> <d5p1:Zip>sample string 5</d5p1:Zip> </Address> <BirthDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates"> <d5p1:Year>1</d5p1:Year> <d5p1:Month>2</d5p1:Month> <d5p1:Day>3</d5p1:Day> </BirthDate> <DependentKey xmlns:d5p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys"> <d5p1:_entityKey> <d5p1:_hasValue>false</d5p1:_hasValue> <d5p1:_value>00000000-0000-0000-0000-000000000000</d5p1:_value> </d5p1:_entityKey> </DependentKey> <EligibilityDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates"> <d5p1:Year>1</d5p1:Year> <d5p1:Month>2</d5p1:Month> <d5p1:Day>3</d5p1:Day> </EligibilityDate> <EndDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates"> <d5p1:Year>1</d5p1:Year> <d5p1:Month>2</d5p1:Month> <d5p1:Day>3</d5p1:Day> </EndDate> <FirstName>sample string 3</FirstName> <Gender>Male</Gender> <IsDisabled>true</IsDisabled> <IsSmoker>true</IsSmoker> <IsStudent>true</IsStudent> <LastName>sample string 2</LastName> <MiddleInitial>sample string 4</MiddleInitial> <Phone>sample string 5</Phone> <Relationship>Other</Relationship> <SSN>sample string 1</SSN> <StartDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates"> <d5p1:Year>1</d5p1:Year> <d5p1:Month>2</d5p1:Month> <d5p1:Day>3</d5p1:Day> </StartDate> </EDIDependentEnrollmentDTO> <EDIDependentEnrollmentDTO> <Address xmlns:d5p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models"> <d5p1:Address1>sample string 1</d5p1:Address1> <d5p1:Address2>sample string 2</d5p1:Address2> <d5p1:City>sample string 3</d5p1:City> <d5p1:Country>sample string 6</d5p1:Country> <d5p1:County>sample string 7</d5p1:County> <d5p1:State>sample string 4</d5p1:State> <d5p1:Zip>sample string 5</d5p1:Zip> </Address> <BirthDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates"> <d5p1:Year>1</d5p1:Year> <d5p1:Month>2</d5p1:Month> <d5p1:Day>3</d5p1:Day> </BirthDate> <DependentKey xmlns:d5p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys"> <d5p1:_entityKey> <d5p1:_hasValue>false</d5p1:_hasValue> <d5p1:_value>00000000-0000-0000-0000-000000000000</d5p1:_value> </d5p1:_entityKey> </DependentKey> <EligibilityDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates"> <d5p1:Year>1</d5p1:Year> <d5p1:Month>2</d5p1:Month> <d5p1:Day>3</d5p1:Day> </EligibilityDate> <EndDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates"> <d5p1:Year>1</d5p1:Year> <d5p1:Month>2</d5p1:Month> <d5p1:Day>3</d5p1:Day> </EndDate> <FirstName>sample string 3</FirstName> <Gender>Male</Gender> <IsDisabled>true</IsDisabled> <IsSmoker>true</IsSmoker> <IsStudent>true</IsStudent> <LastName>sample string 2</LastName> <MiddleInitial>sample string 4</MiddleInitial> <Phone>sample string 5</Phone> <Relationship>Other</Relationship> <SSN>sample string 1</SSN> <StartDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates"> <d5p1:Year>1</d5p1:Year> <d5p1:Month>2</d5p1:Month> <d5p1:Day>3</d5p1:Day> </StartDate> </EDIDependentEnrollmentDTO> </DependentEnrollments> <EligibilityDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates"> <d3p1:Year>1</d3p1:Year> <d3p1:Month>2</d3p1:Month> <d3p1:Day>3</d3p1:Day> </EligibilityDate> <EmployeeContribution>1</EmployeeContribution> <EmployerDeduction>1</EmployerDeduction> <EndDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates"> <d3p1:Year>1</d3p1:Year> <d3p1:Month>2</d3p1:Month> <d3p1:Day>3</d3p1:Day> </EndDate> <EnrollmentSignatureDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates"> <d3p1:Year>1</d3p1:Year> <d3p1:Month>2</d3p1:Month> <d3p1:Day>3</d3p1:Day> </EnrollmentSignatureDate> <IsDiscontinued>true</IsDiscontinued> <PayFrequencyAnnualFactor>2</PayFrequencyAnnualFactor> <SSN>sample string 1</SSN> <StartDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates"> <d3p1:Year>1</d3p1:Year> <d3p1:Month>2</d3p1:Month> <d3p1:Day>3</d3p1:Day> </StartDate> </EDIEnrollmentDTO> </ArrayOfEDIEnrollmentDTO>