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": "205242a0-402c-49fa-94bd-9b0fe37cb838",
"jobId": "697f6017-3ab6-4df0-90ff-df21543f7a57",
"created": "2021-01-15T23:38:05.3559638+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>2021-01-15T23:38:05.3559638+00:00</Created> <Identifier>205242a0-402c-49fa-94bd-9b0fe37cb838</Identifier> <JobId>697f6017-3ab6-4df0-90ff-df21543f7a57</JobId> <PercentageRating>5.1</PercentageRating> </JobHandlerRatingModel>