POST api/PlaybackLogs/{affiliateId}
Log a Watch Record. Evaluates for concurrent watches and may set the session as stopped if found.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| affiliateId |
Affiliate Id |
integer |
Required |
| v |
The requested API version |
string |
Required Default value is 1 |
Body Parameters
The call body DTO
FilmFlex.Platform.Common.API.Contracts.V1.LogWatchMessageDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| SupplierReference |
The supplier reference of the media being played |
string |
Required |
| PlayPosition |
The current play position of the media being played. String format must be hh:mm:ss |
time interval |
Required |
| PlayerDuration |
The time the player has been open and visible for this session. String format must be hh:mm:ss |
time interval |
Required |
| SessionId |
Unique session GUID. A unique session Id should be generated by the client each time a media item is opened. |
globally unique identifier |
Required |
| DeviceId |
Unique device GUID |
string |
Max length: 50 |
Request Formats
application/json, text/json
{
"SupplierReference": "sample string 1",
"PlayPosition": "00:00:00.1234567",
"PlayerDuration": "00:00:00.1234567",
"SessionId": "55d6a5c3-c126-4dbe-a213-ddbeb82b3b25",
"DeviceId": "sample string 5"
}
Response Information
Resource Description
Log a Watch Record. Evaluates for concurrent watches and may set the session as stopped if found.
FilmFlex.Platform.Common.API.Contracts.V1.LogWatchResponseDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| ContinuePlayback |
Should the playback continue |
boolean |
None. |
| StopReason |
Reason why playback should not be continued. Only populated if ContinuePlayback = false |
string |
None. |
Response Formats
application/json, text/json
{
"ContinuePlayback": true,
"StopReason": "sample string 2"
}