Trendsic Platform Service

<back to all web services

GiftCardRequest

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET,DELETE,OPTIONS/v1/GiftCard/{GiftCardId}
GET,POST,PUT,OPTIONS/v1/GiftCard
GET,OPTIONS/v1/GiftCard/ByGameSet/{GiftCardGameSetId}
GiftCardRequest Parameters:
NameParameterData TypeRequiredDescription
GiftCardbodyList<GiftCard>No
GiftCardIdpathintNo
GiftCardGameSetIdpathintNo
GiftCard Parameters:
NameParameterData TypeRequiredDescription
GiftCardIdformintNo
AgentIdformintNo
CardTypeformstringNo
CardNumberformstringNo
ContactIdformintNo
DateCreatedformDateTimeNo
DateModifiedformDateTimeNo
DateDeletedformDateTimeNo
GiftCardGameSetIdformstringNo
FirstApptDateformDateTimeNo
IsReferrerCardformboolNo
AgentNameformstringNo
ContactNameformstringNo
GiftCardResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
GiftCardformList<GiftCard>No

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/GiftCard HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	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
		}
	],
	GiftCardId: 0,
	GiftCardGameSetId: 0
}
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
		}
	]
}