General Information
Service | API | Method | Data Model | Workflow |
---|---|---|---|---|
multitenant | /product/package/acl/env | PUT | N/A |
Description
This API updates the package under a product that both have codes that accordingly match the ones sent in the query.
Input
Type: application/json
Name | Source | Mandatory | Type | Special Format | Description |
---|---|---|---|---|---|
id | Query | YES | String | N/A | The product id |
code | Query | YES | String | The Length is 4 - 5 | The product code |
acl | Body | YES | Object | Part of ACL Schema | Package ACL - Check the example below |
env | Query | YES | String | N/A | Environment code |
type | Query | NO | String | granular | Type of Acl (API group or granular) |
ACL Example of type API Group
{ "acl": { "oauth": [{ "version": "1", "get": [ "Guest" ], "post": [ "Guest", "Tokenization" ], "delete": [ "Tokenization" ] }] } } |
ACL Example of type Granular
{ "acl": { "oauth": { "1": { "access": true, "apisPermission": "restricted", "post": { "apis": { "/token": { "group": "Guest", "access": false } } } } } } } |
Output
Response
SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response
Valid Response
{ result: true, data: 'product package %package_code% updated successfully' } |
Invalid Response
{ "result":false, "errors":{ "codes":[460], "details":[ { "code":460, "message":"Unable to find products" } ] } } |
Response schema
Follow this link to check out the response JSON Schema
SOAJS Error Codes
Code | Description |
---|---|
400 | Business logic required data are missing |
460 | Unable to find products |
461 | Unable to find package |
500 | This record is locked. You cannot modify or delete it |
602 | Model error: + %model_error% |
Add Comment