POST Public/SingleSend
Request Information
URI Parameters
None.
Body Parameters
PatientComms.API.Public.DTOs.Request.SingleSendRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| APIKey | globally unique identifier |
Required |
|
| Username | string |
Required |
|
| Destination | integer |
Required |
|
| Source | string |
Required String length: inclusive between 3 and 14 |
|
| Message | string |
Required String length: inclusive between 0 and 612 |
|
| CustomerSiteId | string |
String length: inclusive between 0 and 100 |
|
| ScheduleDateTime | date |
None. |
|
| UseTwoWay | boolean |
None. |
|
| RestrictSends | boolean |
None. |
|
| Date | date |
None. |
|
| Times | Collection of date |
None. |
Request Formats
application/json, text/json
Sample:
{
"APIKey": "f2fd4bd7-61b1-4eb1-b666-0972ccef4f18",
"Username": "sample string 2",
"Destination": 3,
"Source": "sample string 4",
"Message": "sample string 5",
"CustomerSiteId": "sample string 6",
"ScheduleDateTime": "2024-10-02T11:12:22.4213452+01:00",
"UseTwoWay": true,
"RestrictSends": true,
"Date": "2024-10-02T11:12:22.4213452+01:00",
"Times": [
"2024-10-02T11:12:22.4213452+01:00",
"2024-10-02T11:12:22.4213452+01:00"
]
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
System.Web.Http.IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.