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}
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class AvailableGiftCardRequest
            Public Overridable Property AgentId As Integer
        End Class

        Public Partial Class GiftCard
            Public Overridable Property GiftCardId As Integer
            Public Overridable Property AgentId As Integer
            Public Overridable Property CardType As String
            Public Overridable Property CardNumber As String
            Public Overridable Property ContactId As Integer
            Public Overridable Property DateCreated As Date
            Public Overridable Property DateModified As Date
            Public Overridable Property DateDeleted As Date
            Public Overridable Property GiftCardGameSetId As String
            Public Overridable Property FirstApptDate As Date
            Public Overridable Property IsReferrerCard As Boolean
            Public Overridable Property AgentName As String
            Public Overridable Property ContactName As String
        End Class

        Public Partial Class GiftCardResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property GiftCard As List(Of GiftCard) = New List(Of GiftCard)
        End Class
    End Namespace
End Namespace

VB.NET AvailableGiftCardRequest 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.

GET /v1/AvailableGiftCard/{AgentId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
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>