TicketUserServices

<back to all web services

GiftCardHoldRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdmin, MobileAppRequired permission:Tickets.Add
The following routes are available for this service:
POST/GiftCard/Hold
namespace TicketUserServices.ServiceModel

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

    [<AllowNullLiteral>]
    type LocalizedMessage() = 
        member val Is:String = null with get,set
        member val En:String = null with get,set

    [<AllowNullLiteral>]
    type GiftCardHoldResult() = 
        member val Ok:Boolean = new Boolean() with get,set
        member val Reason:String = null with get,set
        member val Message:LocalizedMessage = null with get,set
        member val HoldId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val HeldAmountMinor:Int32 = new Int32() with get,set
        member val RemainingAvailableMinor:Int32 = new Int32() with get,set
        member val ExpiresAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val StatusCode:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type GiftCardHoldRequest() = 
        member val Code:String = null with get,set
        member val AmountMinor:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val EventId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val TargetOwnerId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val OrderPaymentReference:String = null with get,set
        member val IdempotencyKey:String = null with get,set

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

<GiftCardHoldRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <AmountMinor>0</AmountMinor>
  <Code>String</Code>
  <EventId>0</EventId>
  <IdempotencyKey>String</IdempotencyKey>
  <OrderPaymentReference>String</OrderPaymentReference>
  <TargetOwnerId>0</TargetOwnerId>
</GiftCardHoldRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GiftCardHoldResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <ExpiresAt>0001-01-01T00:00:00</ExpiresAt>
  <HeldAmountMinor>0</HeldAmountMinor>
  <HoldId>0</HoldId>
  <Message>
    <En>String</En>
    <Is>String</Is>
  </Message>
  <Ok>false</Ok>
  <Reason>String</Reason>
  <RemainingAvailableMinor>0</RemainingAvailableMinor>
  <StatusCode>0</StatusCode>
</GiftCardHoldResult>