GET v1/export/companies/{companyCode}/divisions/{divisionCode}/employees/{employeeNumber}/licenses

Retrieve Licenses by Employee Number

Request Information

URI Parameters

Name	Type	Additional information
companyCode	string	Required
divisionCode	string	Required
employeeNumber	string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of ExportEmployeeLicenseDTO

Name	Type	Additional information
LicenseKey	GlobalEntityKeyOfIEmployeeLicense	None.
LicenseTypeCode	string	None.
LicenseCertificateCode	string	None.
LicenseNumber	string	None.
IssueDate	date	None.
ExpirationDate	date	None.
StateCode	string	None.
Notes	string	None.
Reminder	ReminderSubDTO	None.
Documents	Collection of DocumentHeaderDTO	None.
DivisionKey	DivisionKeyDTO	None.
EmployeeKey	GlobalEntityKeyOfIEmployee	None.
EmployeeNumber	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "licenseKey": "<empty>",
    "licenseTypeCode": "sample string 1",
    "licenseCertificateCode": "sample string 2",
    "licenseNumber": "sample string 3",
    "issueDate": "0001-02-03",
    "expirationDate": "0001-02-03",
    "stateCode": "sample string 4",
    "notes": "sample string 5",
    "reminder": {
      "isShowingOnDashboard": true,
      "isShowingOnPayStub": true,
      "isShowingOnESS": true,
      "offset": 1,
      "offsetDirection": "After"
    },
    "documents": [
      {
        "id": "<empty>",
        "name": "sample string 1",
        "extension": "sample string 2",
        "description": "sample string 3",
        "mimeType": "sample string 4"
      },
      {
        "id": "<empty>",
        "name": "sample string 1",
        "extension": "sample string 2",
        "description": "sample string 3",
        "mimeType": "sample string 4"
      }
    ],
    "divisionKey": {
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2"
    },
    "employeeKey": "<empty>",
    "employeeNumber": "sample string 6"
  },
  {
    "licenseKey": "<empty>",
    "licenseTypeCode": "sample string 1",
    "licenseCertificateCode": "sample string 2",
    "licenseNumber": "sample string 3",
    "issueDate": "0001-02-03",
    "expirationDate": "0001-02-03",
    "stateCode": "sample string 4",
    "notes": "sample string 5",
    "reminder": {
      "isShowingOnDashboard": true,
      "isShowingOnPayStub": true,
      "isShowingOnESS": true,
      "offset": 1,
      "offsetDirection": "After"
    },
    "documents": [
      {
        "id": "<empty>",
        "name": "sample string 1",
        "extension": "sample string 2",
        "description": "sample string 3",
        "mimeType": "sample string 4"
      },
      {
        "id": "<empty>",
        "name": "sample string 1",
        "extension": "sample string 2",
        "description": "sample string 3",
        "mimeType": "sample string 4"
      }
    ],
    "divisionKey": {
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2"
    },
    "employeeKey": "<empty>",
    "employeeNumber": "sample string 6"
  }
]

text/xml

Sample:

<ArrayOfExportEmployeeLicenseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <ExportEmployeeLicenseDTO>
    <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 6</EmployeeNumber>
    <Documents>
      <DocumentHeaderDTO>
        <Description>sample string 3</Description>
        <Extension>sample string 2</Extension>
        <Id 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>
        </Id>
        <MimeType>sample string 4</MimeType>
        <Name>sample string 1</Name>
      </DocumentHeaderDTO>
      <DocumentHeaderDTO>
        <Description>sample string 3</Description>
        <Extension>sample string 2</Extension>
        <Id 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>
        </Id>
        <MimeType>sample string 4</MimeType>
        <Name>sample string 1</Name>
      </DocumentHeaderDTO>
    </Documents>
    <ExpirationDate 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>
    </ExpirationDate>
    <IssueDate 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>
    </IssueDate>
    <LicenseCertificateCode>sample string 2</LicenseCertificateCode>
    <LicenseKey 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>
    </LicenseKey>
    <LicenseNumber>sample string 3</LicenseNumber>
    <LicenseTypeCode>sample string 1</LicenseTypeCode>
    <Notes>sample string 5</Notes>
    <Reminder>
      <IsShowingOnDashboard>true</IsShowingOnDashboard>
      <IsShowingOnESS>true</IsShowingOnESS>
      <IsShowingOnPayStub>true</IsShowingOnPayStub>
      <Offset>1</Offset>
      <OffsetDirection>After</OffsetDirection>
    </Reminder>
    <StateCode>sample string 4</StateCode>
  </ExportEmployeeLicenseDTO>
  <ExportEmployeeLicenseDTO>
    <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 6</EmployeeNumber>
    <Documents>
      <DocumentHeaderDTO>
        <Description>sample string 3</Description>
        <Extension>sample string 2</Extension>
        <Id 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>
        </Id>
        <MimeType>sample string 4</MimeType>
        <Name>sample string 1</Name>
      </DocumentHeaderDTO>
      <DocumentHeaderDTO>
        <Description>sample string 3</Description>
        <Extension>sample string 2</Extension>
        <Id 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>
        </Id>
        <MimeType>sample string 4</MimeType>
        <Name>sample string 1</Name>
      </DocumentHeaderDTO>
    </Documents>
    <ExpirationDate 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>
    </ExpirationDate>
    <IssueDate 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>
    </IssueDate>
    <LicenseCertificateCode>sample string 2</LicenseCertificateCode>
    <LicenseKey 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>
    </LicenseKey>
    <LicenseNumber>sample string 3</LicenseNumber>
    <LicenseTypeCode>sample string 1</LicenseTypeCode>
    <Notes>sample string 5</Notes>
    <Reminder>
      <IsShowingOnDashboard>true</IsShowingOnDashboard>
      <IsShowingOnESS>true</IsShowingOnESS>
      <IsShowingOnPayStub>true</IsShowingOnPayStub>
      <Offset>1</Offset>
      <OffsetDirection>After</OffsetDirection>
    </Reminder>
    <StateCode>sample string 4</StateCode>
  </ExportEmployeeLicenseDTO>
</ArrayOfExportEmployeeLicenseDTO>