ProRoster - Get demand bids
API Url
Use it for loading the bids for a single plan demand.
GET
http://localhost:16010/ProMarkREST/rest/ProRoster/demand/{id}/bids
Permissions: user
Path parameters
| Field | Type | Description |
|---|---|---|
| id | Number | The demand's unique identifier. |
Success 200
| Field | Type | Description |
|---|---|---|
| response | Object | Main object containing the response data. |
| data | Object | Object containing the requested data. |
| bids | Object[] | List of bids. |
| comment | String | Employee's comment. If empty, not sent. |
| demandId | Number | The Id of the plan on which was bidded. |
| empId | String | The Id of the employee who bidded on the shift. |
| empName | String | The name of the employee who bidded on the shift. |
| id | Number | The Id of the bid. |
| status | Number | 1: Employee has bid on the shift. 2: The employee has been assigned the shift. 3: Declined. The employee has been declined by the Manager/Approver. |
messageoptional | Object | Object containing response messages. |
| code | Number | Message code. |
| text | String | Message text. |
| type | String | Type of message. "warning""info" |
Success example:
HTTP/1.1 200 OK{"response": {"data": {"bids": [{"id": 2163182278,"demandId": 2163182268,"empId": "833","empName": "Ciprian Dinu 1","status": 2},{"id": 2163186461,"demandId": 2163182268,"empId": "951","empName": "Joey Tribiani","comment": "BLABLA BLAAAAAAAA","status": 2}]},"errorCode": 0,"errorMessage": ""}}
Error 4xx
| Field | Type | Description |
|---|---|---|
| response | Object | Main object containing the response data. |
| data | Object | Object containing the requested data (empty). |
| errorCode | Number | Error code. |
| errorMessage | String | Error description. |