...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
URL params
Param | Meaning |
---|---|
{id_Profile} | The id identifying a Profile |
{id_Account} | The id identifying a Console |
{id_Activation} | The id identifying the process to create a new console |
{id_Login} | The id identifying an available login on a console |
{id_Pack} | The id identifying a Pack |
{lang} | The Console culture. It is the TwoLetterISOLanguageName. |
La validazione di questi parametri, utilizzati nelle sezioni dell'URL per identificare risorse, sono validati dalla classe ResellerResourceValidationRequestAuthorizerBase.
AuthorizationCode params
Param | Meaning |
---|---|
ExternalUserId | The id identifying a reseller's customer on its platform |
ClientId | It uniquely identifies the Consumer application. NB: the record identified by ClientId MUST HAVE the IsReseller field equals to TRUE to access to reseller API. |
ResellerId | It is the DeveloperId field of the record identified by the ClientId into APIConsumerApplication table. It equals to:
It identifies the Reseller Console. |
Resources
...
On this page:
Table of Contents |
---|
Management
Use these methods to retrieve informations about your environment (profiles, packages and languages).
Get reseller's profiles
Get the ResellerProfile table records WHERE IdReseller field equals ResellerId authorization code value.
...
Http verb |
| ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Resource URL | Account/{id_Account}/Profile/{id_Profile} NOTE: the id_Account is the value returned with Get reseller's customer account profile activation status resource | ||||||||||||
Request API |
| ||||||||||||
Request ADM |
| ||||||||||||
Return value | - NOTE: the return value is the HTTP Status code of the response. ADM executes this operation asynchronously. Every time the reseller invokes the resource, ADM 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. NOTE 2: the reseller can invoke the resource as many times as it wants. |
WHEN REQUESTS FAIL:
HTTP Status Code | When | Message |
---|---|---|
400 BadRequest | ExternalUserId empty. | Invalid ExternalUserId. |
ExternalUserId validation fails |
...
Http verb |
| |||||||||
---|---|---|---|---|---|---|---|---|---|---|
Resource URL | Account/{id_Account} or Account/{id_Account}?Enable=false NOTE: the id_Account is the value returned with Get reseller's customer account profile activation status resource | |||||||||
Request API |
| |||||||||
Request ADM | None | |||||||||
Return value | The resource returns a 200 OK status code and and object containing account status properties. In detail the returned object actually contains:
|
WHEN REQUESTS FAIL:
HTTP Status Code | When | Message |
---|---|---|
400 BadRequest | ExternalUserId empty. | Invalid ExternalUserId. |
ExternalUserId validation fails |
...
Http verb |
| |||||||||
---|---|---|---|---|---|---|---|---|---|---|
Resource URL | Account/{id_Account} or Account/{id_Account}?Enable=true NOTE: the id_Account is the value returned with Get reseller's customer account profile activation status resource | |||||||||
Request API |
| |||||||||
Request ADM | None | |||||||||
Return value | The resource returns a 200 OK status code and and object containing account status properties. In detail the returned object actually contains:
|
WHEN REQUESTS FAIL:
HTTP Status Code | When | Message |
---|---|---|
400 BadRequest | ExternalUserId empty. | Invalid ExternalUserId. |
ExternalUserId validation fails |
...
Http verb |
| ||||||||
---|---|---|---|---|---|---|---|---|---|
Resource URL | Account/{id_Account} NOTE: the id_Account is the value returned with Get reseller's customer account profile activation status resource | ||||||||
Request API |
| ||||||||
Request ADM | TBD | ||||||||
Return value | The resource returns a 200 OK status code. |
WHEN REQUESTS FAIL:
HTTP Status Code | When | Message |
---|---|---|
400 BadRequest | ExternalUserId empty. | Invalid ExternalUserId. |
ExternalUserId validation fails |
...
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 |
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.
| |||||||||||||||
Request ADM |
| |||||||||||||||
Return value | In detail the returned object actually contains:
NOTE: the resource returns a 200 OK status code if the package was added succesfully and the response contains code = 0; if the addition does not end propertly, the resource returns a 403 Forbidden and the response contains code = 1 |
WHEN REQUESTS RUN:
- the response contains an object with:
- Code = 0
- Description = Ok
...