SWAPI – TimeSlotCapacityQuery

Use this command to obtain capacity settings and actual call booked for slots between two times/dates.

Request

<SessionRequest Version="string" SessionID="{20D6D532-D0E2-4B38-98AA-F240EB21DC68}" RequestID="string">

  <TimeSlotCapacityQuery Filter="string" Max="string" OrderBy="string" StyleNo="string" StyleOptions="string">

    <StartDate>dateTime</StartDate>

    <EndDate>dateTime</EndDate>

    <GroupNames>string</GroupNames>

    <TimeSlots>string</TimeSlots>

  </TimeSlotCapacityQuery>

</SessionRequest>

 

·         StartDate – The starting date to query for

·         EndDate - The ending date to query for

·         GroupNames – A comma separated list of group names to query for. Use ALL or leave blank to return every group.

o    Valid group names can be obtained from the TimeSlotDefaultsQuery SWAPI command.

·         TimeSlotsA comma separated list of time slot names to query for. Use ALL or leave blank to return every time slot.

o    Valid time slot names can be obtained from the TimeSlotDefaultsQuery SWAPI command.

Response

<?xml version="1.0"?>

<TimeSlotCapacityQueryResponse Successful="true" ResultCode="000" ResultText="Successful" Version="1.9.900.1" RequestID="string">

  <TimeSlotCapacityQueryData ReturnedRows="" FilteredRows="" TotalRows="" QueryOptions="StartDate=1/1/2019, EndDate=1/1/2019">

    <TimeSlotCapacityQueryRecord>

      <GroupName>string</GroupName>

      <ScheduleDate>date</ScheduleDate>

      <DayOfWeek>string</DayOfWeek>

      <SlotName>string</SlotName>

      <ScheduledAppts>integer</ScheduledAppts>

      <MaxAppts>integer</MaxAppts>

      <BeginTime>time</BeginTime>

      <EndTime>time</EndTime>

    </TimeSlotCapacityQueryRecord>

</TimeSlotCapacityQueryResponse>

 

·         GroupName – The time slot group name

·         ScheduleDate The date of the appointments

·         DayText The day of the week for the ScheduledDate

·         SlotNameThe name of the time slot

·         ScheduledAppts The number of appointments currently scheduled in the time slot

·         MaxApptsThe maximum capacity for the time slot

·         BeginTimeThe starting time for the time slot

·         EndTime - The ending time for the time slot