sfgboxapi

<back to all web services

TrackingEdit

Requires Authentication
The following routes are available for this service:
PUT/tracking/{Id}
"use strict";
export class TrackingEditResponse {
    /** @param {{id?:number,tenantsId?:number,appUserId?:number,mediaId?:number,mediaPercentage?:number,score?:number,menuItems?:string,entities?:string,ipAddresses?:string,country?:string,accessDateTime?:string,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {number} */
    tenantsId;
    /** @type {number} */
    appUserId;
    /** @type {number} */
    mediaId;
    /** @type {?number} */
    mediaPercentage;
    /** @type {?number} */
    score;
    /** @type {string} */
    menuItems;
    /** @type {string} */
    entities;
    /** @type {string} */
    ipAddresses;
    /** @type {string} */
    country;
    /** @type {string} */
    accessDateTime;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class TrackingEdit {
    /** @param {{id?:number,tenantsId?:number,appUserId?:number,mediaId?:number,mediaPercentage?:number,score?:number,menuItems?:string,entities?:string,ipAddresses?:string,country?:string,accessDateTime?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {number} */
    tenantsId;
    /** @type {number} */
    appUserId;
    /** @type {number} */
    mediaId;
    /** @type {?number} */
    mediaPercentage;
    /** @type {?number} */
    score;
    /** @type {string} */
    menuItems;
    /** @type {string} */
    entities;
    /** @type {string} */
    ipAddresses;
    /** @type {string} */
    country;
    /** @type {string} */
    accessDateTime;
}

JavaScript TrackingEdit 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.

PUT /tracking/{Id} HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<TrackingEdit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <Id>0</Id>
  <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>
</TrackingEdit>

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

<TrackingEditResponse 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>
  <Id>0</Id>
  <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>
</TrackingEditResponse>