POST api/caregiver/messages/supervisor/send

Request Information

URI Parameters

None.

Body Parameters

SupervisorMessageRequest
NameDescriptionTypeAdditional information
CustomerID

decimal number

Required

EmployeeID

decimal number

Required

Pin

string

Required

Message

string

Required

UserName

string

Required

Request Formats

application/json, text/json

Sample:
{
  "CustomerID": 1.0,
  "EmployeeID": 2.0,
  "Pin": "sample string 3",
  "Message": "sample string 4",
  "UserName": "sample string 5"
}

application/xml, text/xml

Sample:
<SupervisorMessageRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models.Message">
  <CustomerID>1</CustomerID>
  <EmployeeID>2</EmployeeID>
  <Message>sample string 4</Message>
  <Pin>sample string 3</Pin>
  <UserName>sample string 5</UserName>
</SupervisorMessageRequest>

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

Response Information

Resource Description

SentMessageResponse
NameDescriptionTypeAdditional information
Devices

Collection of Device

None.

Notifications

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "Devices": null,
  "Notifications": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<SentMessageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models.Message">
  <Devices i:nil="true" />
  <Notifications xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Notifications>
</SentMessageResponse>