BokaMera.API.Host

HomepageImagesQuery

The following routes are available for this service:
GET	/homepage/images	Find homepage images for a company

**HomepageImagesQuery** Parameters:
Name	Parameter	Data Type	Required	Description
CompanyId	query	Guid?	No	Enter the company you want to see news for, if blank and you are an admin, your company id will be used
Id	query	int?	No	The image id.
SitePath	query	string	Yes	The homepage sitepath.

**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

**HomepageImage** Parameters:
Name	Parameter	Data Type	Required
CompanyId	form	Guid	Yes
Id	form	int	No
Title	form	string	No
Description	form	string	No
ImageUrl	form	string	Yes
ModifiedDate	form	DateTimeOffset?	No

**HomepageImageQueryResponse** Parameters:
Name	Parameter	Data Type	Required	Description
CompanyId	form	Guid	No	The company id.
Id	form	int	No	The homepage image id.
Title	form	string	Yes	The image title.
Description	form	string	Yes	The image description.
ImageUrl	form	Uri	Yes	The image url.

**QueryResponse<T>** 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	Yes
Description	form	string	Yes

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 /homepage/images 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":[{"Id":0,"Title":"String","Description":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}