BokaMera.API.Host

<back to all web services

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}/incentivesIt gets either incentives which are not read or engaged by the current company/administrator.
CompanyIncentiveQuery Parameters:
NameParameterData TypeRequiredDescription
CompanyIdpathGuid?YesThe company id, if empty will use the company id for the user you are logged in with.
CompanyIncentivesQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IncentivesformIList<CompanyIncentiveResponse>No
CompanyIdformGuidNo
CompanyIncentiveResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
HeadingformstringNo
StorageUrlformstringNo
SuccessButtonTextformstringNo
ActionIdformintNo
InitialDelayInSecondsformintNo
MaxDisplayCountformint?No
ValidFromformDateTimeOffsetNo
ValidToformDateTimeOffsetNo
ActionformIncentiveActionNo
IncentiveAction Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
ActionTypeformIncentiveActionTypeNo
PageformstringNo
SegmentformstringNo
ElementformstringNo
PayloadformstringNo
IncentiveActionType Enum:
NameValue
Upgrade1
AddOn2
Information3

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 /companies/{CompanyId}/incentives HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{}