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

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

{"id":0,"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

{"id":0,"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"}}}