ProRoster - Get plan bids

API Url

Use it for loading the list of the bids in a plan within a period of time.

GET

http://localhost:16010/ProMarkREST/rest/ProRoster/plans/{id}/bids

Permissions: user

Path parameters

Field	Type	Description
id	Number	The plan's unique identifier.

Query parameters

Field	Type	Description
from`optional`	Date	Start date for loading demands. Default is TODAY - 7.
to`optional`	Date	End date for loading demands. Default is TODAY.

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
bids	Object[]	List of demands.
comment	String	Employee's comment.
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.
message`optional`	Object	Object containing response messages.
code	Number	Message code.
text	String	Message text.
type	String	Type of message. Allowed values:`"warning""info"`

Success example:

HTTP/1.1 200 OK
 {
    "response": {
        "data": {
            "bids": [
                {
                    "id": 2163180529,
                    "demandId": 2163178001,
                    "empId": "951",
                    "empName": "Joey Tribiani",
                    "comment": "Here is my new phone number: xxxxxxxxxxx",
                    "status": 1
                },
                {
                    "id": 2163180451,
                    "demandId": 2163178307,
                    "id": 2163178822,
                    "empId": "951",
                    "empName": "Joey Tribiani",
                    "comment": "",
                    "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.