TicketUserServices

<back to all web services

GiftCardTypesSearchRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdminRequired permission:Tickets.Add
The following routes are available for this service:
POST/GiftCardType/Search
GiftCardTypesSearchRequest Parameters:
NameParameterData TypeRequiredDescription
ScopebodystringNo
OwnerIdbodyint?No
GiftCardTypesResult Parameters:
NameParameterData TypeRequiredDescription
ItemsformList<GiftCardType>No
StatusCodeformintNo
MessageformstringNo
GiftCardType Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
NameformstringNo
ScopeformstringNo
OwnerIdformint?No
CurrencyformstringNo
DefaultExpiryMonthsformint?No
IsActiveformboolNo
CreatedAtformDateTimeNo

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

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

<GiftCardTypesResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel.Types">
    <d2p1:GiftCardType>
      <d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
      <d2p1:Currency>String</d2p1:Currency>
      <d2p1:DefaultExpiryMonths>0</d2p1:DefaultExpiryMonths>
      <d2p1:ID>0</d2p1:ID>
      <d2p1:IsActive>false</d2p1:IsActive>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:OwnerId>0</d2p1:OwnerId>
      <d2p1:Scope>String</d2p1:Scope>
    </d2p1:GiftCardType>
  </Items>
  <Message>String</Message>
  <StatusCode>0</StatusCode>
</GiftCardTypesResult>