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

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

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 · enumOptionalPossible values:

Responses

201

The request was successful.

application/json

404

The user was not found in the database.

application/json

429

The user has exceeded the rate limit.

application/json

post

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: 122

{
  "groupCode": "GROUP_CODE",
  "code": "CODE",
  "name": "Name",
  "description": "Description",
  "value": "Value",
  "status": "0 - 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

Filter by status. This value includes the following options:

• Active
• Inactive

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

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

404

The user was not found in the database.

application/json

429

The user has exceeded the rate limit.

application/json

get

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

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

404

The user was not found in the database.

application/json

429

The user has exceeded the rate limit.

application/json

delete

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": []
}