GET api/public/v2/ratings/{id}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
JobHandlerRatingModel| Name | Description | Type | Additional 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": "77168478-6a84-44bb-938f-f2ba733ccc77",
"jobId": "627de626-9606-4383-a129-fe860400a06f",
"created": "2020-10-27T00:20:03.6440528+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>2020-10-27T00:20:03.6440528+00:00</Created> <Identifier>77168478-6a84-44bb-938f-f2ba733ccc77</Identifier> <JobId>627de626-9606-4383-a129-fe860400a06f</JobId> <PercentageRating>5.1</PercentageRating> </JobHandlerRatingModel>