| Requires any of the roles: | Admin, TeamAdmin | Requires the permission: | ReadData |
| POST | /OrderOwnerCards/upgrade/candidates | Live owner cards of a verified phone and the card types each may be upgraded to (rules U1-U10) |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BuyerPhone | body | string | No | |
| SourceOwnerCardId | body | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Enabled | form | bool | No | |
| Cards | form | List<OwnerCardUpgradeSource> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StatusCode | form | int | No | |
| Message | form | string | No | |
| Reason | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SourceOwnerCardId | form | int | No | |
| OwnerId | form | int | No | |
| OwnerCardTypeId | form | int | No | |
| TypeName | form | string | No | |
| PricePaid | form | int | No | |
| CardPrice | form | int | No | |
| CardValidFromUTC | form | DateTime? | No | |
| CardValidToUTC | form | DateTime? | No | |
| PaymentStatus | form | string | No | |
| Eligible | form | bool | No | |
| ReasonCode | form | int? | No | |
| Reason | form | string | No | |
| Candidates | form | List<OwnerCardUpgradeTarget> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OwnerCardTypeId | form | int | No | |
| Name | form | string | No | |
| Description | form | string | No | |
| ImageUrl | form | string | No | |
| Price | form | int | No | |
| Delta | form | int | No | |
| ValidFromUTC | form | DateTime | No | |
| ValidToUTC | form | DateTime | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
Content-Type: text/jsv
Content-Length: length
{
buyerPhone: String,
sourceOwnerCardId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
enabled: False,
cards:
[
{
sourceOwnerCardId: 0,
ownerId: 0,
ownerCardTypeId: 0,
typeName: String,
pricePaid: 0,
cardPrice: 0,
cardValidFromUTC: 0001-01-01,
cardValidToUTC: 0001-01-01,
paymentStatus: String,
eligible: False,
reasonCode: 0,
reason: String,
candidates:
[
{
ownerCardTypeId: 0,
name: String,
description: String,
imageUrl: String,
price: 0,
delta: 0,
validFromUTC: 0001-01-01,
validToUTC: 0001-01-01
}
]
}
],
statusCode: 0,
message: String,
reason: String
}