sfgboxapi

<back to all web services

TrackingAdd

Requires Authentication
The following routes are available for this service:
POST/tracking
TrackingAdd Parameters:
NameParameterData TypeRequiredDescription
TenantsIdbodylongYes
AppUserIdbodylongYes
MediaIdbodylongYes
MediaPercentagebodyint?No
Scorebodyint?No
MenuItemsbodystringYes
EntitiesbodystringYes
IPAddressesbodystringNo
CountrybodystringNo
AccessDateTimebodyDateTimeYes
TrackingAddResponse Parameters:
NameParameterData TypeRequiredDescription
TenantsIdformlongNo
AppUserIdformlongNo
MediaIdformlongNo
MediaPercentageformint?No
Scoreformint?No
MenuItemsformstringNo
EntitiesformstringNo
IPAddressesformstringNo
CountryformstringNo
AccessDateTimeformDateTimeNo
ResponseStatusformResponseStatusNo

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