BokaMera.API.Host

CompanyIncentiveQuery

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin

The following routes are available for this service:
GET	/companies/{CompanyId}/incentives	It gets either incentives which are not read or engaged by the current company/administrator.

**CompanyIncentiveQuery** Parameters:
Name	Parameter	Data Type	Required	Description
CompanyId	path	Guid?	Yes	The company id, if empty will use the company id for the user you are logged in with.

**CompanyIncentivesQueryResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Incentives	form	IList<CompanyIncentiveResponse>	No
CompanyId	form	Guid	No

**CompanyIncentiveResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Heading	form	string	No
StorageUrl	form	string	No
SuccessButtonText	form	string	No
ActionId	form	int	No
InitialDelayInSeconds	form	int	No
MaxDisplayCount	form	int?	No
ValidFrom	form	DateTimeOffset	No
ValidTo	form	DateTimeOffset	No
Action	form	IncentiveAction	No

**IncentiveAction** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
ActionType	form	IncentiveActionType	No
Page	form	string	No
Segment	form	string	No
Element	form	string	No
Payload	form	string	No

**IncentiveActionType** Enum:
Name	Value
Upgrade	1
AddOn	2
Information	3

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

HTTP + XML

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

GET /companies/{CompanyId}/incentives HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CompanyIncentivesQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Incentives i:nil="true" />
</CompanyIncentivesQueryResponse>