DELETE api/Appointments/DeletetblAppointment/{param1}?id={id}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

param1

string

None.

Body Parameters

None.

Response Information

Resource Description

tblAppointment
NameDescriptionTypeAdditional information
appointmentID

integer

None.

appointmentCompanyID

integer

None.

appointmentUserID

integer

None.

appointmentClientID

integer

None.

appointmentQualificationLevel

string

None.

appointmentReferenceNumber

string

None.

appointmentDate

date

None.

appointmentStartTime

date

None.

appointmentEndTime

date

None.

appointmentStartPriority

integer

None.

appointmentStartTime_Marked

date

None.

appointmentEndTime_Marked

date

None.

appointmentStartTime_Actual

date

None.

appointmentEndTime_Actual

date

None.

appointmentDuration

integer

None.

appointmentNotes

string

None.

appointmentNotes_Carer

string

None.

appointmentNotes_Admin

string

None.

appointmentEstCarerCost

decimal number

None.

appointmentCost

decimal number

None.

appointmentShiftCode

string

None.

appointmentStatus1

integer

None.

appointmentStatus2

integer

None.

appointmentStatus3

integer

None.

appointmentStatusTags

string

None.

appointmentTasks

string

None.

appointmentTaskBreakdown

string

None.

appointmentLastconfirmedStatus

string

None.

appointmentMedications

string

None.

appointmentMedicationDetails

string

None.

appointmentEquipment

string

None.

appointmentEquipmentDetails

string

None.

appointmentLastUpdated

date

None.

appointmentPhotos

string

None.

appointmentRepeat

boolean

None.

appointmentParentRepeatID

integer

None.

appointmentRepeatStart

date

None.

appointmentRepeatEnd

date

None.

appointmentRepeatFrequency

string

None.

appointmentKM1

decimal number

None.

appointmentKM2

decimal number

None.

appointmentFlexibility

string

None.

appointmentStatus4

decimal number

None.

appointmentEndsNextDay

boolean

None.

appointmentPayrollCategory

integer

None.

appointmentServiceType

integer

None.

appointmentExtraCharge1

string

None.

appointmentExtraCharge1_type

string

None.

appointmentChargeableCancellation

boolean

None.

appointmentChargeableCancellationDetails

string

None.

appointmentPackageOverride

integer

None.

appointmentTimeVarianceAccepted

boolean

None.

appointmentRepeatWeekday

string

None.

appointmentRepeatWeekCount

integer

None.

appointmentTravel1

integer

None.

appointmentSignaturePath

string

None.

appointmentVehicleType

string

None.

appointmentExcludeFromPayroll

boolean

None.

appointmentMultiUserIDs

string

None.

appointmentMultiUser

boolean

None.

appointmentRejectedUserIDS

string

None.

appointmentTransport_Pickup

integer

None.

appointmentTransport_Dropoff

integer

None.

appointmentBranch

integer

None.

appointmentMultiClientIDS

string

None.

appointmentMultiClient

boolean

None.

appointmentTravelVariance

byte

None.

appointmentTravelVarianceDetails

string

None.

appointmentLocationOverride

integer

None.

appointmentCancellationReason

string

None.

appointmentCancellationReason_Note

string

None.

appointmentEquipmentChargesApproved

boolean

None.

appointmentCustomEntries

string

None.

appointmentPackageFixed

integer

None.

appointmentUnidentifiedClients

integer

None.

appointmentLeaveEntry

integer

None.

appointmentBreakDuration

integer

None.

appointmentTax

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "appointmentID": 1,
  "appointmentCompanyID": 1,
  "appointmentUserID": 1,
  "appointmentClientID": 1,
  "appointmentQualificationLevel": "sample string 2",
  "appointmentReferenceNumber": "sample string 3",
  "appointmentDate": "2024-10-15T17:42:51.4044848-07:00",
  "appointmentStartTime": "2024-10-15T17:42:51.4044848-07:00",
  "appointmentEndTime": "2024-10-15T17:42:51.4044848-07:00",
  "appointmentStartPriority": 1,
  "appointmentStartTime_Marked": "2024-10-15T17:42:51.4044848-07:00",
  "appointmentEndTime_Marked": "2024-10-15T17:42:51.4044848-07:00",
  "appointmentStartTime_Actual": "2024-10-15T17:42:51.4044848-07:00",
  "appointmentEndTime_Actual": "2024-10-15T17:42:51.4044848-07:00",
  "appointmentDuration": 1,
  "appointmentNotes": "sample string 4",
  "appointmentNotes_Carer": "sample string 5",
  "appointmentNotes_Admin": "sample string 6",
  "appointmentEstCarerCost": 1.1,
  "appointmentCost": 1.1,
  "appointmentShiftCode": "sample string 7",
  "appointmentStatus1": 1,
  "appointmentStatus2": 1,
  "appointmentStatus3": 1,
  "appointmentStatusTags": "sample string 8",
  "appointmentTasks": "sample string 9",
  "appointmentTaskBreakdown": "sample string 10",
  "appointmentLastconfirmedStatus": "sample string 11",
  "appointmentMedications": "sample string 12",
  "appointmentMedicationDetails": "sample string 13",
  "appointmentEquipment": "sample string 14",
  "appointmentEquipmentDetails": "sample string 15",
  "appointmentLastUpdated": "2024-10-15T17:42:51.4044848-07:00",
  "appointmentPhotos": "sample string 16",
  "appointmentRepeat": true,
  "appointmentParentRepeatID": 1,
  "appointmentRepeatStart": "2024-10-15T17:42:51.4044848-07:00",
  "appointmentRepeatEnd": "2024-10-15T17:42:51.4044848-07:00",
  "appointmentRepeatFrequency": "sample string 17",
  "appointmentKM1": 1.1,
  "appointmentKM2": 1.1,
  "appointmentFlexibility": "sample string 18",
  "appointmentStatus4": 1.1,
  "appointmentEndsNextDay": true,
  "appointmentPayrollCategory": 1,
  "appointmentServiceType": 1,
  "appointmentExtraCharge1": "sample string 19",
  "appointmentExtraCharge1_type": "sample string 20",
  "appointmentChargeableCancellation": true,
  "appointmentChargeableCancellationDetails": "sample string 21",
  "appointmentPackageOverride": 1,
  "appointmentTimeVarianceAccepted": true,
  "appointmentRepeatWeekday": "sample string 22",
  "appointmentRepeatWeekCount": 1,
  "appointmentTravel1": 1,
  "appointmentSignaturePath": "sample string 23",
  "appointmentVehicleType": "sample string 24",
  "appointmentExcludeFromPayroll": true,
  "appointmentMultiUserIDs": "sample string 25",
  "appointmentMultiUser": true,
  "appointmentRejectedUserIDS": "sample string 26",
  "appointmentTransport_Pickup": 1,
  "appointmentTransport_Dropoff": 1,
  "appointmentBranch": 1,
  "appointmentMultiClientIDS": "sample string 27",
  "appointmentMultiClient": true,
  "appointmentTravelVariance": 64,
  "appointmentTravelVarianceDetails": "sample string 28",
  "appointmentLocationOverride": 1,
  "appointmentCancellationReason": "sample string 29",
  "appointmentCancellationReason_Note": "sample string 30",
  "appointmentEquipmentChargesApproved": true,
  "appointmentCustomEntries": "sample string 31",
  "appointmentPackageFixed": 1,
  "appointmentUnidentifiedClients": 1,
  "appointmentLeaveEntry": 1,
  "appointmentBreakDuration": 1,
  "appointmentTax": 1
}

application/xml, text/xml

Sample:
<tblAppointment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.WebAPI">
  <appointmentBranch>1</appointmentBranch>
  <appointmentBreakDuration>1</appointmentBreakDuration>
  <appointmentCancellationReason>sample string 29</appointmentCancellationReason>
  <appointmentCancellationReason_Note>sample string 30</appointmentCancellationReason_Note>
  <appointmentChargeableCancellation>true</appointmentChargeableCancellation>
  <appointmentChargeableCancellationDetails>sample string 21</appointmentChargeableCancellationDetails>
  <appointmentClientID>1</appointmentClientID>
  <appointmentCompanyID>1</appointmentCompanyID>
  <appointmentCost>1.1</appointmentCost>
  <appointmentCustomEntries>sample string 31</appointmentCustomEntries>
  <appointmentDate>2024-10-15T17:42:51.4044848-07:00</appointmentDate>
  <appointmentDuration>1</appointmentDuration>
  <appointmentEndTime>2024-10-15T17:42:51.4044848-07:00</appointmentEndTime>
  <appointmentEndTime_Actual>2024-10-15T17:42:51.4044848-07:00</appointmentEndTime_Actual>
  <appointmentEndTime_Marked>2024-10-15T17:42:51.4044848-07:00</appointmentEndTime_Marked>
  <appointmentEndsNextDay>true</appointmentEndsNextDay>
  <appointmentEquipment>sample string 14</appointmentEquipment>
  <appointmentEquipmentChargesApproved>true</appointmentEquipmentChargesApproved>
  <appointmentEquipmentDetails>sample string 15</appointmentEquipmentDetails>
  <appointmentEstCarerCost>1.1</appointmentEstCarerCost>
  <appointmentExcludeFromPayroll>true</appointmentExcludeFromPayroll>
  <appointmentExtraCharge1>sample string 19</appointmentExtraCharge1>
  <appointmentExtraCharge1_type>sample string 20</appointmentExtraCharge1_type>
  <appointmentFlexibility>sample string 18</appointmentFlexibility>
  <appointmentID>1</appointmentID>
  <appointmentKM1>1.1</appointmentKM1>
  <appointmentKM2>1.1</appointmentKM2>
  <appointmentLastUpdated>2024-10-15T17:42:51.4044848-07:00</appointmentLastUpdated>
  <appointmentLastconfirmedStatus>sample string 11</appointmentLastconfirmedStatus>
  <appointmentLeaveEntry>1</appointmentLeaveEntry>
  <appointmentLocationOverride>1</appointmentLocationOverride>
  <appointmentMedicationDetails>sample string 13</appointmentMedicationDetails>
  <appointmentMedications>sample string 12</appointmentMedications>
  <appointmentMultiClient>true</appointmentMultiClient>
  <appointmentMultiClientIDS>sample string 27</appointmentMultiClientIDS>
  <appointmentMultiUser>true</appointmentMultiUser>
  <appointmentMultiUserIDs>sample string 25</appointmentMultiUserIDs>
  <appointmentNotes>sample string 4</appointmentNotes>
  <appointmentNotes_Admin>sample string 6</appointmentNotes_Admin>
  <appointmentNotes_Carer>sample string 5</appointmentNotes_Carer>
  <appointmentPackageFixed>1</appointmentPackageFixed>
  <appointmentPackageOverride>1</appointmentPackageOverride>
  <appointmentParentRepeatID>1</appointmentParentRepeatID>
  <appointmentPayrollCategory>1</appointmentPayrollCategory>
  <appointmentPhotos>sample string 16</appointmentPhotos>
  <appointmentQualificationLevel>sample string 2</appointmentQualificationLevel>
  <appointmentReferenceNumber>sample string 3</appointmentReferenceNumber>
  <appointmentRejectedUserIDS>sample string 26</appointmentRejectedUserIDS>
  <appointmentRepeat>true</appointmentRepeat>
  <appointmentRepeatEnd>2024-10-15T17:42:51.4044848-07:00</appointmentRepeatEnd>
  <appointmentRepeatFrequency>sample string 17</appointmentRepeatFrequency>
  <appointmentRepeatStart>2024-10-15T17:42:51.4044848-07:00</appointmentRepeatStart>
  <appointmentRepeatWeekCount>1</appointmentRepeatWeekCount>
  <appointmentRepeatWeekday>sample string 22</appointmentRepeatWeekday>
  <appointmentServiceType>1</appointmentServiceType>
  <appointmentShiftCode>sample string 7</appointmentShiftCode>
  <appointmentSignaturePath>sample string 23</appointmentSignaturePath>
  <appointmentStartPriority>1</appointmentStartPriority>
  <appointmentStartTime>2024-10-15T17:42:51.4044848-07:00</appointmentStartTime>
  <appointmentStartTime_Actual>2024-10-15T17:42:51.4044848-07:00</appointmentStartTime_Actual>
  <appointmentStartTime_Marked>2024-10-15T17:42:51.4044848-07:00</appointmentStartTime_Marked>
  <appointmentStatus1>1</appointmentStatus1>
  <appointmentStatus2>1</appointmentStatus2>
  <appointmentStatus3>1</appointmentStatus3>
  <appointmentStatus4>1.1</appointmentStatus4>
  <appointmentStatusTags>sample string 8</appointmentStatusTags>
  <appointmentTaskBreakdown>sample string 10</appointmentTaskBreakdown>
  <appointmentTasks>sample string 9</appointmentTasks>
  <appointmentTax>1</appointmentTax>
  <appointmentTimeVarianceAccepted>true</appointmentTimeVarianceAccepted>
  <appointmentTransport_Dropoff>1</appointmentTransport_Dropoff>
  <appointmentTransport_Pickup>1</appointmentTransport_Pickup>
  <appointmentTravel1>1</appointmentTravel1>
  <appointmentTravelVariance>64</appointmentTravelVariance>
  <appointmentTravelVarianceDetails>sample string 28</appointmentTravelVarianceDetails>
  <appointmentUnidentifiedClients>1</appointmentUnidentifiedClients>
  <appointmentUserID>1</appointmentUserID>
  <appointmentVehicleType>sample string 24</appointmentVehicleType>
</tblAppointment>