sfgboxapi

<back to all web services

TrackingAdd

Requires Authentication
The following routes are available for this service:
POST/tracking
import 'package:servicestack/servicestack.dart';

class TrackingAddResponse implements IConvertible
{
    // @DataMember(Order=2)
    int? tenantsId;

    // @DataMember(Order=3)
    int? appUserId;

    // @DataMember(Order=4)
    int? mediaId;

    // @DataMember(Order=5)
    int? mediaPercentage;

    // @DataMember(Order=6)
    int? score;

    // @DataMember(Order=7)
    String? menuItems;

    // @DataMember(Order=8)
    String? entities;

    // @DataMember(Order=9)
    String? ipAddresses;

    // @DataMember(Order=10)
    String? country;

    // @DataMember(Order=11)
    DateTime? accessDateTime;

    // @DataMember(Order=13)
    ResponseStatus? responseStatus;

    TrackingAddResponse({this.tenantsId,this.appUserId,this.mediaId,this.mediaPercentage,this.score,this.menuItems,this.entities,this.ipAddresses,this.country,this.accessDateTime,this.responseStatus});
    TrackingAddResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        tenantsId = json['tenantsId'];
        appUserId = json['appUserId'];
        mediaId = json['mediaId'];
        mediaPercentage = json['mediaPercentage'];
        score = json['score'];
        menuItems = json['menuItems'];
        entities = json['entities'];
        ipAddresses = json['ipAddresses'];
        country = json['country'];
        accessDateTime = JsonConverters.fromJson(json['accessDateTime'],'DateTime',context!);
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'tenantsId': tenantsId,
        'appUserId': appUserId,
        'mediaId': mediaId,
        'mediaPercentage': mediaPercentage,
        'score': score,
        'menuItems': menuItems,
        'entities': entities,
        'ipAddresses': ipAddresses,
        'country': country,
        'accessDateTime': JsonConverters.toJson(accessDateTime,'DateTime',context!),
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "TrackingAddResponse";
    TypeContext? context = _ctx;
}

// @DataContract
class TrackingAdd implements IConvertible
{
    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    int? tenantsId;

    // @DataMember(Order=3)
    // @Validate(Validator="NotNull")
    int? appUserId;

    // @DataMember(Order=4)
    // @Validate(Validator="NotNull")
    int? mediaId;

    // @DataMember(Order=5)
    int? mediaPercentage;

    // @DataMember(Order=6)
    int? score;

    // @DataMember(Order=7)
    // @Validate(Validator="NotNull")
    String? menuItems;

    // @DataMember(Order=8)
    // @Validate(Validator="NotNull")
    String? entities;

    // @DataMember(Order=9)
    String? ipAddresses;

    // @DataMember(Order=10)
    String? country;

    // @DataMember(Order=11)
    // @Validate(Validator="NotNull")
    DateTime? accessDateTime;

    TrackingAdd({this.tenantsId,this.appUserId,this.mediaId,this.mediaPercentage,this.score,this.menuItems,this.entities,this.ipAddresses,this.country,this.accessDateTime});
    TrackingAdd.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        tenantsId = json['tenantsId'];
        appUserId = json['appUserId'];
        mediaId = json['mediaId'];
        mediaPercentage = json['mediaPercentage'];
        score = json['score'];
        menuItems = json['menuItems'];
        entities = json['entities'];
        ipAddresses = json['ipAddresses'];
        country = json['country'];
        accessDateTime = JsonConverters.fromJson(json['accessDateTime'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'tenantsId': tenantsId,
        'appUserId': appUserId,
        'mediaId': mediaId,
        'mediaPercentage': mediaPercentage,
        'score': score,
        'menuItems': menuItems,
        'entities': entities,
        'ipAddresses': ipAddresses,
        'country': country,
        'accessDateTime': JsonConverters.toJson(accessDateTime,'DateTime',context!)
    };

    getTypeName() => "TrackingAdd";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'sfgboxapi.dev.scadsoftware.com', types: <String, TypeInfo> {
    'TrackingAddResponse': TypeInfo(TypeOf.Class, create:() => TrackingAddResponse()),
    'TrackingAdd': TypeInfo(TypeOf.Class, create:() => TrackingAdd()),
});

Dart 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
		}
	}
}