GET api/{programid}/Employee/{employeeNo}/ConsumerAssociations
Returns all the records of the [Consumer Employee Assoc_] table filtered by the employee number provided. It includes terminated associations as well, in which case the TerminationDate field won't be null.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
programid |
Program Id |
string |
Required |
employeeNo |
Provider/Employee Id |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
List of consumer employee association records
Collection of ConsumerEmployeeAssociationName | Description | Type | Additional information |
---|---|---|---|
ConsumerNo | string |
None. |
|
ConsumerFirstName | string |
None. |
|
ConsumerLastName | string |
None. |
|
ConsumerFullName | string |
None. |
|
EmployeeNo | string |
None. |
|
EmployeeFirstName | string |
None. |
|
EmployeeMiddleName | string |
None. |
|
EmployeeLastName | string |
None. |
|
EmployeeFullName | string |
None. |
|
EmploymentStatus | string |
None. |
|
TerminationDate | date |
None. |
|
TerminationReason | string |
None. |
|
BeginDate | date |
None. |
|
LineNo | integer |
None. |
|
IsProviderLivesInSamehome | boolean |
None. |
|
Relationship | string |
None. |
|
IsMCO | boolean |
None. |
Response Formats
application/json, text/json
Sample:
[ { "ConsumerNo": "sample string 1", "ConsumerFirstName": "sample string 2", "ConsumerLastName": "sample string 3", "ConsumerFullName": "Sample String 2 Sample String 3", "EmployeeNo": "sample string 4", "EmployeeFirstName": "sample string 5", "EmployeeMiddleName": "sample string 6", "EmployeeLastName": "sample string 7", "EmployeeFullName": "Sample String 5 Sample String 6 Sample String 7", "EmploymentStatus": "sample string 8", "TerminationDate": "2024-11-16T05:08:42.7524325-05:00", "TerminationReason": "sample string 9", "BeginDate": "2024-11-16T05:08:42.7524325-05:00", "LineNo": 11, "IsProviderLivesInSamehome": true, "Relationship": "sample string 13", "IsMCO": true }, { "ConsumerNo": "sample string 1", "ConsumerFirstName": "sample string 2", "ConsumerLastName": "sample string 3", "ConsumerFullName": "Sample String 2 Sample String 3", "EmployeeNo": "sample string 4", "EmployeeFirstName": "sample string 5", "EmployeeMiddleName": "sample string 6", "EmployeeLastName": "sample string 7", "EmployeeFullName": "Sample String 5 Sample String 6 Sample String 7", "EmploymentStatus": "sample string 8", "TerminationDate": "2024-11-16T05:08:42.7524325-05:00", "TerminationReason": "sample string 9", "BeginDate": "2024-11-16T05:08:42.7524325-05:00", "LineNo": 11, "IsProviderLivesInSamehome": true, "Relationship": "sample string 13", "IsMCO": true } ]
application/xml, text/xml
Sample:
<ArrayOfConsumerEmployeeAssociation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.Models.WebAPI_DTO.Common"> <ConsumerEmployeeAssociation> <BeginDate>2024-11-16T05:08:42.7524325-05:00</BeginDate> <ConsumerFirstName>sample string 2</ConsumerFirstName> <ConsumerLastName>sample string 3</ConsumerLastName> <ConsumerNo>sample string 1</ConsumerNo> <EmployeeFirstName>sample string 5</EmployeeFirstName> <EmployeeLastName>sample string 7</EmployeeLastName> <EmployeeMiddleName>sample string 6</EmployeeMiddleName> <EmployeeNo>sample string 4</EmployeeNo> <EmploymentStatus>sample string 8</EmploymentStatus> <IsMCO>true</IsMCO> <IsProviderLivesInSamehome>true</IsProviderLivesInSamehome> <LineNo>11</LineNo> <Relationship>sample string 13</Relationship> <TerminationDate>2024-11-16T05:08:42.7524325-05:00</TerminationDate> <TerminationReason>sample string 9</TerminationReason> </ConsumerEmployeeAssociation> <ConsumerEmployeeAssociation> <BeginDate>2024-11-16T05:08:42.7524325-05:00</BeginDate> <ConsumerFirstName>sample string 2</ConsumerFirstName> <ConsumerLastName>sample string 3</ConsumerLastName> <ConsumerNo>sample string 1</ConsumerNo> <EmployeeFirstName>sample string 5</EmployeeFirstName> <EmployeeLastName>sample string 7</EmployeeLastName> <EmployeeMiddleName>sample string 6</EmployeeMiddleName> <EmployeeNo>sample string 4</EmployeeNo> <EmploymentStatus>sample string 8</EmploymentStatus> <IsMCO>true</IsMCO> <IsProviderLivesInSamehome>true</IsProviderLivesInSamehome> <LineNo>11</LineNo> <Relationship>sample string 13</Relationship> <TerminationDate>2024-11-16T05:08:42.7524325-05:00</TerminationDate> <TerminationReason>sample string 9</TerminationReason> </ConsumerEmployeeAssociation> </ArrayOfConsumerEmployeeAssociation>