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

FieldTypeDescription
idNumber

The demand's unique identifier.

Success 200

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data.

    bidsObject[]

List of bids.

      commentString

Employee's comment. If empty, not sent.

      demandIdNumber

The Id of the plan on which was bidded.

      empIdString

The Id of the employee who bidded on the shift.

      empNameString

The name of the employee who bidded on the shift.

      idNumber

The Id of the bid.

      statusNumber

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.

  messageoptionalObject

Object containing response messages.

    codeNumber

Message code.

    textString

Message text.

    typeString

Type of message.

Allowed values:"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

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data (empty).

  errorCodeNumber

Error code.

  errorMessageString

Error description.