TicketUserServices

<back to all web services

GiftCardLedgerRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdminRequires the permission:ReadData
The following routes are available for this service:
GET/GiftCard/Ledger/{GiftCardId}
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using TicketUserServices.ServiceModel;
using TicketUserServices.ServiceModel.Types;

namespace TicketUserServices.ServiceModel
{
    public partial class GiftCardLedgerRequest
    {
        public virtual int GiftCardId { get; set; }
    }

    public partial class GiftCardLedgerResult
    {
        public GiftCardLedgerResult()
        {
            Transactions = new List<GiftCardTransaction>{};
        }

        public virtual GiftCardSummary Card { get; set; }
        public virtual List<GiftCardTransaction> Transactions { get; set; }
        public virtual int StatusCode { get; set; }
        public virtual string Message { get; set; }
    }

    public partial class GiftCardSummary
    {
        public virtual int ID { get; set; }
        public virtual int GiftCardTypeId { get; set; }
        public virtual string CodeLast4 { get; set; }
        public virtual string Scope { get; set; }
        public virtual int? ScopeOwnerId { get; set; }
        public virtual string Currency { get; set; }
        public virtual int InitialValueMinor { get; set; }
        public virtual int CurrentBalanceMinor { get; set; }
        public virtual string Status { get; set; }
        public virtual DateTime? ActivatedAt { get; set; }
        public virtual DateTime? ExpiresAt { get; set; }
        public virtual DateTime CreatedAt { get; set; }
        public virtual string BuyerName { get; set; }
        public virtual string BuyerEmail { get; set; }
        public virtual string BuyerPhone { get; set; }
        public virtual string PaymentId { get; set; }
        public virtual string PaymentMethodId { get; set; }
        public virtual string PurchasePaymentReference { get; set; }
    }

}

namespace TicketUserServices.ServiceModel.Types
{
    public partial class GiftCardTransaction
    {
        public virtual int ID { get; set; }
        public virtual int GiftCardId { get; set; }
        public virtual string Kind { get; set; }
        public virtual int AmountMinor { get; set; }
        public virtual string Status { get; set; }
        public virtual DateTime? HoldExpiresAt { get; set; }
        public virtual int? RelatedHoldId { get; set; }
        public virtual string OrderPaymentReference { get; set; }
        public virtual int? EventId { get; set; }
        public virtual int? OwnerId { get; set; }
        public virtual string IdempotencyKey { get; set; }
        public virtual DateTime CreatedAt { get; set; }
        public virtual string Note { get; set; }
    }

}

C# GiftCardLedgerRequest 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 /GiftCard/Ledger/{GiftCardId} HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GiftCardLedgerResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Card>
    <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>
  </Card>
  <Message>String</Message>
  <StatusCode>0</StatusCode>
  <Transactions xmlns:d2p1="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel.Types">
    <d2p1:GiftCardTransaction>
      <d2p1:AmountMinor>0</d2p1:AmountMinor>
      <d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
      <d2p1:EventId>0</d2p1:EventId>
      <d2p1:GiftCardId>0</d2p1:GiftCardId>
      <d2p1:HoldExpiresAt>0001-01-01T00:00:00</d2p1:HoldExpiresAt>
      <d2p1:ID>0</d2p1:ID>
      <d2p1:IdempotencyKey>String</d2p1:IdempotencyKey>
      <d2p1:Kind>String</d2p1:Kind>
      <d2p1:Note>String</d2p1:Note>
      <d2p1:OrderPaymentReference>String</d2p1:OrderPaymentReference>
      <d2p1:OwnerId>0</d2p1:OwnerId>
      <d2p1:RelatedHoldId>0</d2p1:RelatedHoldId>
      <d2p1:Status>String</d2p1:Status>
    </d2p1:GiftCardTransaction>
  </Transactions>
</GiftCardLedgerResult>