POST api/Scheduler/SaveAppointmentData

Request Information

URI Parameters

None.

Body Parameters

AppointmentData
NameDescriptionTypeAdditional information
AppointmentID

integer

None.

Subject

string

None.

StaffTypeIds

string

None.

TeamIds

string

None.

StaffIds

string

None.

LocationIds

string

None.

AppointmentTypeId

integer

None.

AppointmentCategoryId

integer

None.

ServiceIds

string

None.

StartDateTime

date

None.

EndDateTime

date

None.

Duration

integer

None.

AppointmentTimeZone

string

None.

HospitalMedicalProviderID

integer

None.

ExternalProviderGroupId

integer

None.

ExternalProviderId

integer

None.

GroupID

integer

None.

Type

integer

None.

EditAll

boolean

None.

ClientIds

string

None.

AppointmentStatusId

integer

None.

BlockTimeId

integer

None.

ClientData

Collection of string

None.

Recurrence

RecurrenceData

None.

Notes

string

None.

ShowTime

integer

None.

FollowupAppointmentRequestId

integer

None.

FirstOffered

boolean

None.

IsOffSiteAppointment

boolean

None.

offsiteDuration

integer

None.

TraveloffsiteappID

integer

None.

IsbackFacility

boolean

None.

FacilityDuration

integer

None.

TravelFacilityappID

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "AppointmentID": 1,
  "Subject": "sample string 2",
  "StaffTypeIds": "sample string 3",
  "TeamIds": "sample string 4",
  "StaffIds": "sample string 5",
  "LocationIds": "sample string 6",
  "AppointmentTypeId": 7,
  "AppointmentCategoryId": 1,
  "ServiceIds": "sample string 8",
  "StartDateTime": "2026-04-17T12:59:00.6042438+00:00",
  "EndDateTime": "2026-04-17T12:59:00.6042438+00:00",
  "Duration": 9,
  "AppointmentTimeZone": "sample string 10",
  "HospitalMedicalProviderID": 1,
  "ExternalProviderGroupId": 1,
  "ExternalProviderId": 1,
  "GroupID": 1,
  "Type": 11,
  "EditAll": true,
  "ClientIds": "sample string 13",
  "AppointmentStatusId": 14,
  "BlockTimeId": 1,
  "ClientData": [
    "sample string 1",
    "sample string 2"
  ],
  "Recurrence": {
    "RecurrenceId": 1,
    "RecurrenceType": "sample string 2",
    "Interval": 3,
    "Start": "2026-04-17T12:59:00.6042438+00:00",
    "WeekDays": [
      1,
      2
    ],
    "EndOn": {
      "EndsOnType": 1,
      "EndOnCount": 1,
      "EndOnUntil": "2026-04-17T12:59:00.6052428+00:00"
    },
    "DayOf": 1
  },
  "Notes": "sample string 15",
  "ShowTime": 16,
  "FollowupAppointmentRequestId": 1,
  "FirstOffered": true,
  "IsOffSiteAppointment": true,
  "offsiteDuration": 1,
  "TraveloffsiteappID": 1,
  "IsbackFacility": true,
  "FacilityDuration": 1,
  "TravelFacilityappID": 1
}

application/xml, text/xml

Sample:
<AppointmentData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CSI.Cx360.WebAPI.Models.Scheduler">
  <AppointmentCategoryId>1</AppointmentCategoryId>
  <AppointmentID>1</AppointmentID>
  <AppointmentStatusId>14</AppointmentStatusId>
  <AppointmentTimeZone>sample string 10</AppointmentTimeZone>
  <AppointmentTypeId>7</AppointmentTypeId>
  <BlockTimeId>1</BlockTimeId>
  <ClientData xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ClientData>
  <ClientIds>sample string 13</ClientIds>
  <Duration>9</Duration>
  <EditAll>true</EditAll>
  <EndDateTime>2026-04-17T12:59:00.6042438+00:00</EndDateTime>
  <ExternalProviderGroupId>1</ExternalProviderGroupId>
  <ExternalProviderId>1</ExternalProviderId>
  <FacilityDuration>1</FacilityDuration>
  <FirstOffered>true</FirstOffered>
  <FollowupAppointmentRequestId>1</FollowupAppointmentRequestId>
  <GroupID>1</GroupID>
  <HospitalMedicalProviderID>1</HospitalMedicalProviderID>
  <IsOffSiteAppointment>true</IsOffSiteAppointment>
  <IsbackFacility>true</IsbackFacility>
  <LocationIds>sample string 6</LocationIds>
  <Notes>sample string 15</Notes>
  <Recurrence>
    <DayOf>1</DayOf>
    <EndOn>
      <EndOnCount>1</EndOnCount>
      <EndOnUntil>2026-04-17T12:59:00.6052428+00:00</EndOnUntil>
      <EndsOnType>1</EndsOnType>
    </EndOn>
    <Interval>3</Interval>
    <RecurrenceId>1</RecurrenceId>
    <RecurrenceType>sample string 2</RecurrenceType>
    <Start>2026-04-17T12:59:00.6042438+00:00</Start>
    <WeekDays xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </WeekDays>
  </Recurrence>
  <ServiceIds>sample string 8</ServiceIds>
  <ShowTime>16</ShowTime>
  <StaffIds>sample string 5</StaffIds>
  <StaffTypeIds>sample string 3</StaffTypeIds>
  <StartDateTime>2026-04-17T12:59:00.6042438+00:00</StartDateTime>
  <Subject>sample string 2</Subject>
  <TeamIds>sample string 4</TeamIds>
  <TravelFacilityappID>1</TravelFacilityappID>
  <TraveloffsiteappID>1</TraveloffsiteappID>
  <Type>11</Type>
  <offsiteDuration>1</offsiteDuration>
</AppointmentData>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'AppointmentData'.

Response Information

Resource Description

Object

None.

Response Formats

application/json, text/json

Sample:
{}

application/xml, text/xml

Sample:
<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />