BokaMera.API.Host

CommentsSuperAdminUserQuery

**Requires Authentication**
Required role:	superadmin

The following routes are available for this service:
GET	/superadmin/company/{CompanyId}/comments	Get companies comments.

**CommentsSuperAdminUserQuery** Parameters:
Name	Parameter	Data Type	Required	Description
CompanyId	query	Guid?	Yes	Enter the companyId for the customer
CommentsTypeId	query	int?	No

**QueryBase** Parameters:
Name	Parameter	Data Type	Required	Description
Skip	query	int	No	Skip 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`
Take	query	int	No	Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging. Example: `?take=20`
OrderBy	query	string	No	Comma 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`
OrderByDesc	query	string	No	Comma 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`
Include	query	string	No	Include 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`
Fields	form	string	No
Meta	form	Dictionary<string, string>	No

**CompanyComment** Parameters:
Name	Parameter	Data Type	Required
CommentsType	form	CommentsType	No
CompanyId	form	Guid	Yes
Id	form	int	No
CommentsTypeId	form	int	No
Comments	form	string	No
CreatedBy	form	string	No
Created	form	DateTime	Yes
Updated	form	DateTime	Yes
ModifiedDate	form	DateTimeOffset?	No

**CommentsType** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	No
Description	form	string	No
ModifiedDate	form	DateTimeOffset?	No

**CompanyCommentsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
CompanyId	form	Guid?	No
Id	form	int	No
Comment	form	string	Yes
CommentTypeId	form	CommentsType	Yes
CommentType	form	CommentsTypeResponse	Yes
Updated	form	DateTime	No	The updated date
Created	form	DateTime	No	The created date
CreatedBy	form	string	No	The created by

**CommentsType** Enum:
Name	Value
NormalComment	1
CallBackPhoneComment	2
CallBackEmailComment	3
CallBackMeetingBookedComment	4
CallBackNotInterestedComment	5

**CommentsTypeResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	No
Description	form	string	No

**QueryResponse<AccessKeyTypeResponse>** Parameters:
Name	Parameter	Data Type	Required
Offset	form	int	No
Total	form	int	No
Results	form	List<AccessKeyTypeResponse>	No
Meta	form	Dictionary<string, string>	No
ResponseStatus	form	ResponseStatus	No

**AccessKeyTypeResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
KeyType	form	string	No
Description	form	string	No

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

HTTP + JSV

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

GET /superadmin/company/{CompanyId}/comments HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Offset: 0,
	Total: 0,
	Results: 
	[
		{
			CompanyId: 00000000-0000-0000-0000-000000000000,
			Id: 0,
			Comment: String,
			CommentTypeId: NormalComment,
			CommentType: 
			{
				Id: 0,
				Name: String,
				Description: 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
		}
	}
}