Last Updated: 1/22/2020 12:11:02 AM
Get groups with given customers.
Request
HTTP Request
GET /SMPI/{version}/service/wfbss/api/customers/groups
Parameters
Name |
Type |
Description |
Validation |
|---|---|---|---|
|
Optional Parameters |
|||
cids |
string |
A list of customer ID separated by comma. |
At least one customer ID must be specified, and no more than 10. |
page |
integer |
Page number |
1 to max. If not set, default is 1. |
limit |
integer |
Number of records per page |
1 to 100. If not set, default is 100. |
HTTP Request Example
Get the first page of the groups of all your customers (100 records per page):
GET /SMPI/{version}/service/wfbss/api/customers/groups
Get the 2nd page of the groups of all your customers (50 records per page):
GET /SMPI/{version}/service/wfbss/api/customers/groups?page=2&limit=50
Get the first page of the groups of specific customers (100 records per page):
GET /SMPI/{version}/service/wfbss/api/customers/groups?cids=640FE47F-5118-4D79-8221-A35D0DE2EE2C,549390C2-61B3-417E-B1F0-8955A63C08F3
Request Body
Do not supply a request body with this method.
Response
Response
If successful, this method returns an HTTP 200 OK status code and a response body with the following structure:
{
"paging": {
"total": 2,
"limit": 100,
"page": 1
},
"customers": [
{
"id": "640FE47F-5118-4D79-8221-A35D0DE2EE2C",
"eid": "7D100F62-4E36-4507-882F-93E069DBD79C",
"groups": [
{
"type": 1,
"id": 1,
"name": "Device (Default)"
},
{
"type": 2,
"id": 2,
"name": "Server (Default)"
}
]
},
{
"id": "549390C2-61B3-417E-B1F0-8955A63C08F3",
"eid": "05ACB83A-E709-47B5-98C1-6CEA25476536",
"groups": [
{
"type": 1,
"id": 1,
"name": "Device (Default)"
},
{
"type": 2,
"id": 2,
"name": "Server (Default)"
}
]
}
]
}
Name |
Type |
Description |
Length |
|---|---|---|---|
paging.total |
integer |
The total number of records |
|
paging.limit |
integer |
The number of records per page |
1 to 100 |
paging.page |
integer |
Page number |
1 to max |
customers[].id |
string |
Customer ID |
GUID |
customers[].eid |
string |
For internal use only |
GUID |
customers[].groups[].type |
integer |
Group's device type |
1 = Server, 2 = Desktop, 3 = Mixed |
customers[].groups[].id |
integer |
Group ID |
|
customers[].groups[].name |
string |
Group name |