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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using TicketUserServices.ServiceModel;

namespace TicketUserServices.ServiceModel
{
    public partial class GiftCardHoldRequest
    {
        public virtual string Code { get; set; }
        public virtual int? AmountMinor { get; set; }
        public virtual int? EventId { get; set; }
        public virtual int? TargetOwnerId { get; set; }
        public virtual string OrderPaymentReference { get; set; }
        public virtual string IdempotencyKey { get; set; }
    }

    public partial class GiftCardHoldResult
    {
        public virtual bool Ok { get; set; }
        public virtual string Reason { get; set; }
        public virtual LocalizedMessage Message { get; set; }
        public virtual int? HoldId { get; set; }
        public virtual int HeldAmountMinor { get; set; }
        public virtual int RemainingAvailableMinor { get; set; }
        public virtual DateTime? ExpiresAt { get; set; }
        public virtual int StatusCode { get; set; }
    }

    public partial class LocalizedMessage
    {
        public virtual string Is { get; set; }
        public virtual string En { get; set; }
    }

}

C# 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>