GET v1/export/clients/{clientCode}/emergency-contacts
Retrieve Employee Emergency Contacts by Client
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
clientCode | string |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of ExportEmployeeEmergencyContactDTOName | Description | Type | Additional information |
---|---|---|---|
EmergencyContactKey | GlobalEntityKeyOfIEmployeeContact |
None. |
|
FirstName | string |
None. |
|
LastName | string |
None. |
|
string |
None. |
||
HomePhone | string |
None. |
|
CellPhone | string |
None. |
|
WorkPhone | string |
None. |
|
Relationship | string |
None. |
|
Address | AddressDTO |
None. |
|
DivisionKey | DivisionKeyDTO |
None. |
|
EmployeeKey | GlobalEntityKeyOfIEmployee |
None. |
|
EmployeeNumber | string |
None. |
Response Formats
application/json, text/json
Sample:
[ { "emergencyContactKey": "<empty>", "firstName": "sample string 1", "lastName": "sample string 2", "email": "sample string 3", "homePhone": "sample string 4", "cellPhone": "sample string 5", "workPhone": "sample string 6", "relationship": "sample string 7", "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" }, "divisionKey": { "companyCode": "sample string 1", "divisionCode": "sample string 2" }, "employeeKey": "<empty>", "employeeNumber": "sample string 8" }, { "emergencyContactKey": "<empty>", "firstName": "sample string 1", "lastName": "sample string 2", "email": "sample string 3", "homePhone": "sample string 4", "cellPhone": "sample string 5", "workPhone": "sample string 6", "relationship": "sample string 7", "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" }, "divisionKey": { "companyCode": "sample string 1", "divisionCode": "sample string 2" }, "employeeKey": "<empty>", "employeeNumber": "sample string 8" } ]
text/xml
Sample:
<ArrayOfExportEmployeeEmergencyContactDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models"> <ExportEmployeeEmergencyContactDTO> <DivisionKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models"> <d3p1:CompanyCode>sample string 1</d3p1:CompanyCode> <d3p1:DivisionCode>sample string 2</d3p1:DivisionCode> </DivisionKey> <EmployeeKey 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> </EmployeeKey> <EmployeeNumber>sample string 8</EmployeeNumber> <Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models"> <d3p1:Address1>sample string 1</d3p1:Address1> <d3p1:Address2>sample string 2</d3p1:Address2> <d3p1:City>sample string 3</d3p1:City> <d3p1:Country>sample string 6</d3p1:Country> <d3p1:County>sample string 7</d3p1:County> <d3p1:State>sample string 4</d3p1:State> <d3p1:Zip>sample string 5</d3p1:Zip> </Address> <CellPhone>sample string 5</CellPhone> <Email>sample string 3</Email> <EmergencyContactKey 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> </EmergencyContactKey> <FirstName>sample string 1</FirstName> <HomePhone>sample string 4</HomePhone> <LastName>sample string 2</LastName> <Relationship>sample string 7</Relationship> <WorkPhone>sample string 6</WorkPhone> </ExportEmployeeEmergencyContactDTO> <ExportEmployeeEmergencyContactDTO> <DivisionKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models"> <d3p1:CompanyCode>sample string 1</d3p1:CompanyCode> <d3p1:DivisionCode>sample string 2</d3p1:DivisionCode> </DivisionKey> <EmployeeKey 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> </EmployeeKey> <EmployeeNumber>sample string 8</EmployeeNumber> <Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models"> <d3p1:Address1>sample string 1</d3p1:Address1> <d3p1:Address2>sample string 2</d3p1:Address2> <d3p1:City>sample string 3</d3p1:City> <d3p1:Country>sample string 6</d3p1:Country> <d3p1:County>sample string 7</d3p1:County> <d3p1:State>sample string 4</d3p1:State> <d3p1:Zip>sample string 5</d3p1:Zip> </Address> <CellPhone>sample string 5</CellPhone> <Email>sample string 3</Email> <EmergencyContactKey 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> </EmergencyContactKey> <FirstName>sample string 1</FirstName> <HomePhone>sample string 4</HomePhone> <LastName>sample string 2</LastName> <Relationship>sample string 7</Relationship> <WorkPhone>sample string 6</WorkPhone> </ExportEmployeeEmergencyContactDTO> </ArrayOfExportEmployeeEmergencyContactDTO>