finsit API - CompanyComment

A collection of help pages for using the API.

CompanyComment

URL /Api/v2/Company/{companyId}/Comment/{commentId}
Accepted verbs GET, POST, PUT, DELETE
Description

Manage comments connected to a company.

GET /Api/v2/Company/{companyId}/Comment

Lists all comments connected to specified company. List can contain different types (see type field) of comments. Currently we only support , in the future there more comment types will be added.

Parameters
NameDescriptionAdditional information
companyId Company id.

URI parameter
Returns

List of Comment.

GET /Api/v2/Company/{companyId}/Comment?startDate={startDate}&endDate={endDate}

Lists all comments in date range (between, after or before a date). Dates should be formatted on the form: YYYY-MM-DD.

Parameters
NameDescriptionAdditional information
companyId Company id.

URI parameter
startDate Limits result to comments after start date. If not specified all comments is returned.

URI parameter
endDate Limits result to comments before end date. If not specified all comments is returned.

URI parameter
Returns

List of Comment.

GET /Api/v2/Company/{companyId}/Comment/{commentId}

Get single comment by company and comment identifier.

Parameters
NameDescriptionAdditional information
companyId Company id.

URI parameter
commentId Comment id.

URI parameter
Returns

The requested Comment object.

POST /Api/v2/Company/{companyId}/Comment

Create a new comment associated to a company. The id of the new comment should be ommited since it will be automatically assigned when it is created.

Parameters
NameDescriptionAdditional information
companyId Company id.

URI parameter
apiComment The new Comment to create.

Body data
Returns

Newly created Comment. The object now contains an id.

PUT /Api/v2/Company/{companyId}/Comment

Update a comment that is associated with a company.

Parameters
NameDescriptionAdditional information
companyId Company id.

URI parameter
apiComment Updated Comment informtaion.

Body data
Returns

Updated Comment.

DELETE /Api/v2/Company/{companyId}/Comment/{commentId}

Delete a comment that is associated with a company.

Parameters
NameDescriptionAdditional information
companyId Company id.

URI parameter
commentId Id of the comment to delete.

URI parameter