TicketUserServices

<back to all web services

GiftCardSearchRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdminRequires the permission:ReadData
The following routes are available for this service:
POST/GiftCard/Search
namespace TicketUserServices.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type GiftCardSummary() = 
        member val ID:Int32 = new Int32() with get,set
        member val GiftCardTypeId:Int32 = new Int32() with get,set
        member val CodeLast4:String = null with get,set
        member val Scope:String = null with get,set
        member val ScopeOwnerId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Currency:String = null with get,set
        member val InitialValueMinor:Int32 = new Int32() with get,set
        member val CurrentBalanceMinor:Int32 = new Int32() with get,set
        member val Status:String = null with get,set
        member val ActivatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ExpiresAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val CreatedAt:DateTime = new DateTime() with get,set
        member val BuyerName:String = null with get,set
        member val BuyerEmail:String = null with get,set
        member val BuyerPhone:String = null with get,set
        member val PaymentId:String = null with get,set
        member val PaymentMethodId:String = null with get,set
        member val PurchasePaymentReference:String = null with get,set

    [<AllowNullLiteral>]
    type GiftCardSearchResult() = 
        member val Items:ResizeArray<GiftCardSummary> = new ResizeArray<GiftCardSummary>() with get,set
        member val StatusCode:Int32 = new Int32() with get,set
        member val Message:String = null with get,set

    [<AllowNullLiteral>]
    type GiftCardSearchRequest() = 
        member val GiftCardTypeId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Scope:String = null with get,set
        member val OwnerId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Status:String = null with get,set
        member val CodeLast4:String = null with get,set

F# GiftCardSearchRequest 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 /GiftCard/Search HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GiftCardSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <CodeLast4>String</CodeLast4>
  <GiftCardTypeId>0</GiftCardTypeId>
  <OwnerId>0</OwnerId>
  <Scope>String</Scope>
  <Status>String</Status>
</GiftCardSearchRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GiftCardSearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Items>
    <GiftCardSummary>
      <ActivatedAt>0001-01-01T00:00:00</ActivatedAt>
      <BuyerEmail>String</BuyerEmail>
      <BuyerName>String</BuyerName>
      <BuyerPhone>String</BuyerPhone>
      <CodeLast4>String</CodeLast4>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <Currency>String</Currency>
      <CurrentBalanceMinor>0</CurrentBalanceMinor>
      <ExpiresAt>0001-01-01T00:00:00</ExpiresAt>
      <GiftCardTypeId>0</GiftCardTypeId>
      <ID>0</ID>
      <InitialValueMinor>0</InitialValueMinor>
      <PaymentId>String</PaymentId>
      <PaymentMethodId>String</PaymentMethodId>
      <PurchasePaymentReference>String</PurchasePaymentReference>
      <Scope>String</Scope>
      <ScopeOwnerId>0</ScopeOwnerId>
      <Status>String</Status>
    </GiftCardSummary>
  </Items>
  <Message>String</Message>
  <StatusCode>0</StatusCode>
</GiftCardSearchResult>