TicketUserServices

<back to all web services

GiftCardBalanceRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdmin, MobileAppRequires the permission:ReadData
The following routes are available for this service:
POST/GiftCard/Balance

export class LocalizedMessage
{
    public is?: string;
    public en?: string;

    public constructor(init?: Partial<LocalizedMessage>) { (Object as any).assign(this, init); }
}

export class GiftCardValidateResult
{
    public ok?: boolean;
    public reason?: string;
    public message?: LocalizedMessage;
    public status?: string;
    public availableMinor?: number;
    public applicableMinor?: number;
    public scope?: string;
    public scopeOwnerId?: number;
    public expiresAt?: string;
    public statusCode?: number;

    public constructor(init?: Partial<GiftCardValidateResult>) { (Object as any).assign(this, init); }
}

export class GiftCardBalanceRequest
{
    public code?: string;

    public constructor(init?: Partial<GiftCardBalanceRequest>) { (Object as any).assign(this, init); }
}

TypeScript GiftCardBalanceRequest 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/Balance HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

<GiftCardValidateResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <ApplicableMinor>0</ApplicableMinor>
  <AvailableMinor>0</AvailableMinor>
  <ExpiresAt>0001-01-01T00:00:00</ExpiresAt>
  <Message>
    <En>String</En>
    <Is>String</Is>
  </Message>
  <Ok>false</Ok>
  <Reason>String</Reason>
  <Scope>String</Scope>
  <ScopeOwnerId>0</ScopeOwnerId>
  <Status>String</Status>
  <StatusCode>0</StatusCode>
</GiftCardValidateResult>