POST v1/lms/import/trainings?importAction={importAction}&allowSameFile={allowSameFile}

Import Trainings

Request Information

URI Parameters

Name	Description	Type	Additional information
importAction	The import action.	ImportAction	Default value is Override
allowSameFile	Determines if the import allows the content to be imported multiple times	boolean	Default value is True

Body Parameters

The items to import.

Collection of EmployeeTrainingImportDTO

Name	Type	Additional information
SerializableTrainingKey	globally unique identifier	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 DivisionDocumentSubImportDTO	None.
EmployeeNumber	string	None.
EmployeePersonalId	integer	None.
DivisionCode	string	None.
CompanyCode	string	Required

Request Formats

application/json, text/json

Sample:

[
  {
    "serializableTrainingKey": "3ffa14cd-1727-4bf8-84c4-698eb5f43272",
    "trainingKey": "3ffa14cd-1727-4bf8-84c4-698eb5f43272",
    "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": [
      {
        "content": "QEA=",
        "name": "sample string 1",
        "sourcePath": "sample string 2",
        "mimeType": "sample string 3",
        "documentTypeCode": "sample string 4"
      },
      {
        "content": "QEA=",
        "name": "sample string 1",
        "sourcePath": "sample string 2",
        "mimeType": "sample string 3",
        "documentTypeCode": "sample string 4"
      }
    ],
    "employeeNumber": "sample string 9",
    "employeePersonalId": 1,
    "divisionCode": "sample string 10",
    "companyCode": "sample string 11"
  },
  {
    "serializableTrainingKey": "3ffa14cd-1727-4bf8-84c4-698eb5f43272",
    "trainingKey": "3ffa14cd-1727-4bf8-84c4-698eb5f43272",
    "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": [
      {
        "content": "QEA=",
        "name": "sample string 1",
        "sourcePath": "sample string 2",
        "mimeType": "sample string 3",
        "documentTypeCode": "sample string 4"
      },
      {
        "content": "QEA=",
        "name": "sample string 1",
        "sourcePath": "sample string 2",
        "mimeType": "sample string 3",
        "documentTypeCode": "sample string 4"
      }
    ],
    "employeeNumber": "sample string 9",
    "employeePersonalId": 1,
    "divisionCode": "sample string 10",
    "companyCode": "sample string 11"
  }
]

text/xml

Sample:

<ArrayOfEmployeeTrainingImportDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <EmployeeTrainingImportDTO>
    <CompanyCode>sample string 11</CompanyCode>
    <DivisionCode>sample string 10</DivisionCode>
    <EmployeeNumber>sample string 9</EmployeeNumber>
    <EmployeePersonalId>1</EmployeePersonalId>
    <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>
      <DivisionDocumentSubImportDTO>
        <Content>QEA=</Content>
        <DocumentTypeCode>sample string 4</DocumentTypeCode>
        <MimeType>sample string 3</MimeType>
        <Name>sample string 1</Name>
        <SourcePath>sample string 2</SourcePath>
      </DivisionDocumentSubImportDTO>
      <DivisionDocumentSubImportDTO>
        <Content>QEA=</Content>
        <DocumentTypeCode>sample string 4</DocumentTypeCode>
        <MimeType>sample string 3</MimeType>
        <Name>sample string 1</Name>
        <SourcePath>sample string 2</SourcePath>
      </DivisionDocumentSubImportDTO>
    </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>
    <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>
    <SerializableTrainingKey>3ffa14cd-1727-4bf8-84c4-698eb5f43272</SerializableTrainingKey>
    <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>true</d3p1:_hasValue>
        <d3p1:_value>3ffa14cd-1727-4bf8-84c4-698eb5f43272</d3p1:_value>
      </d3p1:_entityKey>
    </TrainingKey>
    <TrainingSite>sample string 5</TrainingSite>
    <TrainingStatusCode>sample string 3</TrainingStatusCode>
    <TrainingTypeCode>sample string 2</TrainingTypeCode>
  </EmployeeTrainingImportDTO>
  <EmployeeTrainingImportDTO>
    <CompanyCode>sample string 11</CompanyCode>
    <DivisionCode>sample string 10</DivisionCode>
    <EmployeeNumber>sample string 9</EmployeeNumber>
    <EmployeePersonalId>1</EmployeePersonalId>
    <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>
      <DivisionDocumentSubImportDTO>
        <Content>QEA=</Content>
        <DocumentTypeCode>sample string 4</DocumentTypeCode>
        <MimeType>sample string 3</MimeType>
        <Name>sample string 1</Name>
        <SourcePath>sample string 2</SourcePath>
      </DivisionDocumentSubImportDTO>
      <DivisionDocumentSubImportDTO>
        <Content>QEA=</Content>
        <DocumentTypeCode>sample string 4</DocumentTypeCode>
        <MimeType>sample string 3</MimeType>
        <Name>sample string 1</Name>
        <SourcePath>sample string 2</SourcePath>
      </DivisionDocumentSubImportDTO>
    </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>
    <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>
    <SerializableTrainingKey>3ffa14cd-1727-4bf8-84c4-698eb5f43272</SerializableTrainingKey>
    <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>true</d3p1:_hasValue>
        <d3p1:_value>3ffa14cd-1727-4bf8-84c4-698eb5f43272</d3p1:_value>
      </d3p1:_entityKey>
    </TrainingKey>
    <TrainingSite>sample string 5</TrainingSite>
    <TrainingStatusCode>sample string 3</TrainingStatusCode>
    <TrainingTypeCode>sample string 2</TrainingTypeCode>
  </EmployeeTrainingImportDTO>
</ArrayOfEmployeeTrainingImportDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The results of the import.

ImportResultDTO

Name	Type	Additional information
NewRecords	integer	None.
UpdatedRecords	integer	None.
Errors	Collection of ImportErrorDTO	None.
NewRecordKeys	Collection of ImportKeyDTO	None.
UpdatedRecordKeys	Collection of ImportKeyDTO	None.
ImportKey	GlobalEntityKeyOfIImportSubmission	None.

Response Formats

application/json, text/json, text/xml

Sample:

Sample not available.