BokaMera.API.Host

<back to all web services

CustomerCommentsQuery

Requires Authentication
The following routes are available for this service:
GET/customers/{CustomerId}/commentsGet the customers commentsGet all connected customer comments for the company.
CustomerCommentsQuery Parameters:
NameParameterData TypeRequiredDescription
CustomerIdpathGuidYes
CompanyIdqueryGuid?Yes
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
CustomerComment Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidYes
IdformintNo
CustomerIdformGuidYes
CommentsformstringYes
UpdatedformDateTimeYes
CreatedformDateTimeYes
ImageUrlformstringNo
ModifiedDateformDateTimeOffset?No
CustomerCommentsResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CustomerIdformGuidNo
CommentsformstringYes
UpdatedformDateTimeNo
CreatedformDateTimeNo
ImageUrlformUriYes
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<AccessKeyTypeResponse>Yes
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
AccessKeyTypeResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
KeyTypeformstringYes
DescriptionformstringYes

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

HTTP + OTHER

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

GET /customers/{CustomerId}/comments HTTP/1.1 
Host: api-staging.bookmore.com 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

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