Get Future License

URL:: https://<root>/license/getFutureLicense
Methods:: GET
Version Introduced:: 10.7.1

Access requirements

Required privileges

The Portal Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.

Manage Licenses

Tokens

This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Portal Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.

Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generateToken operation in the Portal Directory API. For security reasons, all POST requests made to the Portal Administrator API must include a token in the request body.

Learn how to generate a token

Description

The getFutureLicense operation returns your future user types and add-on license information. If your license includes future entitlements, this operation will return the maximum number of registered members per license and the date (Unix format) that it will go into effect. If your license does not have any future entitlements, this operation will still return the same future licensing information; however, the number of maximum registered members will be listed as 0 and the startDate response parameter will instead return the license's expiration date.

Request parameters

Parameter	Details
`f`	The response format. The default response format is `html`. Values: `html` \| `json` \| `pjson`

Example usage

The following is a sample GET request for the getFutureLicense operation:

Use dark colors for code blocksCopy
https://organization.example.com/<context>/license/getFutureLicense?f=pjson

JSON Response syntax

Use dark colors for code blocksCopy
{
  "userTypes": [
    {
      "id": <"user type ID">,
      "maximumRegisteredMembers": <number of maximum registered members>,
      "startDate": <date in epoch time>
    }
  ],
  "appBundles" [
    {
      "id": <"app bundle ID">,
      "itemId": <"item ID">,
      "maximumRegisteredMembers": <number of maximum registered members>,
      "startDate": <date in epoch time>
    }
  ],
  "apps": [
    {
      "id": <"app ID">,
      "itemId": <"item ID">,
      "maximumRegisteredMembers": <number of maximum registered members>,
      "startDate": <date in epoch time>
    }
  ],
  "extensions": [
    {
      "id": "<extension ID>",
      "itemId": "<item ID>",
      "maximumRegisteredMembers": <number of maximum registered members>,
      "startDate": <date in epoch time>
    }
  ],
  "portalCapabilities": []
}

JSON Response example

The response example below shows future entitlements for the Creator user type, Field Apps Bundle, and Insights application.

Use dark colors for code blocksCopy
{
  "userTypes": [
    {
      "id": "GISProfessionalAdvUT",
      "maximumRegisteredMembers": 0,
      "startDate": 1603225394000
    },
    {
      "id": "GISProfessionalBasicUT",
      "maximumRegisteredMembers": 0,
      "startDate": 1603225394000
    },
    {
      "id": "GISProfessionalStdUT",
      "maximumRegisteredMembers": 0,
      "startDate": 1603225394000
    },
    {
      "id": "basicUT",
      "maximumRegisteredMembers": 0,
      "startDate": 1603225394000
    },
    {
      "id": "creatorUT",
      "maximumRegisteredMembers": 0,
      "startDate": 1603225394000
    },
    {
      "id": "editorUT",
      "maximumRegisteredMembers": 0,
      "startDate": 1603225394000
    },
    {
      "id": "fieldWorkerUT",
      "maximumRegisteredMembers": 0,
      "startDate": 1603225394000
    },
    {
      "id": "insightsAnalystUT",
      "maximumRegisteredMembers": 0,
      "startDate": 1603225394000
    }
  ],
  "appBundles": [
    {
      "id": "essentialAppsAB",
      "itemId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
      "maximumRegisteredMembers": 0,
      "startDate": 1603225394000
    },
    {
      "id": "fieldAppsAB",
      "itemId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
      "maximumRegisteredMembers": 0,
      "startDate": 1603225394000
    },
    {
      "id": "officeAppsAB",
      "itemId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
      "maximumRegisteredMembers": 0,
      "startDate": 1603225394000
    }
  ],
  "apps": [
    {
      "id": "BusinessAnlyst",
      "itemId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
      "maximumRegisteredMembers": 0,
      "startDate": 1603225394000
    },
    {
      "id": "Drone2MapN",
      "itemId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
      "maximumRegisteredMembers": 0,
      "startDate": 1603225394000
    },
    {
      "id": "Insights",
      "itemId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
      "maximumRegisteredMembers": 0,
      "startDate": 1603225394000
    },
    {
      "id": "Navigator",
      "itemId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
      "maximumRegisteredMembers": 0,
      "startDate": 1603225394000
    },
    {
      "id": "QuickCapture",
      "itemId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
      "maximumRegisteredMembers": 0,
      "startDate": 1603225394000
    },
    {
      "id": "arcgisprodesktop",
      "itemId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
      "maximumRegisteredMembers": 0,
      "startDate": 1603225394000
    },
    {
      "id": "collector",
      "itemId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
      "maximumRegisteredMembers": 0,
      "startDate": 1603225394000
    },
    {
      "id": "survey123",
      "itemId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
      "maximumRegisteredMembers": 0,
      "startDate": 1603225394000
    },
    {
      "id": "tracker",
      "itemId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
      "maximumRegisteredMembers": 0,
      "startDate": 1603225394000
    },
    {
      "id": "workforce",
      "itemId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
      "maximumRegisteredMembers": 0,
      "startDate": 1603225394000
    }
  ],
  "extensions": [
    {
      "id": "parcelFabric",
      "itemId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
      "maximumRegisteredMembers": 0,
      "startDate": 1603225394000
    },
    {
      "id": "utilityNetwork",
      "itemId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
      "maximumRegisteredMembers": 0,
      "startDate": 1603225394000
    }
  ],
  "portalCapabilities": []
}