QBOS REST API documentation (comment)

(return to Main Document)

Introduction

The comment API allows client applications to maintain comment data including any part of its demographic record sets.

Audience

This developer's guide is intended for software developers needing a technical reference for using the QBOS REST API. The information you find in this guide is written by software engineering, and is authoritative on how the API behaves.

Additional resources, information about this guide

Occasionally, we make a mistake in this documentation, or unknowingly break a feature that you depend on. If this has happened to you, we apologize! You can help us fix the issue by contacting us. We appreciate your help.

Getting Started

To place any request in QBOS API application from third party application you need to authenticate user account and set/calculate values for the following request headers: x-qbos-id, x-qbos-nonce, x-qbos-date-utc, x-qbos-hash-version, x-qbos-auth

See details in Authentication Documentation.

comment properties

Properties prefixed with '_' (underscore) are read-only properties. i.e. POST and PUT processing will ignore these properties.

Name Type Max length Numeric Required
For POST		 Filterable Description

id

bigint

 

 

 

Required for GET(by id),PUT,DELETE

parent_id

bigint

 

yes

 

parent_type

nvarchar

50

 

yes

 

type

nvarchar

50

 

 

 

Value is "comment"

comment

nvarchar

4000

 

 

 

href

varchar

24

 

 

 

_ancestor_comment_id

bigint

 

 

 

Id of the first comment in a comment chain

href_ancestor_comment

varchar

24

 

 

 

parent_comment_id

bigint

 

 

 

POST this to link new comment with a parent comment. If not POSTed then starts new commment chain

href_parent_comment

varchar

24

 

 

 

_submitter_name

nvarchar

101

 

 

 

_create_datetime

char

20

 

 

 

Read comment by id:

GET https:/.../v1/o/comment/{id}

Response codes:

  • 400 - Client error
  • 500 - Server error
  • 404 - Not found or user does not have permission to access resources of this type.
  • 200 - OK

Response data: GET https:/.../v1/o/comment/0
{}

Read comment from parent:

GET https:/.../v1/o/{parent_type}/{parent_id}/links/comment[?{filter}]

Response codes:

  • 400 - Client error
  • 500 - Server error
  • 404 - Not found or user does not have permission to access resources of this type.
  • 200 - OK

GET https:/.../v1/o/contact/0/links/comment
Response data:
{}

Create comment:

POST https:/.../v1/o/contact/0/comment

Request data [See properties]:

{"comment": [ { "parent_type" : "contact", "parent_id" : 0, "property_a" : "value-a", "property" : "See comment properties", "property_z" : "value-z" } ] }

Response codes:

Delete comment:

DELETE https:/.../v1/o/comment/{id}

The "id" in JSON payload is required to match the {id} in the URI to ensure that deletion requests are intended and safe

{"comment": [{"id":0}]}

Response codes:

  • 400 - Client error
  • 500 - Server error
  • 204 - OK
  • 404 - Not found

Response data:
{}