...
...
General Information
...
| Service | API | Method | Data Model | Workflow | Group |
|---|---|---|---|---|---|
| multitenant | /product/package | PUT |
Data Model:
...
| Products | N/A | Product |
Description
Update product package
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 |
| name | Body | YES | String | N/A | The product name |
| description | Body | NO | String | N/A | The product description |
| _TTL | Body | YESNO | String | '6', '12', '24', '48', '72', '96', '120', '144', '168' | |
| tags | Body | NO | Array | Array of strings | |
| acl | Body | NO | Object | Product |
Output
Valid Response
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
} |
...
| Package ACL - Check the example below | |||||
| type | Body | NO | Object | Keys are environment codes and value is granular | Environment ACL TYPE |
ACL Example
| Code Block | |||
|---|---|---|---|
|
...
| |||||
"acl": { " |
...
dashboard": |
...
{ " |
...
oauth": [ { " |
...
version": |
...
"1", " |
...
get": [ "Guest" |
...
], "post": [ " |
...
Guest" |
...
, "Tokenization" ], " |
...
delete": |
...
[ "Tokenization" ] |
...
} |
...
] } } |
...
Type Example
...
| Code Block |
|---|
...
Example (CURL)
Request
| Code Block | ||||
|---|---|---|---|---|
| ||||
|
...
461...
Unable to find package
...
437...
Unable to get the environment records
...
460...
467...
Package already exists
...
473...
Missing required fields
...
476...
Unable to update product record
...
500...
This record is locked. You cannot modify or delete it
| |||||||
{
"dashboard": "granular"
} |
Output
...
Response
SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response
Valid Response
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
result: true,
data: 'product package %package_code% updated successfully'
} |
Invalid Response
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"coderesult": "UPDATE"false,
"nameerrors":{
"Some Update", "descriptioncodes": "package updated description",
"_TTL": "12",
"acl": {}
} |
Response
| Code Block | ||||
|---|---|---|---|---|
| ||||
{[460], "details":[ { "resultcode": true,460, "datamessage":"Unable [to find products" { } ] } ] }} } |
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% |