POST api/caregiver/departure

Request Information

URI Parameters

None.

Body Parameters

DepartureRequest
NameDescriptionTypeAdditional information
CustomerID

decimal number

Required

ClientID

decimal number

Required

EmployeeID

decimal number

Required

Pin

string

Required

Milage

decimal number

Required

MenuOptions

string

Required

Notes

string

Required

Latitude

decimal number

Required

Longitude

decimal number

Required

Signature

string

None.

CaregiverSignature

string

None.

DepartureTime

date

None.

ServiceID

decimal number

None.

Request Formats

application/json, text/json

Sample:
{
  "CustomerID": 1.0,
  "ClientID": 2.0,
  "EmployeeID": 3.0,
  "Pin": "sample string 4",
  "Milage": 5.0,
  "MenuOptions": "sample string 6",
  "Notes": "sample string 7",
  "Latitude": 8.0,
  "Longitude": 9.0,
  "Signature": "sample string 10",
  "CaregiverSignature": "sample string 11",
  "DepartureTime": "2025-04-25T05:15:30.9689817-07:00",
  "ServiceID": 1.0
}

application/xml, text/xml

Sample:
<DepartureRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models">
  <CaregiverSignature>sample string 11</CaregiverSignature>
  <ClientID>2</ClientID>
  <CustomerID>1</CustomerID>
  <DepartureTime>2025-04-25T05:15:30.9689817-07:00</DepartureTime>
  <EmployeeID>3</EmployeeID>
  <Latitude>8</Latitude>
  <Longitude>9</Longitude>
  <MenuOptions>sample string 6</MenuOptions>
  <Milage>5</Milage>
  <Notes>sample string 7</Notes>
  <Pin>sample string 4</Pin>
  <ServiceID>1</ServiceID>
  <Signature>sample string 10</Signature>
</DepartureRequest>

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

Response Information

Resource Description

Departure
NameDescriptionTypeAdditional information
DepartureTime

decimal number

None.

FirstName

string

None.

LastName

string

None.

Street

string

None.

City

string

None.

State

string

None.

Zip

string

None.

Response Formats

application/json, text/json

Sample:
{
  "DepartureTime": 1.0,
  "FirstName": "sample string 2",
  "LastName": "sample string 3",
  "Street": "sample string 4",
  "City": "sample string 5",
  "State": "sample string 6",
  "Zip": "sample string 7"
}

application/xml, text/xml

Sample:
<Departure xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models">
  <City>sample string 5</City>
  <DepartureTime>1</DepartureTime>
  <FirstName>sample string 2</FirstName>
  <LastName>sample string 3</LastName>
  <State>sample string 6</State>
  <Street>sample string 4</Street>
  <Zip>sample string 7</Zip>
</Departure>