| Requires any of the roles: | bookingsupplier-administrator-write, bookingsupplier-administrator-read |
| POST | /company/{companyId}/incentives/{incentiveId} | Logs a user interaction with an incentive. |
|---|
import Foundation
import ServiceStack
// @ValidateRequest(Validator="IsAuthenticated")
// @ApiResponse(Description="You were unauthorized to call this service.", StatusCode=401)
public class LogIncentiveEngage : Codable
{
/**
* The id of the company. If not provided, the company associated with the authenticated user will be used.
*/
// @ApiMember(Description="The id of the company. If not provided, the company associated with the authenticated user will be used.", IsRequired=true, ParameterType="path")
public var companyId:String
/**
* The id of the incentive.
*/
// @ApiMember(Description="The id of the incentive.", IsRequired=true, ParameterType="path")
public var incentiveId:Int
/**
* Specifies the type of engagement (e.g., Read, Engaged) performed by the user on the incentive.
*/
// @ApiMember(Description="Specifies the type of engagement (e.g., Read, Engaged) performed by the user on the incentive.", IsRequired=true)
public var engagementType:EngagementType
required public init(){}
}
public enum EngagementType : Int, Codable
{
case Read = 1
case Success = 2
case Cancelled = 3
case CheckLater = 4
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /company/{companyId}/incentives/{incentiveId} HTTP/1.1
Host: testapi.bokamera.se
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
IncentiveId: 0,
EngagementType: Read
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
}