sfgboxapi

TrackingAdd

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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<TrackingAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <TenantsId>0</TenantsId>
  <AppUserId>0</AppUserId>
  <MediaId>0</MediaId>
  <MediaPercentage>0</MediaPercentage>
  <Score>0</Score>
  <MenuItems>String</MenuItems>
  <Entities>String</Entities>
  <IPAddresses>String</IPAddresses>
  <Country>String</Country>
  <AccessDateTime>0001-01-01T00:00:00</AccessDateTime>
</TrackingAdd>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<TrackingAddResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <AccessDateTime>0001-01-01T00:00:00</AccessDateTime>
  <AppUserId>0</AppUserId>
  <Country>String</Country>
  <Entities>String</Entities>
  <IPAddresses>String</IPAddresses>
  <MediaId>0</MediaId>
  <MediaPercentage>0</MediaPercentage>
  <MenuItems>String</MenuItems>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Score>0</Score>
  <TenantsId>0</TenantsId>
</TrackingAddResponse>