Configurations

The user's configuration that stores the user's settings for the application. We can use this configuration to store the user's preferences, settings, and other data.

Creates a new configuration for the user.

post

Path parameters

userIdstringRequired

The id of the user.

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Body

application/jsontext/jsonapplication/*+json

Configuration model.

groupCodestring · min: 1Required

This represents the group code.

Example: GROUP_CODE

codestring · min: 1Required

This represents the code.

Example: CODE

namestring · min: 1Required

This represents the name.

Example: Name

descriptionstring · nullableOptional

This represents the description.

Example: Description

valuestring · min: 1Required

This represents the value.

Example: Value

statusstring · enumOptional

This enum is used to define the common status of an object in JFW.

Supported values:

• Inactive - In case of JFW object's status being inactive.
• Active - In case of JFW object's status being active

Possible values:

Responses

201

The request was successful.

application/json

404

The user was not found in the system.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

post

/api/v1/users/{userId}/configurations

HTTPcURLJavaScriptPython

POST /api/v1/users/{userId}/configurations HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 118

{
  "groupCode": "GROUP_CODE",
  "code": "CODE",
  "name": "Name",
  "description": "Description",
  "value": "Value",
  "status": "Inactive"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "id": "sApKpllz4sAplsmzha",
    "groupCode": "GROUP_CODE",
    "code": "CODE",
    "name": "Name",
    "value": "Value",
    "description": "Description",
    "status": "Active",
    "isSystem": false
  },
  "errors": []
}

Gets the user's configurations.

get

Path parameters

userIdstringRequired

The id of the user.

Query parameters

GroupCodestringOptional

Filter by group code.

CodestringOptional

Filter by code.

NamestringOptional

Filter by name.

DescriptionstringOptional

Filter by description.

ValuestringOptional

Filter by value.

Statusstring · enumOptional

This enum is used to define the common status of an object in JFW.

Supported values:

• Inactive - In case of JFW object's status being inactive.
• Active - In case of JFW object's status being active

Possible values:

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

The API result model with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Required

This is the message to be displayed to the user.

404

The user was not found in the system.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

get

/api/v1/users/{userId}/configurations

HTTPcURLJavaScriptPython

GET /api/v1/users/{userId}/configurations HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": [
    {
      "id": "sApKpllz4sAplsmzha",
      "groupCode": "GROUP_CODE",
      "code": "CODE",
      "name": "Name",
      "value": "Value",
      "description": "Description",
      "status": "Active",
      "isSystem": false
    }
  ],
  "errors": []
}

Deletes the user's configuration by ID.

delete

Path parameters

userIdstringRequired

The id of the user.

configurationIdstringRequired

The id of the configuration.

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

The API result model with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Required

This is the message to be displayed to the user.

databooleanOptional

404

The user was not found in the system.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

delete

/api/v1/users/{userId}/configurations/{configurationId}

HTTPcURLJavaScriptPython

DELETE /api/v1/users/{userId}/configurations/{configurationId} HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": true,
  "errors": []
}