Get Schedule

GET

https://api.npretail.app/:tenant/:environment/:company/ticket/schedule/search

GET

/:tenant/:environment/:company/ticket/schedule/search

curl -G https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%2520International%2520Ltd./ticket/schedule/search \
     -H "x-np-api-key: <NaviPartner API Key>" \
     -d admissionCode=CASTLE \
     -d startDate=2025-01-31 \
     -d endDate=2025-03-31

200ExampleSchedules

{
  "admissionCode": "CASTLE",
  "capacityControl": "sales",
  "schedules": [
    {
      "externalNumber": 1234,
      "scheduleCode": "MORNING",
      "description": "Morning schedule",
      "startDate": "2025-01-31",
      "startTime": "09:00",
      "endDate": "2024-10-15",
      "endTime": "12:00",
      "duration": 10800,
      "allocatable": true,
      "allocationModel": "capacity",
      "initialCapacity": 1000,
      "explanation": "Ok.",
      "arrivalFromTime": "08:30",
      "arrivalUntilTime": "10:00"
    },
    {
      "externalNumber": 1243,
      "scheduleCode": "EVENING",
      "description": "Evening schedule",
      "startDate": "2024-10-15",
      "startTime": "17:00",
      "endDate": "2024-10-15",
      "endTime": "20:00",
      "duration": 10800,
      "allocatable": true,
      "allocationModel": "capacity",
      "initialCapacity": 1000,
      "explanation": "Ok.",
      "arrivalFromTime": "16:30",
      "arrivalUntilTime": "18:00"
    }
  ]
}

Retrieve the schedule for a period for a ticket admission. Note that an ticket item may have multiple admissions with different schedules so use correct admission.

Authentication

x-np-api-keystring

API Key authentication via header

Path parameters

tenantstringRequired

Your Entra Tenant ID. More details.

environmentstringRequired

Your Business Central Environment. More details.

companystringRequired

Your Business Central Company. More details.

Query parameters

admissionCodestringRequired

A unique code that identifies a specific admission.

startDatedateRequired

A date to use as a starting date of a period for the schedule search.

endDatedateRequired

A date to use as a ending date of a period for the schedule search.

scheduleCodestringOptional

A unique code that identifies a specific admission schedule.

Response

Returns a schedule for the specified ticket admission.

admissionCodestring

A unique code that identifies a specific admission.

capacityControlenum

Admission-level configured capacity control. When scheduleCode is supplied, this is resolved through the admission's capacity-limits rule for that specific schedule. Without scheduleCode, the effective mode may vary across schedules and this value reflects the admission's default.

Allowed values:

scheduleslist of objects

Authentication

Path parameters

Headers

Query parameters

Response