Create a listing time slot

POST /listings/{listingId}/time-slots
OAuth2

Create a listing time slot

Headers

  • Authorization string

    Bearer token used for authorization

    Minimum length is 1.

  • X-Correlation-Id string

    Unique identifier to allow referencing a particular transaction or event chain

    Minimum length is 1.

Path parameters

application/json

Body Required

Responses

  • 201 application/json

    Successful operation

    Hide response attribute Show response attribute object
    • data object Required

      Additional properties are NOT allowed.

      Hide data attributes Show data attributes object
      • id string Required

        Minimum length is 1.

      • listing object Required

        Additional properties are NOT allowed.

        Hide listing attribute Show listing attribute object
        • id string Required

          Minimum length is 1.

      • date string Required

        Minimum length is 1.

      • startTime string Required

        Minimum length is 1.

      • endTime string Required

        Minimum length is 1.

      • bookable boolean Required
      • assignments array[object] Required
        Hide assignments attributes Show assignments attributes object
        • employee object Required

          Additional properties are NOT allowed.

          Hide employee attribute Show employee attribute object
          • id string Required

            Minimum length is 1.

        • exclusive boolean Required
      • createdAt string(date-time) Required

        Minimum length is 1.

      • updatedAt string(date-time) Required

        Minimum length is 1.
  • 404 application/json

    Resource not found

    Hide response attribute Show response attribute object
    • errors array[object] Required

      At least 1 element.

      Hide errors attributes Show errors attributes object
      • message string Required

        Minimum length is 1.

      • code string Required

        Minimum length is 1.

      • type string Required

        Minimum length is 1.

      • statusCode string Required

        Minimum length is 1.
  • 422 application/json

    Business validation failed

    • LISTING_TIME_SLOT_EMPLOYEE_NOT_LINKED
    • LISTING_TIME_SLOT_OVERLAP

    See Error codes

    Hide response attribute Show response attribute object
    • errors array[object] Required

      At least 1 element.

      Hide errors attributes Show errors attributes object
      • message string Required

        Minimum length is 1.

      • code string Required

        Minimum length is 1.

      • type string Required

        Minimum length is 1.

      • statusCode string Required

        Minimum length is 1.

      • arguments object | null

        Additional properties are allowed.
POST /listings/{listingId}/time-slots 
curl \
 -X POST https://api.development.pexipengage.com/enterprises/acme/listings/123/time-slots \
 -H "Content-Type: application/json" \
 -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
 -H "X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002" \
 -d '{"date":"2022-08-01","startTime":"09:00","endTime":"17:00","bookable":true,"assignments":[{"employeeId":"123","exclusive":true}]}'
Request examples 
# Headers
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002

# Payload
{
  "date": "2022-08-01",
  "startTime": "09:00",
  "endTime": "17:00",
  "bookable": true,
  "assignments": [
    {
      "employeeId": "123",
      "exclusive": true
    }
  ]
}
Response examples (201) 
{
  "data": {
    "id": "123",
    "listing": {
      "id": "123"
    },
    "date": "2022-08-01",
    "startTime": "09:00",
    "endTime": "17:00",
    "bookable": true,
    "assignments": [
      {
        "employee": {
          "id": "123"
        },
        "exclusive": true
      }
    ],
    "createdAt": "2022-08-17T19:05:21.362Z",
    "updatedAt": "2022-08-17T19:05:21.362Z"
  }
}
Response examples (404) 
{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "type": "string",
      "statusCode": "string"
    }
  ]
}
Response examples (422) 
{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "type": "string",
      "statusCode": "string",
      "arguments": {}
    }
  ]
}