# Get Mobile Upgrade

## Get Mobile Upgrade

The Get Mobile Upgrade API allows to get mobile upgrade details for a specific mobile application.

## Input Parameters:

| Name       | Required | Definition                                                                         | Comments                                                                              |
| ---------- | -------- | ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| MobileType | Y        | <p>Format: Alphanumeric, 50<br>Description: Contains Device Type</p>               |                                                                                       |
| OrgId      | Y        | <p>Format: Alphanumeric, 20<br>Value can be multiple org\_id’s split by commas</p> | Allow to request relevant Distributor's upgrade information (future: support Reseller |
| Version    | Y        | <p>Format: Alphanumeric, 120<br>Description: Version ID</p>                        |                                                                                       |

## Output Parameters:

| Name               | Definition                                                                                                                              | Failure Case | Success Case | Comments                            |
| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------ | ----------------------------------- |
| NewVersion         | <p>Format: Alphanumeric, 120<br>Description: New version ID to be install in mobile</p>                                                 | Not returned | Returned     |                                     |
| UpgradeDescription | <p>Format: Alphanumeric, 300<br>Description: Contains list of features/changes in new version</p>                                       | Not returned | Returned     | Returned in UpgradeDescriptions tag |
| UpgradeLink        | <p>Format: Alphanumeric, 300<br>Description: Contains the link to the store page containing the upgrade application to be installed</p> | Not returned | Returned     |                                     |
| UpgradeRequired    | <p>Format: Y, N<br>Description: Indicates if the mobile user must do an upgrade or not</p>                                              | Not returned | Returned     |                                     |

## XML Samples

### Input XML

```json
<?xml version="1.0"?>
<PraxellXMLRequest>
  <ServiceDetails>
    <UniqueRequestId>963369551</UniqueRequestId>
    <ServiceName>GetMobileUpgrade</ServiceName>
  </ServiceDetails>
  <Origin>
    <OriginType>Mobile</OriginType>
  </Origin>
  <ServiceParams>
    <OrgId>JPay</OrgId>
    <Version>13.3</Version>
  </ServiceParams>
</PraxellXMLRequest>
```

```json
<?xml version="1.0"?>
<PraxellXMLResponse>
     <ResponseDetails>
        <ServiceName>GetMobileUpgrade</ServiceName>
        <SessionId>38097317201110064</SessionId>
        <StatusCode>0</StatusCode>
        <StatusName>StatusOK</StatusName>
        <StatusDescription>NA</StatusDescription>
        <ServiceDate>2011-06-05 17:10:40</ServiceDate>
        <ServiceId>38097317201110064</ServiceId>
    </ResponseDetails>
<ResponseParams>
    <NewVersion>13.4</NewVersion>
    <UpgradeRequired>Y</UpgradeRequired>
       <UpgradeDescription>Pay Bill, Second New Feature</UpgradeDescription>
    <UpgradeLink>http:/mobileshop/shop.com/MobileUpgrade.html</UpgradeLink>
</ResponseParams>
</PraxellXMLResponse>
```

```json
<?xml version="1.0"?>
<PraxellXMLResponse>
  <ResponseDetails>
    <ServiceName>GetMobileUpgrade</ServiceName>
    <SessionId>07071612200737105</SessionId>
    <StatusCode>70029</StatusCode>
    <StatusName>Data not found (cardholder not found)</StatusName>
    <StatusDescription>Data not found (cardholder not found)</StatusDescription>
    <ServiceDate>2021-10-01 12:37:50</ServiceDate>
    <ServiceId>07071612200737105</ServiceId>
  </ResponseDetails>
  <ResponseParams>
  </ResponseParams>
</PraxellXMLResponse>
```