Update shift

PATCH 
/api/v2/public/marketplace/shifts/:shiftId

General Information

You can update description and bonus, bonus will change the shift quote.

Request

Path Parameters

shiftId stringrequired
Nursa ShiftId
Example: 8222234296

application/json

Body

required

description string

Description of the shift, you can provide detailed information about the shift, it can include any relevant details that would help nurses understand the nature and requirements of the shift.

bonus number

monetary bonus to clinician

Responses

201

application/json

Schema

Schema

data object

shiftId stringrequired

Id of the shift

description stringrequired

Description of the Shift

facilityId stringrequired

Id of the Facility

licenseType stringrequired

License Type of the shift

from date-timerequired

Shift start date

to date-timerequired

Shift end date

price objectrequired

billRatePerHour numberrequired

Price per hour

totalAmount numberrequired

Total price

Example (from schema)

{
  "data": {
    "shiftId": "3663958181",
    "description": "Must take 30 minute break",
    "facilityId": "NUR-12345",
    "licenseType": "CNA",
    "from": "2024-01-01T13:00:00.000Z",
    "to": "2024-01-01T21:00:00.000Z",
    "price": {
      "billRatePerHour": 47.5,
      "totalAmount": 178.8
    }
  }
}

400

Bad request

application/json

Schema

Schema

message string[]

Error description

error string

The type of error

statusCode integer

Status code of the error

Example (from schema)

{
  "message": [
    "Property must be a string"
  ],
  "error": "Bad Request",
  "statusCode": 400
}

Request Validation

Request Validation Error

{
  "message": [
    "description must be a string",
    "bonus must not be less than 0",
    "bonus must be a number conforming to the specified constraints"
  ],
  "error": "Bad Request",
  "statusCode": 400
}

401

Unauthorized

application/json

Schema

Schema

message string

Error description

statusCode integer

Status code of the error

Example (from schema)

{
  "message": "Unauthorized",
  "statusCode": 401
}

403

Forbidden

application/json

Schema

Schema

message string

Error description

error string

The type of error

statusCode integer

Status code of the error

Example (from schema)

{
  "message": "Forbidden Resource",
  "error": "Forbidden",
  "statusCode": 403
}

Loading...