| 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 .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<LineMessagesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Id>00000000-0000-0000-0000-000000000000</Id>
<LineId>00000000-0000-0000-0000-000000000000</LineId>
<LineMessages>
<LineMessage>
<DisplayOrder>0</DisplayOrder>
<Id>00000000-0000-0000-0000-000000000000</Id>
<LineId>00000000-0000-0000-0000-000000000000</LineId>
<LineName>String</LineName>
<Message>String</Message>
<MessageId>00000000-0000-0000-0000-000000000000</MessageId>
</LineMessage>
</LineMessages>
</LineMessagesRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<LineMessagesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<LineMessages>
<LineMessage>
<DisplayOrder>0</DisplayOrder>
<Id>00000000-0000-0000-0000-000000000000</Id>
<LineId>00000000-0000-0000-0000-000000000000</LineId>
<LineName>String</LineName>
<Message>String</Message>
<MessageId>00000000-0000-0000-0000-000000000000</MessageId>
</LineMessage>
</LineMessages>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</LineMessagesResponse>