On this page:
| Table of Contents |
|---|
Management
Use these methods to retrieve informations about your environment (On this page:
| Table of Contents |
|---|
Management
Use these methods to retrieve informations about your environment (profiles, packages and languages) and configure your environment.
...
the return value is the HTTP Status code of the response. API executes this operation asynchronously. Every time the client invokes the method, it returns a code. If this code tells that the operations are still in progress the resource returns an 202 Accepted status code; otherwise returns a 200 OK status code. If an error occurred it returns 500 Internal Server Error.
the client can invoke the resource as many times as it wants.
Get retailer's customer account status
...
| Required | Where | Description | |
|---|---|---|---|
| id_Account | X | URL | See activation status response |
| id_Pack | X | URL | See get packages |
| Quantity | X | Body | |
| WorkMode | X | Body | WorkMode should be "incremental" or "absolute" and refers to the way to manage packages. The "incremental" work mode allows client to add or remove packages as defined by Quantity field. If client calls the method 3 times with quantity equals to 1, API method adds 1 package each time. If client needs to remove a package it calls the method with quantity equals to -1 and API method removes a package. The "absolute" work mode allows client to define the total number of packages.If client calls the method with quantity equals to 4, API method adds 4 packages. If client needs to remove 2 packages from the current quantity (set to 4 by the previews call) it calls the method with quantity equals to 2 and the API method removes 2 packages. NB: "absolute" work mode allows only unsigned value for Quantity. |
Description | Add package to retailer's customer account | ||||
|---|---|---|---|---|---|
HTTP Method | POST | ||||
URL |
| ||||
JSON request (example) | none | ||||
JSON response (example) |
| ||||
Paging and filtering (example) | none |
| Http verb |
| ||||||
|---|---|---|---|---|---|---|---|
| Resource URL | Account/{id_Account}/Pack/{id_Pack} NOTE: the id_Account is the value returned with Get reseller's customer account profile activation status resource | ||||||
| Request API |
| ||||||
| Return value | X | URL | See get packages | ||||
| Quantity | X | Body | Numeric value that depends on WorkMode. Please refers to row below. | ||||
| WorkMode | X | Body | Should be "incremental" or "absolute" and refers to the way to manage packages. The "incremental" work mode allows client to add or remove packages as defined by Quantity field. If client calls the method 3 times with quantity equals to 1, API method adds 1 package each time. If client needs to remove a package it calls the method with quantity equals to -1 and API method removes a package. The "absolute" work mode allows client to define the total number of packages.If client calls the method with quantity equals to 4, API method adds 4 packages. If client needs to remove 2 packages from the current quantity (set to 4 by the previews call) it calls the method with quantity equals to 2 and the API method removes 2 packages. NB: "absolute" work mode allows only unsigned value for Quantity. |
Description | Add package to retailer's customer account | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
HTTP Method | POST | ||||||||||||||||
URL |
| ||||||||||||||||
JSON request (example) |
| ||||||||||||||||
JSON response (example) |
| code = 1
| |||||||||||||||
Paging and filtering (example) | none |
Errors
| HTTP Status Code | When | Message |
|---|---|---|
| 400 BadRequest | IdPack is not numeric | Invalid pack. |
| ExternalUserId empty. | Invalid ExternalUserId. | |
| ExternalUserId validation fails |
...