GET v1/lms/export/clients/{clientCode}/employee-trainings

Retrieve Trainings by Client

Request Information

URI Parameters

Name	Description	Type	Additional information
clientCode		string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of ExportEmployeeTrainingDTO

Name	Type	Additional information
PersonalId	EntityKeyOfIEmployeePersonalAndInt32	None.
TrainingKey	GlobalEntityKeyOfIEmployeeTraining	None.
CourseNameCode	string	None.
TrainingTypeCode	string	None.
TrainingStatusCode	string	None.
StartDate	date	None.
EndDate	date	None.
Credits	decimal number	None.
Hours	decimal number	None.
Score	string	None.
TrainingSite	string	None.
Classroom	string	None.
Instructor	string	None.
Notes	string	None.
CompletionDueDate	date	None.
CompletionDate	date	None.
Cost	decimal number	None.
RetakeDate	date	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:

[
  {
    "personalId": "<empty>",
    "trainingKey": "<empty>",
    "courseNameCode": "sample string 1",
    "trainingTypeCode": "sample string 2",
    "trainingStatusCode": "sample string 3",
    "startDate": "0001-02-03",
    "endDate": "0001-02-03",
    "credits": 1.0,
    "hours": 1.0,
    "score": "sample string 4",
    "trainingSite": "sample string 5",
    "classroom": "sample string 6",
    "instructor": "sample string 7",
    "notes": "sample string 8",
    "completionDueDate": "0001-02-03",
    "completionDate": "0001-02-03",
    "cost": 1.0,
    "retakeDate": "0001-02-03",
    "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 9"
  },
  {
    "personalId": "<empty>",
    "trainingKey": "<empty>",
    "courseNameCode": "sample string 1",
    "trainingTypeCode": "sample string 2",
    "trainingStatusCode": "sample string 3",
    "startDate": "0001-02-03",
    "endDate": "0001-02-03",
    "credits": 1.0,
    "hours": 1.0,
    "score": "sample string 4",
    "trainingSite": "sample string 5",
    "classroom": "sample string 6",
    "instructor": "sample string 7",
    "notes": "sample string 8",
    "completionDueDate": "0001-02-03",
    "completionDate": "0001-02-03",
    "cost": 1.0,
    "retakeDate": "0001-02-03",
    "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 9"
  }
]

text/xml

Sample:

<ArrayOfExportEmployeeTrainingDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <ExportEmployeeTrainingDTO>
    <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 9</EmployeeNumber>
    <Classroom>sample string 6</Classroom>
    <CompletionDate 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>
    </CompletionDate>
    <CompletionDueDate 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>
    </CompletionDueDate>
    <Cost>1</Cost>
    <CourseNameCode>sample string 1</CourseNameCode>
    <Credits>1</Credits>
    <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>
    <EndDate 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>
    </EndDate>
    <Hours>1</Hours>
    <Instructor>sample string 7</Instructor>
    <Notes>sample string 8</Notes>
    <PersonalId xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
      <d3p1:_hasValue>false</d3p1:_hasValue>
      <d3p1:_value>0</d3p1:_value>
    </PersonalId>
    <Reminder>
      <IsShowingOnDashboard>true</IsShowingOnDashboard>
      <IsShowingOnESS>true</IsShowingOnESS>
      <IsShowingOnPayStub>true</IsShowingOnPayStub>
      <Offset>1</Offset>
      <OffsetDirection>After</OffsetDirection>
    </Reminder>
    <RetakeDate 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>
    </RetakeDate>
    <Score>sample string 4</Score>
    <StartDate 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>
    </StartDate>
    <TrainingKey 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>
    </TrainingKey>
    <TrainingSite>sample string 5</TrainingSite>
    <TrainingStatusCode>sample string 3</TrainingStatusCode>
    <TrainingTypeCode>sample string 2</TrainingTypeCode>
  </ExportEmployeeTrainingDTO>
  <ExportEmployeeTrainingDTO>
    <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 9</EmployeeNumber>
    <Classroom>sample string 6</Classroom>
    <CompletionDate 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>
    </CompletionDate>
    <CompletionDueDate 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>
    </CompletionDueDate>
    <Cost>1</Cost>
    <CourseNameCode>sample string 1</CourseNameCode>
    <Credits>1</Credits>
    <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>
    <EndDate 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>
    </EndDate>
    <Hours>1</Hours>
    <Instructor>sample string 7</Instructor>
    <Notes>sample string 8</Notes>
    <PersonalId xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
      <d3p1:_hasValue>false</d3p1:_hasValue>
      <d3p1:_value>0</d3p1:_value>
    </PersonalId>
    <Reminder>
      <IsShowingOnDashboard>true</IsShowingOnDashboard>
      <IsShowingOnESS>true</IsShowingOnESS>
      <IsShowingOnPayStub>true</IsShowingOnPayStub>
      <Offset>1</Offset>
      <OffsetDirection>After</OffsetDirection>
    </Reminder>
    <RetakeDate 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>
    </RetakeDate>
    <Score>sample string 4</Score>
    <StartDate 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>
    </StartDate>
    <TrainingKey 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>
    </TrainingKey>
    <TrainingSite>sample string 5</TrainingSite>
    <TrainingStatusCode>sample string 3</TrainingStatusCode>
    <TrainingTypeCode>sample string 2</TrainingTypeCode>
  </ExportEmployeeTrainingDTO>
</ArrayOfExportEmployeeTrainingDTO>