POST api/caregiver/login

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Email	string	Required
Pin	string	Required
DeviceID	string	None.
DeviceType	DeviceType	None.
Application	Application	None.

Request Formats

application/json, text/json

Sample:

{
  "Email": "sample string 1",
  "Pin": "sample string 2",
  "DeviceID": "sample string 3",
  "DeviceType": 0,
  "Application": 0
}

application/xml, text/xml

Sample:

<Login xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models">
  <Application>FirstLight</Application>
  <DeviceID>sample string 3</DeviceID>
  <DeviceType>FCM</DeviceType>
  <Email>sample string 1</Email>
  <Pin>sample string 2</Pin>
</Login>

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

Response Information

Resource Description

LoginResponse

Name	Type	Additional information
CustomerID	decimal number	None.
EmployeeID	decimal number	None.
Messaging	integer	None.
Login	string	None.
Password	string	None.
MyName	string	None.
OfflineMode	boolean	None.
AskQuestions	boolean	None.
AvailableStatus	integer	None.
AvailableToDateTime	date	None.
CompanyName	string	None.
TelephoneNumber	string	None.

Response Formats

application/json, text/json

Sample:

{
  "CustomerID": 1.0,
  "EmployeeID": 2.0,
  "Messaging": 3,
  "Login": "sample string 4",
  "Password": "sample string 5",
  "MyName": "sample string 6",
  "OfflineMode": true,
  "AskQuestions": true,
  "AvailableStatus": 9,
  "AvailableToDateTime": "2026-01-10T22:14:07.0421199-08:00",
  "CompanyName": "sample string 10",
  "TelephoneNumber": "sample string 11"
}

application/xml, text/xml

Sample:

<LoginResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models">
  <AskQuestions>true</AskQuestions>
  <AvailableStatus>9</AvailableStatus>
  <AvailableToDateTime>2026-01-10T22:14:07.0421199-08:00</AvailableToDateTime>
  <CompanyName>sample string 10</CompanyName>
  <CustomerID>1</CustomerID>
  <EmployeeID>2</EmployeeID>
  <Login>sample string 4</Login>
  <Messaging>3</Messaging>
  <MyName>sample string 6</MyName>
  <OfflineMode>true</OfflineMode>
  <Password>sample string 5</Password>
  <TelephoneNumber>sample string 11</TelephoneNumber>
</LoginResponse>