| POST | /api/comment |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ConnectedObjectId | body | Guid | Yes | Object linked to the comment. |
| Comment | body | string | Yes | Comment content |
| SuiteId | body | Guid | No | The comment suite id |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CommunicationId | form | Guid | No | |
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/comment HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/json
Content-Type: application/json
Content-Length: length
{"ConnectedObjectId":"00000000-0000-0000-0000-000000000000","Comment":"String","SuiteId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"CommunicationId":"00000000-0000-0000-0000-000000000000","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}