| POST | /api/comment |
|---|
// @ApiResponse(Description="Returns the communication id and response status.")
export class SendCommunicationResponse
{
public CommunicationId: string;
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<SendCommunicationResponse>) { (Object as any).assign(this, init); }
}
/** @description Add a comment to the specified object. */
// @Api(Description="Add a comment to the specified object.")
export class AddComment
{
/** @description Object linked to the comment. */
// @ApiMember(DataType="Guid", Description="Object linked to the comment.", IsRequired=true, Name="ConnectedObjectId")
public ConnectedObjectId: string;
/** @description Comment content */
// @ApiMember(DataType="string", Description="Comment content", IsRequired=true, Name="Comment")
public Comment: string;
/** @description The comment suite id */
// @ApiMember(DataType="Guid", Description="The comment suite id", Name="SuiteId")
public SuiteId: string;
public constructor(init?: Partial<AddComment>) { (Object as any).assign(this, init); }
}
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"}}}