TicketUserServices

<back to all web services

OwnerCardsUpgradeCandidatesRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdminRequires the permission:ReadData
The following routes are available for this service:
POST/OrderOwnerCards/upgrade/candidatesLive owner cards of a verified phone and the card types each may be upgraded to (rules U1-U10)
OwnerCardsUpgradeCandidatesRequest Parameters:
NameParameterData TypeRequiredDescription
BuyerPhonebodystringNo
SourceOwnerCardIdbodyint?No
OwnerCardsUpgradeCandidatesResult Parameters:
NameParameterData TypeRequiredDescription
EnabledformboolNo
CardsformList<OwnerCardUpgradeSource>No
OwnerCardUpgradeResultBase Parameters:
NameParameterData TypeRequiredDescription
StatusCodeformintNo
MessageformstringNo
ReasonformstringNo
OwnerCardUpgradeSource Parameters:
NameParameterData TypeRequiredDescription
SourceOwnerCardIdformintNo
OwnerIdformintNo
OwnerCardTypeIdformintNo
TypeNameformstringNo
PricePaidformintNo
CardPriceformintNo
CardValidFromUTCformDateTime?No
CardValidToUTCformDateTime?No
PaymentStatusformstringNo
EligibleformboolNo
ReasonCodeformint?No
ReasonformstringNo
CandidatesformList<OwnerCardUpgradeTarget>No
OwnerCardUpgradeTarget Parameters:
NameParameterData TypeRequiredDescription
OwnerCardTypeIdformintNo
NameformstringNo
DescriptionformstringNo
ImageUrlformstringNo
PriceformintNo
DeltaformintNo
ValidFromUTCformDateTimeNo
ValidToUTCformDateTimeNo

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

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

<OwnerCardsUpgradeCandidatesResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Message>String</Message>
  <Reason>String</Reason>
  <StatusCode>0</StatusCode>
  <Cards>
    <OwnerCardUpgradeSource>
      <Candidates>
        <OwnerCardUpgradeTarget>
          <Delta>0</Delta>
          <Description>String</Description>
          <ImageUrl>String</ImageUrl>
          <Name>String</Name>
          <OwnerCardTypeId>0</OwnerCardTypeId>
          <Price>0</Price>
          <ValidFromUTC>0001-01-01T00:00:00</ValidFromUTC>
          <ValidToUTC>0001-01-01T00:00:00</ValidToUTC>
        </OwnerCardUpgradeTarget>
      </Candidates>
      <CardPrice>0</CardPrice>
      <CardValidFromUTC>0001-01-01T00:00:00</CardValidFromUTC>
      <CardValidToUTC>0001-01-01T00:00:00</CardValidToUTC>
      <Eligible>false</Eligible>
      <OwnerCardTypeId>0</OwnerCardTypeId>
      <OwnerId>0</OwnerId>
      <PaymentStatus>String</PaymentStatus>
      <PricePaid>0</PricePaid>
      <Reason>String</Reason>
      <ReasonCode>0</ReasonCode>
      <SourceOwnerCardId>0</SourceOwnerCardId>
      <TypeName>String</TypeName>
    </OwnerCardUpgradeSource>
  </Cards>
  <Enabled>false</Enabled>
</OwnerCardsUpgradeCandidatesResult>