POST api/Appointments/CancelAppointment

Request Information

URI Parameters

None.

Body Parameters

CancelAppointmentRequest
NameDescriptionTypeAdditional information
FolderPaths

Collection of string

None.
PatientIds

Collection of integer

None.
Type

string

None.
Files

Collection of RequestFileDTO

None.
ChartType

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "folderPaths": [
    "sample string 1",
    "sample string 2"
  ],
  "patientIds": [
    1,
    2
  ],
  "type": "sample string 1",
  "files": [
    {
      "folderPath": "sample string 1",
      "patientId": 1,
      "encounterType": "sample string 2",
      "hasFiles": true,
      "patientAppointmentId": 1,
      "transcription": "sample string 3",
      "meetingId": "sample string 4",
      "isStat": true,
      "statTime": 1,
      "isDeepGramSelected": true,
      "conversationDataId": 1
    },
    {
      "folderPath": "sample string 1",
      "patientId": 1,
      "encounterType": "sample string 2",
      "hasFiles": true,
      "patientAppointmentId": 1,
      "transcription": "sample string 3",
      "meetingId": "sample string 4",
      "isStat": true,
      "statTime": 1,
      "isDeepGramSelected": true,
      "conversationDataId": 1
    }
  ],
  "chartType": "sample string 2"
}

application/xml, text/xml

Sample: 
<CancelAppointmentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ScribingSoftware.Model.DTO">
  <ChartType>sample string 2</ChartType>
  <Files xmlns:d2p1="http://schemas.datacontract.org/2004/07/ScribingSoftware.Model.BackupFileProcessingDTO">
    <d2p1:RequestFileDTO>
      <d2p1:ConversationDataId>1</d2p1:ConversationDataId>
      <d2p1:EncounterType>sample string 2</d2p1:EncounterType>
      <d2p1:FolderPath>sample string 1</d2p1:FolderPath>
      <d2p1:HasFiles>true</d2p1:HasFiles>
      <d2p1:IsDeepGramSelected>true</d2p1:IsDeepGramSelected>
      <d2p1:IsStat>true</d2p1:IsStat>
      <d2p1:MeetingId>sample string 4</d2p1:MeetingId>
      <d2p1:PatientAppointmentId>1</d2p1:PatientAppointmentId>
      <d2p1:PatientId>1</d2p1:PatientId>
      <d2p1:StatTime>1</d2p1:StatTime>
      <d2p1:Transcription>sample string 3</d2p1:Transcription>
    </d2p1:RequestFileDTO>
    <d2p1:RequestFileDTO>
      <d2p1:ConversationDataId>1</d2p1:ConversationDataId>
      <d2p1:EncounterType>sample string 2</d2p1:EncounterType>
      <d2p1:FolderPath>sample string 1</d2p1:FolderPath>
      <d2p1:HasFiles>true</d2p1:HasFiles>
      <d2p1:IsDeepGramSelected>true</d2p1:IsDeepGramSelected>
      <d2p1:IsStat>true</d2p1:IsStat>
      <d2p1:MeetingId>sample string 4</d2p1:MeetingId>
      <d2p1:PatientAppointmentId>1</d2p1:PatientAppointmentId>
      <d2p1:PatientId>1</d2p1:PatientId>
      <d2p1:StatTime>1</d2p1:StatTime>
      <d2p1:Transcription>sample string 3</d2p1:Transcription>
    </d2p1:RequestFileDTO>
  </Files>
  <FolderPaths xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </FolderPaths>
  <PatientIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </PatientIds>
  <Type>sample string 1</Type>
</CancelAppointmentRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.