Help Page Home

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": "11cd29b3-1e04-4d9f-9579-2dc03895781b",
  "jobId": "36cfa718-ce33-43e2-bf2c-cc90751c67ab",
  "created": "2023-09-25T03:03:03.8411866+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>2023-09-25T03:03:03.8411866+00:00</Created>
  <Identifier>11cd29b3-1e04-4d9f-9579-2dc03895781b</Identifier>
  <JobId>36cfa718-ce33-43e2-bf2c-cc90751c67ab</JobId>
  <PercentageRating>5.1</PercentageRating>
</JobHandlerRatingModel>