| Requires any of the roles: | bookingsupplier-administrator-write, bookingsupplier-administrator-read |
| POST | /company/{companyId}/incentives/{incentiveId} | Logs a user interaction with an incentive. |
|---|
namespace BokaMera.API.ServiceModel.Db.Incentive
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
type EngagementType =
| Read = 1
| Success = 2
| Cancelled = 3
| CheckLater = 4
[<ValidateRequest(Validator="IsAuthenticated")>]
[<ApiResponse(Description="You were unauthorized to call this service.", StatusCode=401)>]
[<AllowNullLiteral>]
type LogIncentiveEngage() =
///<summary>
///The id of the company. If not provided, the company associated with the authenticated user will be used.
///</summary>
[<ApiMember(Description="The id of the company. If not provided, the company associated with the authenticated user will be used.", IsRequired=true, ParameterType="path")>]
member val CompanyId:Guid = new Guid() with get,set
///<summary>
///The id of the incentive.
///</summary>
[<ApiMember(Description="The id of the incentive.", IsRequired=true, ParameterType="path")>]
member val IncentiveId:Int32 = new Int32() with get,set
///<summary>
///Specifies the type of engagement (e.g., Read, Engaged) performed by the user on the incentive.
///</summary>
[<ApiMember(Description="Specifies the type of engagement (e.g., Read, Engaged) performed by the user on the incentive.", IsRequired=true)>]
member val EngagementType:EngagementType = new EngagementType() with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<LogIncentiveEngage 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>
<EngagementType>Read</EngagementType>
<IncentiveId>0</IncentiveId>
</LogIncentiveEngage>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />