BokaMera.API.Host

<back to all web services

SupportCaseCommentQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read
The following routes are available for this service:
GET/support/cases/{SupportCaseId}/commentsGet all support case commentsGet all support case comments.
SupportCaseCommentQuery Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?YesEnter the company id, if blank company id and you are an admin, your company id will be used.
SupportCaseIdpathintYesThe support case id
QueryBase Parameters:
NameParameterData TypeRequiredDescription
SkipqueryintNoSkip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.

Example:
?skip=10&orderBy=Id
TakequeryintNoReturn a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.

Example:
?take=20
OrderByquerystringNoComma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field.

Example:
?orderBy=Id,-Age,FirstName
OrderByDescquerystringNoComma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field.

Example:
?orderByDesc=Id,-Age,FirstName
IncludequerystringNoInclude any of the aggregates AVG, COUNT, FIRST, LAST, MAX, MIN, SUM in your result set. The results will be returned in the meta field.

Example:
?include=COUNT(*) as Total

or multiple fields with
?include=Count(*) Total, Min(Age), AVG(Age) AverageAge

or unique with
?include=COUNT(DISTINCT LivingStatus) as UniqueStatus
FieldsformstringNo
MetaformDictionary<string, string>No
CaseComment Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidYes
SupportCaseIdformintYes
IdformintNo
CommentformstringYes
DeletedformboolYes
CreatedByformstringYes
CreatedformDateTimeYes
ModifiedDateformDateTimeOffset?No
SupportCaseCommentsResponse Parameters:
NameParameterData TypeRequiredDescription
SupportCaseIdformintNoThe case id
IdformintNoThe comments id
CommentformstringNoThe case comment
CreatedByformstringNoThe case comment created by
CreatedformDateTimeNoThe case comment created date
QueryResponse<AccessKeyTypeResponse> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<AccessKeyTypeResponse>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
AccessKeyTypeResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
KeyTypeformstringNo
DescriptionformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /support/cases/{SupportCaseId}/comments HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Offset":0,"Total":0,"Results":[{"SupportCaseId":0,"Id":0,"Comment":"String","CreatedBy":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}