POST v1/imports/reviews?importAction={importAction}&allowSameFile={allowSameFile}

Import Reviews

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 EmployeeReviewImportDTO

Name	Type	Additional information
SerializableReviewKey	globally unique identifier	None.
ReviewTypeCode	string	None.
Rating1Code	string	None.
Rating2Code	string	None.
ReviewStatusCode	string	None.
Reviewer	string	None.
ReviewDate	date	None.
ReviewStart	date	None.
ReviewEnd	date	None.
NextReviewDate	date	None.
RaiseDate	date	None.
ReviewerNotes	string	None.
EmployeeNotes	string	None.
RaiseAmount	decimal number	None.
NewAmount	decimal number	None.
BonusAmount	decimal number	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:

[
  {
    "serializableReviewKey": "0b5ef700-25c3-44f9-ac6a-9b873b8d0db4",
    "reviewKey": "0b5ef700-25c3-44f9-ac6a-9b873b8d0db4",
    "reviewTypeCode": "sample string 1",
    "rating1Code": "sample string 2",
    "rating2Code": "sample string 3",
    "reviewStatusCode": "sample string 4",
    "reviewer": "sample string 5",
    "reviewDate": "0001-02-03",
    "reviewStart": "0001-02-03",
    "reviewEnd": "0001-02-03",
    "nextReviewDate": "0001-02-03",
    "raiseDate": "0001-02-03",
    "reviewerNotes": "sample string 6",
    "employeeNotes": "sample string 7",
    "raiseAmount": 8.0,
    "newAmount": 9.0,
    "bonusAmount": 1.0,
    "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 10",
    "employeePersonalId": 1,
    "divisionCode": "sample string 11",
    "companyCode": "sample string 12"
  },
  {
    "serializableReviewKey": "0b5ef700-25c3-44f9-ac6a-9b873b8d0db4",
    "reviewKey": "0b5ef700-25c3-44f9-ac6a-9b873b8d0db4",
    "reviewTypeCode": "sample string 1",
    "rating1Code": "sample string 2",
    "rating2Code": "sample string 3",
    "reviewStatusCode": "sample string 4",
    "reviewer": "sample string 5",
    "reviewDate": "0001-02-03",
    "reviewStart": "0001-02-03",
    "reviewEnd": "0001-02-03",
    "nextReviewDate": "0001-02-03",
    "raiseDate": "0001-02-03",
    "reviewerNotes": "sample string 6",
    "employeeNotes": "sample string 7",
    "raiseAmount": 8.0,
    "newAmount": 9.0,
    "bonusAmount": 1.0,
    "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 10",
    "employeePersonalId": 1,
    "divisionCode": "sample string 11",
    "companyCode": "sample string 12"
  }
]

text/xml

Sample:

<ArrayOfEmployeeReviewImportDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <EmployeeReviewImportDTO>
    <CompanyCode>sample string 12</CompanyCode>
    <DivisionCode>sample string 11</DivisionCode>
    <EmployeeNumber>sample string 10</EmployeeNumber>
    <EmployeePersonalId>1</EmployeePersonalId>
    <BonusAmount>1</BonusAmount>
    <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>
    <EmployeeNotes>sample string 7</EmployeeNotes>
    <NewAmount>9</NewAmount>
    <NextReviewDate 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>
    </NextReviewDate>
    <RaiseAmount>8</RaiseAmount>
    <RaiseDate 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>
    </RaiseDate>
    <Rating1Code>sample string 2</Rating1Code>
    <Rating2Code>sample string 3</Rating2Code>
    <Reminder>
      <IsShowingOnDashboard>true</IsShowingOnDashboard>
      <IsShowingOnESS>true</IsShowingOnESS>
      <IsShowingOnPayStub>true</IsShowingOnPayStub>
      <Offset>1</Offset>
      <OffsetDirection>After</OffsetDirection>
    </Reminder>
    <ReviewDate 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>
    </ReviewDate>
    <ReviewEnd 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>
    </ReviewEnd>
    <ReviewKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
      <d3p1:_entityKey>
        <d3p1:_hasValue>true</d3p1:_hasValue>
        <d3p1:_value>0b5ef700-25c3-44f9-ac6a-9b873b8d0db4</d3p1:_value>
      </d3p1:_entityKey>
    </ReviewKey>
    <ReviewStart 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>
    </ReviewStart>
    <ReviewStatusCode>sample string 4</ReviewStatusCode>
    <ReviewTypeCode>sample string 1</ReviewTypeCode>
    <Reviewer>sample string 5</Reviewer>
    <ReviewerNotes>sample string 6</ReviewerNotes>
    <SerializableReviewKey>0b5ef700-25c3-44f9-ac6a-9b873b8d0db4</SerializableReviewKey>
  </EmployeeReviewImportDTO>
  <EmployeeReviewImportDTO>
    <CompanyCode>sample string 12</CompanyCode>
    <DivisionCode>sample string 11</DivisionCode>
    <EmployeeNumber>sample string 10</EmployeeNumber>
    <EmployeePersonalId>1</EmployeePersonalId>
    <BonusAmount>1</BonusAmount>
    <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>
    <EmployeeNotes>sample string 7</EmployeeNotes>
    <NewAmount>9</NewAmount>
    <NextReviewDate 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>
    </NextReviewDate>
    <RaiseAmount>8</RaiseAmount>
    <RaiseDate 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>
    </RaiseDate>
    <Rating1Code>sample string 2</Rating1Code>
    <Rating2Code>sample string 3</Rating2Code>
    <Reminder>
      <IsShowingOnDashboard>true</IsShowingOnDashboard>
      <IsShowingOnESS>true</IsShowingOnESS>
      <IsShowingOnPayStub>true</IsShowingOnPayStub>
      <Offset>1</Offset>
      <OffsetDirection>After</OffsetDirection>
    </Reminder>
    <ReviewDate 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>
    </ReviewDate>
    <ReviewEnd 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>
    </ReviewEnd>
    <ReviewKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
      <d3p1:_entityKey>
        <d3p1:_hasValue>true</d3p1:_hasValue>
        <d3p1:_value>0b5ef700-25c3-44f9-ac6a-9b873b8d0db4</d3p1:_value>
      </d3p1:_entityKey>
    </ReviewKey>
    <ReviewStart 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>
    </ReviewStart>
    <ReviewStatusCode>sample string 4</ReviewStatusCode>
    <ReviewTypeCode>sample string 1</ReviewTypeCode>
    <Reviewer>sample string 5</Reviewer>
    <ReviewerNotes>sample string 6</ReviewerNotes>
    <SerializableReviewKey>0b5ef700-25c3-44f9-ac6a-9b873b8d0db4</SerializableReviewKey>
  </EmployeeReviewImportDTO>
</ArrayOfEmployeeReviewImportDTO>

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.