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 datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GiftCard:
    gift_card_id: int = 0
    agent_id: int = 0
    card_type: Optional[str] = None
    card_number: Optional[str] = None
    contact_id: int = 0
    date_created: datetime.datetime = datetime.datetime(1, 1, 1)
    date_modified: datetime.datetime = datetime.datetime(1, 1, 1)
    date_deleted: datetime.datetime = datetime.datetime(1, 1, 1)
    gift_card_game_set_id: Optional[str] = None
    first_appt_date: datetime.datetime = datetime.datetime(1, 1, 1)
    is_referrer_card: bool = False
    agent_name: Optional[str] = None
    contact_name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GiftCardResponse:
    response_status: Optional[ResponseStatus] = None
    gift_card: List[GiftCard] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AvailableGiftCardRequest:
    agent_id: int = 0

Python 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
		}
	]
}