| Required roles: | Administrator, Administrator, Administrator | Requires any of the roles: | Agent, Administrator |
| GET,POST,PUT,DELETE,OPTIONS | /v1/LineMessages/{Id} | ||
|---|---|---|---|
| GET,POST,PUT,DELETE,OPTIONS | /v1/LineMessages | ||
| GET,POST,PUT,DELETE,OPTIONS | /v1/LineMessages/Line/{LineId} | ||
| GET,POST,PUT,DELETE,OPTIONS | /v1/LineMessages/Location/{LocationId}/Customers/{CustomerId} |
"use strict";
export class LineMessage {
/** @param {{Id?:string,LineId?:string,LineName?:string,Message?:string,MessageId?:string,DisplayOrder?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Id;
/** @type {string} */
LineId;
/** @type {string} */
LineName;
/** @type {string} */
Message;
/** @type {string} */
MessageId;
/** @type {number} */
DisplayOrder;
}
export class LineMessagesResponse {
/** @param {{ResponseStatus?:ResponseStatus,LineMessages?:LineMessage[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {LineMessage[]} */
LineMessages = [];
}
export class LineMessagesRequest {
/** @param {{Id?:string,LineId?:string,LineMessages?:LineMessage[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Id;
/** @type {string} */
LineId;
/** @type {LineMessage[]} */
LineMessages = [];
}
JavaScript LineMessagesRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/LineMessages/{Id} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Id: 00000000000000000000000000000000,
LineId: 00000000000000000000000000000000,
LineMessages:
[
{
Id: 00000000000000000000000000000000,
LineId: 00000000000000000000000000000000,
LineName: String,
Message: String,
MessageId: 00000000000000000000000000000000,
DisplayOrder: 0
}
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
LineMessages:
[
{
Id: 00000000000000000000000000000000,
LineId: 00000000000000000000000000000000,
LineName: String,
Message: String,
MessageId: 00000000000000000000000000000000,
DisplayOrder: 0
}
]
}