POST api/Scheduler/GetAppointmentDetails

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
UserId	integer	None.
CurrentCompanyId	integer	None.
StaffTypeIds	string	None.
StaffIds	string	None.
LocationIds	string	None.
AppointmentStatus	string	None.
ProgramIds	string	None.
ClientIds	string	None.
TimeOffSet	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:

{
  "UserId": 1,
  "CurrentCompanyId": 2,
  "StaffTypeIds": "sample string 3",
  "StaffIds": "sample string 4",
  "LocationIds": "sample string 5",
  "AppointmentStatus": "sample string 6",
  "ProgramIds": "sample string 7",
  "ClientIds": "sample string 8",
  "TimeOffSet": 9,
  "FollowupAppointmentRequestId": 1,
  "FirstOffered": true,
  "IsOffSiteAppointment": true,
  "offsiteDuration": 1,
  "TraveloffsiteappID": 1,
  "IsbackFacility": true,
  "FacilityDuration": 1,
  "TravelFacilityappID": 1
}

application/xml, text/xml

Sample:

<Appointment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CSI.Cx360.WebAPI.Models">
  <AppointmentStatus>sample string 6</AppointmentStatus>
  <ClientIds>sample string 8</ClientIds>
  <CurrentCompanyId>2</CurrentCompanyId>
  <FacilityDuration>1</FacilityDuration>
  <FirstOffered>true</FirstOffered>
  <FollowupAppointmentRequestId>1</FollowupAppointmentRequestId>
  <IsOffSiteAppointment>true</IsOffSiteAppointment>
  <IsbackFacility>true</IsbackFacility>
  <LocationIds>sample string 5</LocationIds>
  <ProgramIds>sample string 7</ProgramIds>
  <StaffIds>sample string 4</StaffIds>
  <StaffTypeIds>sample string 3</StaffTypeIds>
  <TimeOffSet>9</TimeOffSet>
  <TravelFacilityappID>1</TravelFacilityappID>
  <TraveloffsiteappID>1</TraveloffsiteappID>
  <UserId>1</UserId>
  <offsiteDuration>1</offsiteDuration>
</Appointment>

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 'Appointment'.

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/" />