sfgboxapi

<back to all web services

TrackingLookup

Requires Authentication
The following routes are available for this service:
GET/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 TrackingLookup:
    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)

Python TrackingLookup 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.

GET /tracking HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfTrackingLookupResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <TrackingLookupResponse>
    <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:d3p1="http://schemas.servicestack.net/types">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d3p1:Meta>
    </ResponseStatus>
    <Score>0</Score>
    <TenantsId>0</TenantsId>
  </TrackingLookupResponse>
</ArrayOfTrackingLookupResponse>