This API is used to provide a clean view of task information relevant to the order system. It will typically use other services to provide a response but will combine and augment their responses as required
List Available Picks #
Service URL: GET /tasks/orders/availablePicks
Parameters:
No additional parameters are required
Response Body:
IListAvailablePicksResponse:
availablePicksList – List<IAvailablePick> – A list of the available picks
Remarks:
This service requires authentication
This service will return a list of ‘picks’ that can be performed by the authenticated user
Scenarios:
Scenario | Outcome | Expected Behaviour | Status Code | Response | |
---|---|---|---|---|---|
1 | The service is not supplied any Authorisation header | Error | The service will fail to perform any query | 401 | No response body |
2 | The service is supplied an invalid Authorisation header | Error | The service will fail to perform any query | 401 | No response body |
3 | The service is supplied a valid Authorisation header | Success | The service should return a list of available picks that can be performed by the authenticated user. | 200 | IListAvailablePicksResponse |
Example Request:1GET http://localhost:8080/WebRestApi/rest/tasks/orders/availablePicks
{
"availablePicksList": [
{
"orderId": "9",
"fulfilmentId": "1",
"taskId": "a39c48a9-0b1e-471c-b0b5-050a18bbc4d0",
"customerTitle": "Miss",
"customerFistName": "Abigail",
"customerSurname": "Jones",
"orderTotal": 995,
"orderCurrency": "GBP",
"dateCreated": 1604662300000
}
]
}