Trendsic Platform Service

<back to all web services

QueueCustomerRequest

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/Customers/{Id}
GET,POST,PUT,DELETE,OPTIONS/v1/Customers
import 'package:servicestack/servicestack.dart';

class QueueCustomer implements IConvertible
{
    String? Id;
    String? Name;
    String? Address1;
    String? Address2;
    String? City;
    String? State;
    String? Zip;
    String? MobilePhone;
    String? Email;
    DateTime? MarketingOptIn;
    DateTime? DoNoContact;
    DateTime? EntDate;
    DateTime? ModDate;

    QueueCustomer({this.Id,this.Name,this.Address1,this.Address2,this.City,this.State,this.Zip,this.MobilePhone,this.Email,this.MarketingOptIn,this.DoNoContact,this.EntDate,this.ModDate});
    QueueCustomer.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        Name = json['Name'];
        Address1 = json['Address1'];
        Address2 = json['Address2'];
        City = json['City'];
        State = json['State'];
        Zip = json['Zip'];
        MobilePhone = json['MobilePhone'];
        Email = json['Email'];
        MarketingOptIn = JsonConverters.fromJson(json['MarketingOptIn'],'DateTime',context!);
        DoNoContact = JsonConverters.fromJson(json['DoNoContact'],'DateTime',context!);
        EntDate = JsonConverters.fromJson(json['EntDate'],'DateTime',context!);
        ModDate = JsonConverters.fromJson(json['ModDate'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'Name': Name,
        'Address1': Address1,
        'Address2': Address2,
        'City': City,
        'State': State,
        'Zip': Zip,
        'MobilePhone': MobilePhone,
        'Email': Email,
        'MarketingOptIn': JsonConverters.toJson(MarketingOptIn,'DateTime',context!),
        'DoNoContact': JsonConverters.toJson(DoNoContact,'DateTime',context!),
        'EntDate': JsonConverters.toJson(EntDate,'DateTime',context!),
        'ModDate': JsonConverters.toJson(ModDate,'DateTime',context!)
    };

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

class QueueCustomersResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    List<QueueCustomer>? Customers = [];

    QueueCustomersResponse({this.ResponseStatus,this.Customers});
    QueueCustomersResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        Customers = JsonConverters.fromJson(json['Customers'],'List<QueueCustomer>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!),
        'Customers': JsonConverters.toJson(Customers,'List<QueueCustomer>',context!)
    };

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

class QueueCustomerRequest extends QueueCustomer implements IConvertible
{
    String? ApiKey;

    QueueCustomerRequest({this.ApiKey});
    QueueCustomerRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        ApiKey = json['ApiKey'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'ApiKey': ApiKey
    });

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

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'QueueCustomer': TypeInfo(TypeOf.Class, create:() => QueueCustomer()),
    'QueueCustomersResponse': TypeInfo(TypeOf.Class, create:() => QueueCustomersResponse()),
    'List<QueueCustomer>': TypeInfo(TypeOf.Class, create:() => <QueueCustomer>[]),
    'QueueCustomerRequest': TypeInfo(TypeOf.Class, create:() => QueueCustomerRequest()),
});

Dart QueueCustomerRequest 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 /v1/Customers/{Id} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ApiKey: 00000000000000000000000000000000,
	Id: 00000000000000000000000000000000,
	Name: String,
	Address1: String,
	Address2: String,
	City: String,
	State: String,
	Zip: String,
	MobilePhone: String,
	Email: String,
	MarketingOptIn: 0001-01-01,
	DoNoContact: 0001-01-01,
	EntDate: 0001-01-01,
	ModDate: 0001-01-01
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Customers: 
	[
		{
			Id: 00000000000000000000000000000000,
			Name: String,
			Address1: String,
			Address2: String,
			City: String,
			State: String,
			Zip: String,
			MobilePhone: String,
			Email: String,
			MarketingOptIn: 0001-01-01,
			DoNoContact: 0001-01-01,
			EntDate: 0001-01-01,
			ModDate: 0001-01-01
		}
	]
}