GET v1/export/companies/{companyCode}/divisions/{divisionCode}/employees/{employeeNumber}/reviews
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| companyCode | string |
Required |
|
| divisionCode | string |
Required |
|
| employeeNumber | string |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of ExportEmployeeReviewDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| ReviewKey | GlobalEntityKeyOfIEmployeeReview |
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 DocumentHeaderDTO |
None. |
|
| DivisionKey | DivisionKeyDTO |
None. |
|
| EmployeeKey | GlobalEntityKeyOfIEmployee |
None. |
|
| EmployeeNumber | string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"reviewKey": "<empty>",
"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": [
{
"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 10"
},
{
"reviewKey": "<empty>",
"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": [
{
"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 10"
}
]
text/xml
Sample:
<ArrayOfExportEmployeeReviewDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
<ExportEmployeeReviewDTO>
<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 10</EmployeeNumber>
<BonusAmount>1</BonusAmount>
<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>
<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>false</d3p1:_hasValue>
<d3p1:_value>00000000-0000-0000-0000-000000000000</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>
</ExportEmployeeReviewDTO>
<ExportEmployeeReviewDTO>
<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 10</EmployeeNumber>
<BonusAmount>1</BonusAmount>
<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>
<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>false</d3p1:_hasValue>
<d3p1:_value>00000000-0000-0000-0000-000000000000</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>
</ExportEmployeeReviewDTO>
</ArrayOfExportEmployeeReviewDTO>