GET v1/export/clients/{clientCode}/employee-assets

Retrieve Employee Assets by Client

Request Information

URI Parameters

Name	Description	Type	Additional information
clientCode		string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of ExportEmployeeAssetDTO

Name	Type	Additional information
AssetKey	GlobalEntityKeyOfIEmployeeAsset	None.
AssetType	string	None.
AssetNumber	string	None.
ModelNumber	string	None.
IssuedDate	date	None.
ReturnDate	date	None.
Expires	date	None.
Value	decimal number	None.
Notes	string	None.
IsReturned	boolean	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:

[
  {
    "assetKey": "<empty>",
    "assetType": "sample string 1",
    "assetNumber": "sample string 2",
    "modelNumber": "sample string 3",
    "issuedDate": "0001-02-03",
    "returnDate": "0001-02-03",
    "expires": "0001-02-03",
    "value": 1.0,
    "notes": "sample string 4",
    "isReturned": true,
    "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"
  },
  {
    "assetKey": "<empty>",
    "assetType": "sample string 1",
    "assetNumber": "sample string 2",
    "modelNumber": "sample string 3",
    "issuedDate": "0001-02-03",
    "returnDate": "0001-02-03",
    "expires": "0001-02-03",
    "value": 1.0,
    "notes": "sample string 4",
    "isReturned": true,
    "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:

<ArrayOfExportEmployeeAssetDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <ExportEmployeeAssetDTO>
    <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>
    <AssetKey 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>
    </AssetKey>
    <AssetNumber>sample string 2</AssetNumber>
    <AssetType>sample string 1</AssetType>
    <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>
    <Expires 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>
    </Expires>
    <IsReturned>true</IsReturned>
    <IssuedDate 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>
    </IssuedDate>
    <ModelNumber>sample string 3</ModelNumber>
    <Notes>sample string 4</Notes>
    <Reminder>
      <IsShowingOnDashboard>true</IsShowingOnDashboard>
      <IsShowingOnESS>true</IsShowingOnESS>
      <IsShowingOnPayStub>true</IsShowingOnPayStub>
      <Offset>1</Offset>
      <OffsetDirection>After</OffsetDirection>
    </Reminder>
    <ReturnDate 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>
    </ReturnDate>
    <Value>1</Value>
  </ExportEmployeeAssetDTO>
  <ExportEmployeeAssetDTO>
    <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>
    <AssetKey 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>
    </AssetKey>
    <AssetNumber>sample string 2</AssetNumber>
    <AssetType>sample string 1</AssetType>
    <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>
    <Expires 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>
    </Expires>
    <IsReturned>true</IsReturned>
    <IssuedDate 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>
    </IssuedDate>
    <ModelNumber>sample string 3</ModelNumber>
    <Notes>sample string 4</Notes>
    <Reminder>
      <IsShowingOnDashboard>true</IsShowingOnDashboard>
      <IsShowingOnESS>true</IsShowingOnESS>
      <IsShowingOnPayStub>true</IsShowingOnPayStub>
      <Offset>1</Offset>
      <OffsetDirection>After</OffsetDirection>
    </Reminder>
    <ReturnDate 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>
    </ReturnDate>
    <Value>1</Value>
  </ExportEmployeeAssetDTO>
</ArrayOfExportEmployeeAssetDTO>