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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"buyerPhone":"String","sourceOwnerCardId":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"enabled":false,"cards":[{"sourceOwnerCardId":0,"ownerId":0,"ownerCardTypeId":0,"typeName":"String","pricePaid":0,"cardPrice":0,"cardValidFromUTC":"0001-01-01T00:00:00.0000000","cardValidToUTC":"0001-01-01T00:00:00.0000000","paymentStatus":"String","eligible":false,"reasonCode":0,"reason":"String","candidates":[{"ownerCardTypeId":0,"name":"String","description":"String","imageUrl":"String","price":0,"delta":0,"validFromUTC":"0001-01-01T00:00:00.0000000","validToUTC":"0001-01-01T00:00:00.0000000"}]}],"statusCode":0,"message":"String","reason":"String"}