Retrieve a list of products that cannot be requested, if the current product has been requested. This also goes vice versa: if one or more products from the retrieved list are requested, this product cannot be requested anymore.
Request
Request URI
| Method | Request URI |
|---|---|
| GET | https://{company-name}.helloid.com/api/v1/selfservice/products/{<SelfServiceProductGuid> Guid}/segregatedproducts |
| GET | https://{company-name}.helloid.com/api/v1/selfservice/products/{<SKU>string}/segregatedproducts |
Request parameters
| Parameter | Description |
|---|---|
| {company-name} | The company name of the target company |
| {<SelfServiceProductGuid>Guid} | The GUID of the self-service products to retrieve the segregate products list from. |
| {<SKU>string} | The product SKU of the self-service products to retrieve the segregate products list from. |
Request headers
| Parameter | Description |
|---|---|
| Content-Type | Required. Must be set to application/json. |
Request body
None.
Response
Response status
| Code | Description |
|---|---|
| 200(OK) | Indicates that the operation was successful. |
| 400(BAD REQUEST) | Indicates that the operation was not successful. There were validation errors or the request body was malformed. |
| 401(UNAUTHORIZED) | Indicates that no authentication header was given or the api key and secret were invalid. If the api key and secret were valid check the configuration in your portal, it is possibilty these were IP restricted or are disabled. |
| 404(NOT FOUND) | The operation was not successful. The <Type> has not been found. |
Please also see common HTTP status codes.
Sample response body
[
{
“selfServiceProductGUID”: “24a68445-dc2f-400f-8982-f9ea5e65aa89”,
“name”: “Product name”,
“description”: “Product description”,
“code”: “ProductSKU”
}
]
Example request with cURL
Replace placeholder values surrounded by { } with the actual values.
curl -u {api-key}:{api-secret} -X GET https://{company-name}.helloid.com/api/v1/selfservice/products/20171222RZTAUTFJGK/segregatedproducts
curl -u {api-key}:{api-secret} -X GET https://{company-name}.helloid.com/api/v1/selfservice/products/ba43609b-3725-4330-94e2-74c5cca44699/segregatedproducts