v1

latestOpenAPI 3.0.12026-07-245752052.0 MB

demands

Creates bulk demand for a given period

post/api/serviceattendance/processes/demand/bulkCreate

Request body

externalIdstring

Id of the demand from an external service

namestring

Name of the demand

locationUuidstring uuid required

Location unique identifier

jobUuidstring uuid required

Job unique identifier

startDatestring required

Date to start creating demand

endDatestring required

Date to stop creating demand

daysOfWeekstring[] required

Example request

{
  "externalId": "SF-123456",
  "name": "Lifeguards for 04/01 - 04/15",
  "locationUuid": "123e4567-e89b-12d3-a456-426614174000",
  "jobUuid": "1a55b750-7cdc-43b3-ace5-1c5a645a200c",
  "startDate": "2025-04-01T00:00:00Z",
  "endDate": "2025-04-15T00:00:00Z",
  "daysOfWeek": [
    1,
    3,
    5
  ],
  "headcountChanges": {
    "startTime": "2025-04-01T09:00:00Z",
    "endTime": "2025-04-01T14:00:00Z",
    "minimumHeadcount": 5,
    "maximumHeadcount": 7
  }
}

Response

The list of pending worker demand created for the given period

Example response

{
  "data": [
    {
      "uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
      "createdAt": "2021-05-05T01:02:03.924Z",
      "createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
      "lastUpdatedAt": "2021-05-05T04:05:06.924Z",
      "lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
      "lastUpdatedByAudience": "employer",
      "lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
      "lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
      "lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
      "lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
      "externalId": "1682693",
      "companyUuid": "cf8fc0c8-b8e7-4337-992e-8f71d67bdf5b",
      "name": "Apr 5th - Apr 26 lifeguards",
      "locationUuid": "79b30b2b-eea5-410f-b994-b01be9fa4f40",
      "jobUuid": "79b30b2b-eea5-410f-b994-b01be9fa4f40",
      "date": "2000-01-01T00:00:00Z",
      "headcountChanges": [
        {
          "startTime": "2000-01-01T15:30:00Z",
          "endTime": "2000-01-01T18:30:00Z"
        }
      ]
    }
  ]
}