On this page:
...
Description | Get profile's packages defined by retailer. | ||||
---|---|---|---|---|---|
HTTP Method | GET | ||||
URL |
| ||||
JSON request (example) | none | ||||
JSON response (example) |
| ||||
Paging and filtering (example) | none |
...
Required | Where | |
---|---|---|
id_Profile | X | URL |
...
A list of pack objects containing:
- Id
- Name
- Description
- Min
- Max
- ClientCode
NOTE: The type is hidden for the reseller.
WHEN REQUESTS RUN:
- ExternalUserId is empty
- ExternalUserId has a value
...
| ||
Paging and filtering (example) | none |
---|
Errors
HTTP Status Code | When | Message |
---|---|---|
403 Forbidden | Unexisting id_profile | You cannot access to provided profile. |
id_profile not assigned to specified IdConsoleRetailerRetailer account |
...
Note
- Min e Max sono il numero di pacchetti minimo e massimo gestibili dal profiloequals to the number of packages manageable by selected profile.
Get reseller's available languages by profile
Get the languages available by profile
...
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
...
HTTP Status Code | When | Message |
---|---|---|
400 BadRequest | IdPack is not numeric | Invalid pack. |
ExternalUserId empty. | Invalid ExternalUserId. | |
ExternalUserId validation fails | ||
403 Forbidden | The package cannot be added | the response contains an object with:
|
NOTE
- Non si possono aggiungere/rimuovere pacchetti ad un profilo TRIAL
- Non di possono rimuovere pacchetti a consumo dai profili Economy e Premium
- La tabella RetailerProfilePack definisce il numero di pacchetti Massimo e Minimo previsti per il profilo. La visibilità del pacchetto per l'utente finale (e quindi la sua attivabilità) è gestita con il campo IsActivable.
- Nel caso la risposta abbia lo status code settato a 403 Forbidden si ottiene la risposta con Code=1 quando la richiesta non viene validata dai limiti previsti dalla tabella RetailerProfilePack, mentre Code=2 quando la validazione secondo i limiti della tabella retailerProfilePack è ok ma fallisce l'operazione lato ADM. Un caso in cui può essere ritornato Code=2 è quando s cerca di cancellare un pacchetto a consumo (crediti).
...
HTTP Status Code | When | Message |
---|---|---|
400 BadRequest | ExternalUserId empty. | Invalid ExternalUserId. |
ExternalUserId validation fails |
HTTP Method