| Requires any of the roles: | Admin, TeamAdmin | Requires the permission: | ReadData |
| GET | /GiftCard/Ledger/{GiftCardId} |
|---|
import Foundation
import ServiceStack
public class GiftCardLedgerRequest : Codable
{
public var giftCardId:Int?
required public init(){}
}
public class GiftCardLedgerResult : Codable
{
public var card:GiftCardSummary?
public var transactions:[GiftCardTransaction] = []
public var statusCode:Int?
public var message:String?
required public init(){}
}
public class GiftCardSummary : Codable
{
public var id:Int?
public var giftCardTypeId:Int?
public var codeLast4:String?
public var scope:String?
public var scopeOwnerId:Int?
public var currency:String?
public var initialValueMinor:Int?
public var currentBalanceMinor:Int?
public var status:String?
public var activatedAt:Date?
public var expiresAt:Date?
public var createdAt:Date?
public var buyerName:String?
public var buyerEmail:String?
public var buyerPhone:String?
public var paymentId:String?
public var paymentMethodId:String?
public var purchasePaymentReference:String?
required public init(){}
}
public class GiftCardTransaction : Codable
{
public var id:Int?
public var giftCardId:Int?
public var kind:String?
public var amountMinor:Int?
public var status:String?
public var holdExpiresAt:Date?
public var relatedHoldId:Int?
public var orderPaymentReference:String?
public var eventId:Int?
public var ownerId:Int?
public var idempotencyKey:String?
public var createdAt:Date?
public var note:String?
required public init(){}
}
Swift GiftCardLedgerRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>