POST v1/Logs
Creates new log entry
URI template
v1/LogsRequest Information
URI Parameters
None.
Body Parameters
log entry
InLogEntry| Name | Description | Type | Additional information |
|---|---|---|---|
| DesignId |
Get or set the DesignId property |
integer |
Range: inclusive between 0 and 9.22337203685478E+18 |
| SiteId |
Get or set the SiteId property |
integer |
Range: inclusive between 0 and 9.22337203685478E+18 |
| OrderId |
Get or set the OrderId property |
integer |
Range: inclusive between 0 and 9.22337203685478E+18 |
| MenuId |
Get or set the MenuId property |
integer |
Range: inclusive between 0 and 9.22337203685478E+18 |
| Message |
Get or set the Message property |
string |
Required |
| MessageType |
Get or set the MessageType property |
LogEntryType |
Range: inclusive between 0 and 3 |
| Timestamp |
Get or set the MessageType property |
date |
Required |
Request Formats
application/json, text/json
Sample:
{
"DesignId": 1,
"SiteId": 2,
"OrderId": 3,
"MenuId": 4,
"Message": "sample string 5",
"MessageType": 0,
"Timestamp": "2025-12-10T10:25:07.0041201"
}
application/xml, text/xml
Sample:
<InLogEntry xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Inbound"> <DesignId>1</DesignId> <MenuId>4</MenuId> <Message>sample string 5</Message> <MessageType>All</MessageType> <OrderId>3</OrderId> <SiteId>2</SiteId> <Timestamp>2025-12-10T10:25:07.0041201</Timestamp> </InLogEntry>
Response Information
Resource Description
Known internal errors are BadRequest and Error
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |