GET api/v2/ratings/{id}

View a rating

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

JobHandlerRatingModel
NameDescriptionTypeAdditional information
Identifier

Rating identifier

globally unique identifier

None.

JobId

Transport job identifier

globally unique identifier

None.

Created

The date/time (UTC) that the rating was created

date

None.

Comments

Comments about the rating

string

None.

PercentageRating

The rating percentage value [0; 100]

decimal number

None.

Response Formats

application/json, text/json

Sample:
{
  "identifier": "edce6bc6-9ab6-4a83-a88e-416075102d02",
  "jobId": "884f71ee-fb82-4bc9-89fe-842f5131e641",
  "created": "2019-07-17T09:02:22.973658+00:00",
  "comments": "sample string 4",
  "percentageRating": 5.1
}

text/xml

Sample:
<JobHandlerRatingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Swift.DeliveryAPI2">
  <Comments>sample string 4</Comments>
  <Created>2019-07-17T09:02:22.973658+00:00</Created>
  <Identifier>edce6bc6-9ab6-4a83-a88e-416075102d02</Identifier>
  <JobId>884f71ee-fb82-4bc9-89fe-842f5131e641</JobId>
  <PercentageRating>5.1</PercentageRating>
</JobHandlerRatingModel>