sfgboxapi

<back to all web services

TrackingAdd

Requires Authentication
The following routes are available for this service:
POST/tracking

export class TrackingAddResponse
{
    // @DataMember(Order=2)
    public tenantsId: number;

    // @DataMember(Order=3)
    public appUserId: number;

    // @DataMember(Order=4)
    public mediaId: number;

    // @DataMember(Order=5)
    public mediaPercentage?: number;

    // @DataMember(Order=6)
    public score?: number;

    // @DataMember(Order=7)
    public menuItems: string;

    // @DataMember(Order=8)
    public entities: string;

    // @DataMember(Order=9)
    public ipAddresses: string;

    // @DataMember(Order=10)
    public country: string;

    // @DataMember(Order=11)
    public accessDateTime: string;

    // @DataMember(Order=13)
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<TrackingAddResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class TrackingAdd
{
    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    public tenantsId: number;

    // @DataMember(Order=3)
    // @Validate(Validator="NotNull")
    public appUserId: number;

    // @DataMember(Order=4)
    // @Validate(Validator="NotNull")
    public mediaId: number;

    // @DataMember(Order=5)
    public mediaPercentage?: number;

    // @DataMember(Order=6)
    public score?: number;

    // @DataMember(Order=7)
    // @Validate(Validator="NotNull")
    public menuItems: string;

    // @DataMember(Order=8)
    // @Validate(Validator="NotNull")
    public entities: string;

    // @DataMember(Order=9)
    public ipAddresses: string;

    // @DataMember(Order=10)
    public country: string;

    // @DataMember(Order=11)
    // @Validate(Validator="NotNull")
    public accessDateTime: string;

    public constructor(init?: Partial<TrackingAdd>) { (Object as any).assign(this, init); }
}

TypeScript TrackingAdd DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	tenantsId: 0,
	appUserId: 0,
	mediaId: 0,
	mediaPercentage: 0,
	score: 0,
	menuItems: String,
	entities: String,
	ipAddresses: String,
	country: String,
	accessDateTime: 0001-01-01
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	tenantsId: 0,
	appUserId: 0,
	mediaId: 0,
	mediaPercentage: 0,
	score: 0,
	menuItems: String,
	entities: String,
	ipAddresses: String,
	country: String,
	accessDateTime: 0001-01-01,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}