sfgboxapi

<back to all web services

TrackingAdd

Requires Authentication
The following routes are available for this service:
POST/tracking
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TrackingAddResponse:
    tenants_id: int = 0
    app_user_id: int = 0
    media_id: int = 0
    media_percentage: Optional[int] = None
    score: Optional[int] = None
    menu_items: Optional[str] = None
    entities: Optional[str] = None
    ip_addresses: Optional[str] = None
    country: Optional[str] = None
    access_date_time: datetime.datetime = datetime.datetime(1, 1, 1)
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TrackingAdd:
    # @Validate(Validator="NotNull")
    tenants_id: int = 0

    # @Validate(Validator="NotNull")
    app_user_id: int = 0

    # @Validate(Validator="NotNull")
    media_id: int = 0

    media_percentage: Optional[int] = None
    score: Optional[int] = None
    # @Validate(Validator="NotNull")
    menu_items: Optional[str] = None

    # @Validate(Validator="NotNull")
    entities: Optional[str] = None

    ip_addresses: Optional[str] = None
    country: Optional[str] = None
    # @Validate(Validator="NotNull")
    access_date_time: datetime.datetime = datetime.datetime(1, 1, 1)

Python TrackingAdd DTOs

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.

POST /tracking HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"tenantsId":0,"appUserId":0,"mediaId":0,"mediaPercentage":0,"score":0,"menuItems":"String","entities":"String","ipAddresses":"String","country":"String","accessDateTime":"\/Date(-62135596800000-0000)\/"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"tenantsId":0,"appUserId":0,"mediaId":0,"mediaPercentage":0,"score":0,"menuItems":"String","entities":"String","ipAddresses":"String","country":"String","accessDateTime":"\/Date(-62135596800000-0000)\/","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}