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": "b454ed2a-eb56-4d79-913d-ec5a84b0253a",
"jobId": "d9ebe205-e708-48e6-b6f5-202b50f29189",
"created": "2022-10-01T01:43:11.8317981+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>2022-10-01T01:43:11.8317981+00:00</Created> <Identifier>b454ed2a-eb56-4d79-913d-ec5a84b0253a</Identifier> <JobId>d9ebe205-e708-48e6-b6f5-202b50f29189</JobId> <PercentageRating>5.1</PercentageRating> </JobHandlerRatingModel>