POST v1/imports/licenses?importAction={importAction}&allowSameFile={allowSameFile}
Import Licenses
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 EmployeeLicenseImportDTOName | Description | Type | Additional information |
---|---|---|---|
SerializableLicenseKey | globally unique identifier |
None. |
|
LicenseTypeCode | string |
None. |
|
LicenseCertificateCode | string |
None. |
|
LicenseNumber | string |
None. |
|
IssuedDate | date |
None. |
|
ExpirationDate | date |
None. |
|
Reminder | ReminderSubDTO |
None. |
|
Notes | string |
None. |
|
StateCode | string |
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:
[ { "serializableLicenseKey": "6df5b612-858e-48cf-a965-f9bfd9c9faee", "licenseKey": "6df5b612-858e-48cf-a965-f9bfd9c9faee", "licenseTypeCode": "sample string 2", "licenseCertificateCode": "sample string 3", "licenseNumber": "sample string 4", "issuedDate": "0001-02-03", "expirationDate": "0001-02-03", "reminder": { "isShowingOnDashboard": true, "isShowingOnPayStub": true, "isShowingOnESS": true, "offset": 1, "offsetDirection": "After" }, "notes": "sample string 5", "stateCode": "sample string 6", "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 7", "employeePersonalId": 1, "divisionCode": "sample string 8", "companyCode": "sample string 9" }, { "serializableLicenseKey": "6df5b612-858e-48cf-a965-f9bfd9c9faee", "licenseKey": "6df5b612-858e-48cf-a965-f9bfd9c9faee", "licenseTypeCode": "sample string 2", "licenseCertificateCode": "sample string 3", "licenseNumber": "sample string 4", "issuedDate": "0001-02-03", "expirationDate": "0001-02-03", "reminder": { "isShowingOnDashboard": true, "isShowingOnPayStub": true, "isShowingOnESS": true, "offset": 1, "offsetDirection": "After" }, "notes": "sample string 5", "stateCode": "sample string 6", "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 7", "employeePersonalId": 1, "divisionCode": "sample string 8", "companyCode": "sample string 9" } ]
text/xml
Sample:
<ArrayOfEmployeeLicenseImportDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models"> <EmployeeLicenseImportDTO> <CompanyCode>sample string 9</CompanyCode> <DivisionCode>sample string 8</DivisionCode> <EmployeeNumber>sample string 7</EmployeeNumber> <EmployeePersonalId>1</EmployeePersonalId> <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> <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> <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> <LicenseCertificateCode>sample string 3</LicenseCertificateCode> <LicenseKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys"> <d3p1:_entityKey> <d3p1:_hasValue>true</d3p1:_hasValue> <d3p1:_value>6df5b612-858e-48cf-a965-f9bfd9c9faee</d3p1:_value> </d3p1:_entityKey> </LicenseKey> <LicenseNumber>sample string 4</LicenseNumber> <LicenseTypeCode>sample string 2</LicenseTypeCode> <Notes>sample string 5</Notes> <Reminder> <IsShowingOnDashboard>true</IsShowingOnDashboard> <IsShowingOnESS>true</IsShowingOnESS> <IsShowingOnPayStub>true</IsShowingOnPayStub> <Offset>1</Offset> <OffsetDirection>After</OffsetDirection> </Reminder> <SerializableLicenseKey>6df5b612-858e-48cf-a965-f9bfd9c9faee</SerializableLicenseKey> <StateCode>sample string 6</StateCode> </EmployeeLicenseImportDTO> <EmployeeLicenseImportDTO> <CompanyCode>sample string 9</CompanyCode> <DivisionCode>sample string 8</DivisionCode> <EmployeeNumber>sample string 7</EmployeeNumber> <EmployeePersonalId>1</EmployeePersonalId> <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> <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> <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> <LicenseCertificateCode>sample string 3</LicenseCertificateCode> <LicenseKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys"> <d3p1:_entityKey> <d3p1:_hasValue>true</d3p1:_hasValue> <d3p1:_value>6df5b612-858e-48cf-a965-f9bfd9c9faee</d3p1:_value> </d3p1:_entityKey> </LicenseKey> <LicenseNumber>sample string 4</LicenseNumber> <LicenseTypeCode>sample string 2</LicenseTypeCode> <Notes>sample string 5</Notes> <Reminder> <IsShowingOnDashboard>true</IsShowingOnDashboard> <IsShowingOnESS>true</IsShowingOnESS> <IsShowingOnPayStub>true</IsShowingOnPayStub> <Offset>1</Offset> <OffsetDirection>After</OffsetDirection> </Reminder> <SerializableLicenseKey>6df5b612-858e-48cf-a965-f9bfd9c9faee</SerializableLicenseKey> <StateCode>sample string 6</StateCode> </EmployeeLicenseImportDTO> </ArrayOfEmployeeLicenseImportDTO>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
The results of the import.
ImportResultDTOName | Description | 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.