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}
"use strict";
export class GiftCard {
    /** @param {{GiftCardId?:number,AgentId?:number,CardType?:string,CardNumber?:string,ContactId?:number,DateCreated?:string,DateModified?:string,DateDeleted?:string,GiftCardGameSetId?:string,FirstApptDate?:string,IsReferrerCard?:boolean,AgentName?:string,ContactName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    GiftCardId;
    /** @type {number} */
    AgentId;
    /** @type {string} */
    CardType;
    /** @type {string} */
    CardNumber;
    /** @type {number} */
    ContactId;
    /** @type {string} */
    DateCreated;
    /** @type {string} */
    DateModified;
    /** @type {string} */
    DateDeleted;
    /** @type {string} */
    GiftCardGameSetId;
    /** @type {string} */
    FirstApptDate;
    /** @type {boolean} */
    IsReferrerCard;
    /** @type {string} */
    AgentName;
    /** @type {string} */
    ContactName;
}
export class GiftCardResponse {
    /** @param {{ResponseStatus?:ResponseStatus,GiftCard?:GiftCard[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {GiftCard[]} */
    GiftCard = [];
}
export class GiftCardRequest {
    /** @param {{GiftCard?:GiftCard[],GiftCardId?:number,GiftCardGameSetId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {GiftCard[]} */
    GiftCard = [];
    /** @type {number} */
    GiftCardId;
    /** @type {number} */
    GiftCardGameSetId;
}

JavaScript GiftCardRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<GiftCardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <GiftCard>
    <GiftCard>
      <AgentId>0</AgentId>
      <AgentName>String</AgentName>
      <CardNumber>String</CardNumber>
      <CardType>String</CardType>
      <ContactId>0</ContactId>
      <ContactName>String</ContactName>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <DateDeleted>0001-01-01T00:00:00</DateDeleted>
      <DateModified>0001-01-01T00:00:00</DateModified>
      <FirstApptDate>0001-01-01T00:00:00</FirstApptDate>
      <GiftCardGameSetId>String</GiftCardGameSetId>
      <GiftCardId>0</GiftCardId>
      <IsReferrerCard>false</IsReferrerCard>
    </GiftCard>
  </GiftCard>
  <GiftCardGameSetId>0</GiftCardGameSetId>
  <GiftCardId>0</GiftCardId>
</GiftCardRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GiftCardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <GiftCard>
    <GiftCard>
      <AgentId>0</AgentId>
      <AgentName>String</AgentName>
      <CardNumber>String</CardNumber>
      <CardType>String</CardType>
      <ContactId>0</ContactId>
      <ContactName>String</ContactName>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <DateDeleted>0001-01-01T00:00:00</DateDeleted>
      <DateModified>0001-01-01T00:00:00</DateModified>
      <FirstApptDate>0001-01-01T00:00:00</FirstApptDate>
      <GiftCardGameSetId>String</GiftCardGameSetId>
      <GiftCardId>0</GiftCardId>
      <IsReferrerCard>false</IsReferrerCard>
    </GiftCard>
  </GiftCard>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</GiftCardResponse>