External Connection Web API
HTTP method POST
- Send Calls...SendMessage
Try calls using method HTTP POST
URL Endpoint
/api/Send
SendMessage
Call example: http://localhost:5600/api/Send/SendMessage?notes=123&SerialFormat=json&clientVersion=5.01.003&deviceTicket=18691569&userId=11&stationId=3&messageId=1&tableId=0&deviceIdList=1
Summary
Send Messages to Target Devices
Method Parameters
| NAME | TYPE | REQUIRED | EXAMPLE | NOTES |
|---|---|---|---|---|
| SerialFormat | string | yes | json | Form of the serialized data. (json/xml) |
| ClientVersion | string | yes | 5.01.002 | AmvrosiaWebService compatibility |
| DeviceTicket | long | yes | 18249903 | Ticket for user. Returned from login |
| UserId | int | yes | 11 | User id |
| StationId | int | yes | 2 | Station id |
| tableId | int | yes | 20 | Table Id, can be 0 |
| deviceIdList | string | yes | 1;2 | Device Id List split with ';' from GetMessagingInfo |
| notes | string | no | 123 | text content if its editable |
| messageId | int | yes | 1 | Message Id from GetMessagingInfo |
Success Response
HTTP 200 OK
Returned Integer refers to Internal Sunsoft Id
Error Response
HTTP 500 Internal Server Error
Error Message
Error Message