Platform API

AddComment

Add a comment to the specified object.

The following routes are available for this service:
POST	/api/comment

**AddComment** Parameters:
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

**SendCommunicationResponse** Parameters:
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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Comment: String
}

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
		}
	}
}