sfgboxapi

<back to all web services

TrackingLookup

Requires Authentication
The following routes are available for this service:
GET/tracking
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


// @DataContract
class TrackingLookup implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=2)
        /** @var int */
        public int $tenantsId=0,

        // @DataMember(Order=3)
        /** @var int */
        public int $appUserId=0,

        // @DataMember(Order=4)
        /** @var int */
        public int $mediaId=0,

        // @DataMember(Order=5)
        /** @var int|null */
        public ?int $mediaPercentage=null,

        // @DataMember(Order=6)
        /** @var int|null */
        public ?int $score=null,

        // @DataMember(Order=7)
        /** @var string|null */
        public ?string $menuItems=null,

        // @DataMember(Order=8)
        /** @var string|null */
        public ?string $entities=null,

        // @DataMember(Order=9)
        /** @var string|null */
        public ?string $ipAddresses=null,

        // @DataMember(Order=10)
        /** @var string|null */
        public ?string $country=null,

        // @DataMember(Order=11)
        /** @var DateTime */
        public DateTime $accessDateTime=new DateTime()
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['tenantsId'])) $this->tenantsId = $o['tenantsId'];
        if (isset($o['appUserId'])) $this->appUserId = $o['appUserId'];
        if (isset($o['mediaId'])) $this->mediaId = $o['mediaId'];
        if (isset($o['mediaPercentage'])) $this->mediaPercentage = $o['mediaPercentage'];
        if (isset($o['score'])) $this->score = $o['score'];
        if (isset($o['menuItems'])) $this->menuItems = $o['menuItems'];
        if (isset($o['entities'])) $this->entities = $o['entities'];
        if (isset($o['ipAddresses'])) $this->ipAddresses = $o['ipAddresses'];
        if (isset($o['country'])) $this->country = $o['country'];
        if (isset($o['accessDateTime'])) $this->accessDateTime = JsonConverters::from('DateTime', $o['accessDateTime']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->tenantsId)) $o['tenantsId'] = $this->tenantsId;
        if (isset($this->appUserId)) $o['appUserId'] = $this->appUserId;
        if (isset($this->mediaId)) $o['mediaId'] = $this->mediaId;
        if (isset($this->mediaPercentage)) $o['mediaPercentage'] = $this->mediaPercentage;
        if (isset($this->score)) $o['score'] = $this->score;
        if (isset($this->menuItems)) $o['menuItems'] = $this->menuItems;
        if (isset($this->entities)) $o['entities'] = $this->entities;
        if (isset($this->ipAddresses)) $o['ipAddresses'] = $this->ipAddresses;
        if (isset($this->country)) $o['country'] = $this->country;
        if (isset($this->accessDateTime)) $o['accessDateTime'] = JsonConverters::to('DateTime', $this->accessDateTime);
        return empty($o) ? new class(){} : $o;
    }
}

PHP 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: api.sfgtec.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>