POST api/caregiver/messages/caregiver/send
Request Information
URI Parameters
None.
Body Parameters
CaregiverMessageRequestName | Description | Type | Additional information |
---|---|---|---|
CustomerID | decimal number |
Required |
|
EmployeeID | decimal number |
Required |
|
Pin | string |
Required |
|
Message | string |
Required |
|
ReplyToMessageID | decimal number |
None. |
Request Formats
application/json, text/json
Sample:
{ "CustomerID": 1.0, "EmployeeID": 2.0, "Pin": "sample string 3", "Message": "sample string 4", "ReplyToMessageID": 5.0 }
application/xml, text/xml
Sample:
<CaregiverMessageRequest 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> <ReplyToMessageID>5</ReplyToMessageID> </CaregiverMessageRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
SentMessageResponseName | Description | Type | Additional 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>