GET v1/edi-benefits/export/clients/{clientCode}/census

Retrieve EDI Censuses

Request Information

URI Parameters

Name	Description	Type	Additional information
clientCode		string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of EDICensusDTO

Name	Type	Additional information
EmployeeKey	GlobalEntityKeyOfIEmployee	None.
EmployeePersonalKey	EntityKeyOfIEmployeePersonalAndInt32	None.
EmployeeNumber	string	None.
SSN	string	None.
CompanyCode	string	None.
DivisionCode	string	None.
CompanyName	string	None.
CompanyFederalTaxID	string	None.
ClientKey	GlobalEntityKeyOfISBClient	None.
EmployeeStatus	EmployeeStatus	None.
EmployeeStatusEffectiveDate	date	None.
Gender	Gender	None.
MailingAddress	AddressDTO	None.
HomeAddress	AddressDTO	None.
IsTobaccoUser	boolean	None.
IsDisabled	boolean	None.
PayFrequency	PayFrequency	None.
PayType	PayType	None.
BaseRate	decimal number	None.
BaseRateStartDate	date	None.
CostCenter1Code	string	None.
CostCenter2Code	string	None.
CostCenter3Code	string	None.
CostCenter4Code	string	None.
CostCenter5Code	string	None.
WorkAuthorizationStatus	WorkAuthorizationStatus	None.
StandardHours	decimal number	None.
JobTitle	string	None.
FirstName	string	None.
MiddleInitial	character	None.
LastName	string	None.
Suffix	string	None.
Nickname	string	None.
BirthDate	date	None.
HomePhone	string	None.
WorkPhone	string	None.
MobilePhone	string	None.
Email	string	None.
MaritalStatus	string	None.
EmploymentType	FullOrPartTime	None.
HireDate	date	None.
RehireDate	date	None.
TerminationDate	date	None.
TerminationReason	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "employeeKey": "<empty>",
    "employeePersonalKey": "<empty>",
    "employeeNumber": "sample string 1",
    "ssn": "sample string 2",
    "companyCode": "sample string 3",
    "divisionCode": "sample string 4",
    "companyName": "sample string 5",
    "companyFederalTaxID": "sample string 6",
    "clientKey": "<empty>",
    "employeeStatus": "Active",
    "employeeStatusEffectiveDate": "0001-02-03",
    "gender": "Male",
    "mailingAddress": {
      "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"
    },
    "homeAddress": {
      "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"
    },
    "isTobaccoUser": true,
    "isDisabled": true,
    "payFrequency": "YEAR",
    "payType": "Salary",
    "baseRate": 9.0,
    "baseRateStartDate": "0001-02-03",
    "costCenter1Code": "sample string 10",
    "costCenter2Code": "sample string 11",
    "costCenter3Code": "sample string 12",
    "costCenter4Code": "sample string 13",
    "costCenter5Code": "sample string 14",
    "workAuthorizationStatus": "AuthorizedAlien",
    "standardHours": 15.0,
    "jobTitle": "sample string 16",
    "firstName": "sample string 17",
    "middleInitial": "A",
    "lastName": "sample string 18",
    "suffix": "sample string 19",
    "nickname": "sample string 20",
    "birthDate": "0001-02-03",
    "homePhone": "sample string 21",
    "workPhone": "sample string 22",
    "mobilePhone": "sample string 23",
    "email": "sample string 24",
    "maritalStatus": "sample string 25",
    "employmentType": "FullTime",
    "hireDate": "0001-02-03",
    "rehireDate": "0001-02-03",
    "terminationDate": "0001-02-03",
    "terminationReason": "sample string 26"
  },
  {
    "employeeKey": "<empty>",
    "employeePersonalKey": "<empty>",
    "employeeNumber": "sample string 1",
    "ssn": "sample string 2",
    "companyCode": "sample string 3",
    "divisionCode": "sample string 4",
    "companyName": "sample string 5",
    "companyFederalTaxID": "sample string 6",
    "clientKey": "<empty>",
    "employeeStatus": "Active",
    "employeeStatusEffectiveDate": "0001-02-03",
    "gender": "Male",
    "mailingAddress": {
      "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"
    },
    "homeAddress": {
      "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"
    },
    "isTobaccoUser": true,
    "isDisabled": true,
    "payFrequency": "YEAR",
    "payType": "Salary",
    "baseRate": 9.0,
    "baseRateStartDate": "0001-02-03",
    "costCenter1Code": "sample string 10",
    "costCenter2Code": "sample string 11",
    "costCenter3Code": "sample string 12",
    "costCenter4Code": "sample string 13",
    "costCenter5Code": "sample string 14",
    "workAuthorizationStatus": "AuthorizedAlien",
    "standardHours": 15.0,
    "jobTitle": "sample string 16",
    "firstName": "sample string 17",
    "middleInitial": "A",
    "lastName": "sample string 18",
    "suffix": "sample string 19",
    "nickname": "sample string 20",
    "birthDate": "0001-02-03",
    "homePhone": "sample string 21",
    "workPhone": "sample string 22",
    "mobilePhone": "sample string 23",
    "email": "sample string 24",
    "maritalStatus": "sample string 25",
    "employmentType": "FullTime",
    "hireDate": "0001-02-03",
    "rehireDate": "0001-02-03",
    "terminationDate": "0001-02-03",
    "terminationReason": "sample string 26"
  }
]

text/xml

Sample:

<ArrayOfEDICensusDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <EDICensusDTO>
    <BaseRate>9</BaseRate>
    <BaseRateStartDate 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>
    </BaseRateStartDate>
    <BirthDate 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>
    </BirthDate>
    <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>
    <CompanyCode>sample string 3</CompanyCode>
    <CompanyFederalTaxID>sample string 6</CompanyFederalTaxID>
    <CompanyName>sample string 5</CompanyName>
    <CostCenter1Code>sample string 10</CostCenter1Code>
    <CostCenter2Code>sample string 11</CostCenter2Code>
    <CostCenter3Code>sample string 12</CostCenter3Code>
    <CostCenter4Code>sample string 13</CostCenter4Code>
    <CostCenter5Code>sample string 14</CostCenter5Code>
    <DivisionCode>sample string 4</DivisionCode>
    <Email>sample string 24</Email>
    <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 1</EmployeeNumber>
    <EmployeePersonalKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
      <d3p1:_hasValue>false</d3p1:_hasValue>
      <d3p1:_value>0</d3p1:_value>
    </EmployeePersonalKey>
    <EmployeeStatus>Active</EmployeeStatus>
    <EmployeeStatusEffectiveDate 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>
    </EmployeeStatusEffectiveDate>
    <EmploymentType>FullTime</EmploymentType>
    <FirstName>sample string 17</FirstName>
    <Gender>Male</Gender>
    <HireDate 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>
    </HireDate>
    <HomeAddress 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>
    </HomeAddress>
    <HomePhone>sample string 21</HomePhone>
    <IsDisabled>true</IsDisabled>
    <IsTobaccoUser>true</IsTobaccoUser>
    <JobTitle>sample string 16</JobTitle>
    <LastName>sample string 18</LastName>
    <MailingAddress 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>
    </MailingAddress>
    <MaritalStatus>sample string 25</MaritalStatus>
    <MiddleInitial>65</MiddleInitial>
    <MobilePhone>sample string 23</MobilePhone>
    <Nickname>sample string 20</Nickname>
    <PayFrequency>YEAR</PayFrequency>
    <PayType>Salary</PayType>
    <RehireDate 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>
    </RehireDate>
    <SSN>sample string 2</SSN>
    <StandardHours>15</StandardHours>
    <Suffix>sample string 19</Suffix>
    <TerminationDate 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>
    </TerminationDate>
    <TerminationReason>sample string 26</TerminationReason>
    <WorkAuthorizationStatus>AuthorizedAlien</WorkAuthorizationStatus>
    <WorkPhone>sample string 22</WorkPhone>
  </EDICensusDTO>
  <EDICensusDTO>
    <BaseRate>9</BaseRate>
    <BaseRateStartDate 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>
    </BaseRateStartDate>
    <BirthDate 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>
    </BirthDate>
    <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>
    <CompanyCode>sample string 3</CompanyCode>
    <CompanyFederalTaxID>sample string 6</CompanyFederalTaxID>
    <CompanyName>sample string 5</CompanyName>
    <CostCenter1Code>sample string 10</CostCenter1Code>
    <CostCenter2Code>sample string 11</CostCenter2Code>
    <CostCenter3Code>sample string 12</CostCenter3Code>
    <CostCenter4Code>sample string 13</CostCenter4Code>
    <CostCenter5Code>sample string 14</CostCenter5Code>
    <DivisionCode>sample string 4</DivisionCode>
    <Email>sample string 24</Email>
    <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 1</EmployeeNumber>
    <EmployeePersonalKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
      <d3p1:_hasValue>false</d3p1:_hasValue>
      <d3p1:_value>0</d3p1:_value>
    </EmployeePersonalKey>
    <EmployeeStatus>Active</EmployeeStatus>
    <EmployeeStatusEffectiveDate 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>
    </EmployeeStatusEffectiveDate>
    <EmploymentType>FullTime</EmploymentType>
    <FirstName>sample string 17</FirstName>
    <Gender>Male</Gender>
    <HireDate 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>
    </HireDate>
    <HomeAddress 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>
    </HomeAddress>
    <HomePhone>sample string 21</HomePhone>
    <IsDisabled>true</IsDisabled>
    <IsTobaccoUser>true</IsTobaccoUser>
    <JobTitle>sample string 16</JobTitle>
    <LastName>sample string 18</LastName>
    <MailingAddress 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>
    </MailingAddress>
    <MaritalStatus>sample string 25</MaritalStatus>
    <MiddleInitial>65</MiddleInitial>
    <MobilePhone>sample string 23</MobilePhone>
    <Nickname>sample string 20</Nickname>
    <PayFrequency>YEAR</PayFrequency>
    <PayType>Salary</PayType>
    <RehireDate 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>
    </RehireDate>
    <SSN>sample string 2</SSN>
    <StandardHours>15</StandardHours>
    <Suffix>sample string 19</Suffix>
    <TerminationDate 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>
    </TerminationDate>
    <TerminationReason>sample string 26</TerminationReason>
    <WorkAuthorizationStatus>AuthorizedAlien</WorkAuthorizationStatus>
    <WorkPhone>sample string 22</WorkPhone>
  </EDICensusDTO>
</ArrayOfEDICensusDTO>