Trendsic Platform Service

<back to all web services

AvailableGiftCardRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/AvailableGiftCard/{AgentId}
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class GiftCard implements IConvertible
{
    int? GiftCardId;
    int? AgentId;
    String? CardType;
    String? CardNumber;
    int? ContactId;
    DateTime? DateCreated;
    DateTime? DateModified;
    DateTime? DateDeleted;
    String? GiftCardGameSetId;
    DateTime? FirstApptDate;
    bool? IsReferrerCard;
    String? AgentName;
    String? ContactName;

    GiftCard({this.GiftCardId,this.AgentId,this.CardType,this.CardNumber,this.ContactId,this.DateCreated,this.DateModified,this.DateDeleted,this.GiftCardGameSetId,this.FirstApptDate,this.IsReferrerCard,this.AgentName,this.ContactName});
    GiftCard.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        GiftCardId = json['GiftCardId'];
        AgentId = json['AgentId'];
        CardType = json['CardType'];
        CardNumber = json['CardNumber'];
        ContactId = json['ContactId'];
        DateCreated = JsonConverters.fromJson(json['DateCreated'],'DateTime',context!);
        DateModified = JsonConverters.fromJson(json['DateModified'],'DateTime',context!);
        DateDeleted = JsonConverters.fromJson(json['DateDeleted'],'DateTime',context!);
        GiftCardGameSetId = json['GiftCardGameSetId'];
        FirstApptDate = JsonConverters.fromJson(json['FirstApptDate'],'DateTime',context!);
        IsReferrerCard = json['IsReferrerCard'];
        AgentName = json['AgentName'];
        ContactName = json['ContactName'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'GiftCardId': GiftCardId,
        'AgentId': AgentId,
        'CardType': CardType,
        'CardNumber': CardNumber,
        'ContactId': ContactId,
        'DateCreated': JsonConverters.toJson(DateCreated,'DateTime',context!),
        'DateModified': JsonConverters.toJson(DateModified,'DateTime',context!),
        'DateDeleted': JsonConverters.toJson(DateDeleted,'DateTime',context!),
        'GiftCardGameSetId': GiftCardGameSetId,
        'FirstApptDate': JsonConverters.toJson(FirstApptDate,'DateTime',context!),
        'IsReferrerCard': IsReferrerCard,
        'AgentName': AgentName,
        'ContactName': ContactName
    };

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

class GiftCardResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    List<GiftCard>? GiftCard = [];

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

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

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

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

class AvailableGiftCardRequest implements IConvertible
{
    int? AgentId;

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

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

    Map<String, dynamic> toJson() => {
        'AgentId': AgentId
    };

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

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

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

GET /v1/AvailableGiftCard/{AgentId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
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
		}
	},
	GiftCard: 
	[
		{
			GiftCardId: 0,
			AgentId: 0,
			CardType: String,
			CardNumber: String,
			ContactId: 0,
			DateCreated: 0001-01-01,
			DateModified: 0001-01-01,
			DateDeleted: 0001-01-01,
			GiftCardGameSetId: String,
			FirstApptDate: 0001-01-01,
			IsReferrerCard: False,
			AgentName: String,
			ContactName: String
		}
	]
}