GET v1/Orders/{orderId}/OrderComments
Get a list with all order comments of a given order.
Request Information
Requires Authorization!
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
orderId |
The identifier of the order. |
integer |
Required. |
Body Parameters
None.
Response Information
Resource Description
A list of the OrderComment objects.
Collection of OrderComment
Name | Description | Type | Additional information |
---|---|---|---|
Id |
Gets or sets the identifier. |
integer |
Required |
OrderId |
Gets or sets the order identifier. |
integer |
None. |
Comment |
Gets or sets the comment. |
string |
Required Max length: 2147483647 |
EmployeeId |
Gets or sets the employee identifier. |
integer |
None. |
EmployeeName |
Gets or sets the name of the employee. |
string |
None. |
TimeStamp |
Gets or sets the time stamp. |
date |
Required |
OfferId |
Gets or sets the offer identifier. |
integer |
None. |
CommentType |
Gets or sets the type of the comment. |
integer |
Required |
Response Formats
application/json, text/json
Sample:
[ { "Id": 1, "OrderId": 1, "Comment": "sample string 2", "EmployeeId": 1, "EmployeeName": "sample string 3", "TimeStamp": "2021-12-02T20:19:34.2947334+01:00", "OfferId": 1, "CommentType": 5 }, { "Id": 1, "OrderId": 1, "Comment": "sample string 2", "EmployeeId": 1, "EmployeeName": "sample string 3", "TimeStamp": "2021-12-02T20:19:34.2947334+01:00", "OfferId": 1, "CommentType": 5 } ]
application/xml, text/xml
Sample:
<ArrayOfOrderComment xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <OrderComment> <Id>1</Id> <OrderId>1</OrderId> <Comment>sample string 2</Comment> <EmployeeId>1</EmployeeId> <EmployeeName>sample string 3</EmployeeName> <TimeStamp>2021-12-02T20:19:34.2947334+01:00</TimeStamp> <OfferId>1</OfferId> <CommentType>5</CommentType> </OrderComment> <OrderComment> <Id>1</Id> <OrderId>1</OrderId> <Comment>sample string 2</Comment> <EmployeeId>1</EmployeeId> <EmployeeName>sample string 3</EmployeeName> <TimeStamp>2021-12-02T20:19:34.2947334+01:00</TimeStamp> <OfferId>1</OfferId> <CommentType>5</CommentType> </OrderComment> </ArrayOfOrderComment>