GET api/v2/ratings?criteria.ApiKey={criteria.ApiKey}&criteria.StartDate={criteria.StartDate}&criteria.DriverId={criteria.DriverId}&criteria.JobId={criteria.JobId}&paging.PageNumber={paging.PageNumber}&paging.PageSize={paging.PageSize}&paging.PagingMaxId={paging.PagingMaxId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
ApiKey

Your merchant API key

globally unique identifier

None.

StartDate

Filters the results to only show ratings starting at a specific date/time (UTC)

date

None.

DriverId

Filters by a single driver identifier

globally unique identifier

None.

JobId

Filters by a single job identifier

globally unique identifier

None.

PageNumber

The page number of the results. Note the first page is 1 (not 0). Defaults to first page.

integer

None.

PageSize

The amount of items to display in each page. Defaults to 50 records.

integer

None.

PagingMaxId

integer

None.

Body Parameters

None.

Response Information

Resource Description

PagedApiListOfJobHandlerRatingModel
NameDescriptionTypeAdditional information
CurrentPage

integer

None.

PageCount

integer

None.

PageSize

integer

None.

TotalCount

integer

None.

FirstPageUrl

string

None.

PreviousPageUrl

string

None.

NextPageUrl

string

None.

LastPageUrl

string

None.

Data

Collection of JobHandlerRatingModel

None.

Response Formats

application/json, text/json

Sample:
{
  "currentPage": 1,
  "pageCount": 2,
  "pageSize": 3,
  "totalCount": 4,
  "firstPageUrl": "sample string 5",
  "previousPageUrl": "sample string 6",
  "nextPageUrl": "sample string 7",
  "lastPageUrl": "sample string 8",
  "data": [
    {
      "identifier": "63d60669-1571-4882-a3ff-5da5336975e5",
      "jobId": "85003f19-32a5-4445-b716-013baff7e4c0",
      "created": "2019-10-15T11:12:09.0209208+00:00",
      "comments": "sample string 4",
      "percentageRating": 5.1
    },
    {
      "identifier": "63d60669-1571-4882-a3ff-5da5336975e5",
      "jobId": "85003f19-32a5-4445-b716-013baff7e4c0",
      "created": "2019-10-15T11:12:09.0209208+00:00",
      "comments": "sample string 4",
      "percentageRating": 5.1
    }
  ]
}

text/xml

Sample:
<PagedApiListOfJobHandlerRatingModelA5vRCwJ4 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Swift.DeliveryAPI2">
  <CurrentPage>1</CurrentPage>
  <Data>
    <JobHandlerRatingModel>
      <Comments>sample string 4</Comments>
      <Created>2019-10-15T11:12:09.0209208+00:00</Created>
      <Identifier>63d60669-1571-4882-a3ff-5da5336975e5</Identifier>
      <JobId>85003f19-32a5-4445-b716-013baff7e4c0</JobId>
      <PercentageRating>5.1</PercentageRating>
    </JobHandlerRatingModel>
    <JobHandlerRatingModel>
      <Comments>sample string 4</Comments>
      <Created>2019-10-15T11:12:09.0209208+00:00</Created>
      <Identifier>63d60669-1571-4882-a3ff-5da5336975e5</Identifier>
      <JobId>85003f19-32a5-4445-b716-013baff7e4c0</JobId>
      <PercentageRating>5.1</PercentageRating>
    </JobHandlerRatingModel>
  </Data>
  <FirstPageUrl>sample string 5</FirstPageUrl>
  <LastPageUrl>sample string 8</LastPageUrl>
  <NextPageUrl>sample string 7</NextPageUrl>
  <PageCount>2</PageCount>
  <PageSize>3</PageSize>
  <PreviousPageUrl>sample string 6</PreviousPageUrl>
  <TotalCount>4</TotalCount>
</PagedApiListOfJobHandlerRatingModelA5vRCwJ4>