- URL:https://[root]/portals/[portalID]/customersList
Example usage
Below is a sample ArcGIS Online request URL used to access the customersList resource:
https://org.arcgis.com/sharing/rest/portals/0123456789ABCDEF/customersList?includeListing=true&f=pjsonDescription
The customersList resource returns a list of purchases, trials, and interests expressed by customers for items listed by this organization in the marketplace. This operation allows filtering and sorting of provisions.
Request parameters
| Parameter | Details |
|---|---|
| status | Status of the provisions to be returned. The default is all.
Values: all | expired | active |
| type | Access type of the provisions to be returned:
Values: REQUEST | TRIAL | PURCHASE | REQUESTANDTRIAL | REQUESTANDPURCHASE | TRIALANDPURCHASE |
| itemId | The item ID of the provision to be returned. |
| orgname | Purchaser organization name of the provisions to be returned. |
| modified | The last modified date of the provisions to be returned. The date specified should be in milliseconds from epoch. Example |
| sortFields | The fields to sort provisions by. The allowed sort field names are orgname, created, endDate, and modified. |
| sortOrder | Describes whether the order returns in ascending or descending order. Values: asc | desc |
| includeListing | If true, listing objects are included in the provision response. The default is true. Values: true | false |
| num | The maximum number of provisions to be included in the result set response. The default value is 10, and the maximum allowed value is 100. The start parameter, along with the num parameter, can be used to paginate the query results. Note that the actual number of returned results may be less than num. This happens when the number of results remaining after start is less than num. Example |
| start | The number of the first entry in the result set response. The index number is 1-based. The default value of start is 1. (i.e. the first search result). The start parameter, along with the num parameter, can be used to paginate the query results. Example |
| f | The response format. The default format is html. Values: html | json | pjson |
JSON Response syntax
{
"total": <total number of results>,
"start": <results in first set>,
"num": <number of results per page>,
"nextStart": <result number of next page>,
"provisions": [
{
"provision": {<provision1>},
"customer": {<customer1>},
"listing": {<listing1>}
},
{
"provision": {<provision2>},
"customer": {<customer2>},
"listing": {<listing2>}
}
]
}JSON Response example
{
"total": 28,
"start": 1,
"num": 10,
"nextStart": 11,
"provisions": [
{
"provision": {
"itemId": "448772a88d4b498d064ce2e8c6ff6b",
"provisionedItemId": "448772a88d4b498d064ce2e8c6ff6b",
"accountId": "HwhoSWTiJyaB0VDi",
"purchaserOrgId": "sWwd06TnJR4lHopc",
"purchaserUsername": "purchaser",
"purchaserFullName": "Test Full Name",
"purchaserEmail": "[email protected]",
"purchaserPhone": "9097932853",
"startDate": 1454392931000,
"endDate": -1,
"purchased": true,
"trial": false,
"interested": false,
"created": 1454392922000,
"modified": 1454392931000,
"title": "TEST Listing"
},
"customer": {
"id": "sWwd06TnJR4lHopc",
"name": "nebul1",
"description": "<br>",
"thumbnail": "thumbnail.jpg"
},
"listing": {
"itemId": "448772a88d4b498d064ce2e8c6ff6b",
"licenseType": "ela",
"priceDesc": "100$",
"creditsPerTransaction": 0,
"listingAccess": "public",
"trialSupported": false,
"ecommerceEnabled": false,
"licenseBy": "licenseByUser",
"type": "Web Mapping Application",
"typeKeywords": ["JavaScript", "Map", "Mapping Site", "Online Map", "Ready To Use", "Web Map", "Registered App"],
"title": "TEST Listing",
"tags": ["test"],
"thumbnail": "thumbnail/ago_downloaded.png",
"appCategories": [],
"industries": [],
"languages": [],
"screenshots": [],
"owner": "provider-admin-username",
"created": 1454392915000,
"avgRating": 0,
"numComments": 0,
"numRatings": 0,
"vendor": {
"id": "HwhosSWTiJyaagbB0VDi",
"name": "My Org Name",
"description": "My Org description",
"thumbnail": "thumbnail.jpg",
"orgEmail": "[email protected]",
"orgPhone": "111-1111-1111",
"orgUrl": "https://myorgurl/contactus.html"
}
}
}
]
}