Get features

Get features

get

Query parameters

PackageIdstringOptional

Filter by the package id.

EventIdstringOptional

Filter by the event id.

Typestring · enumOptional

Provides the feature types. See link: https://docs.jframework.io/lap-trinh/thiet-ke-database/phan-loai-theo-logic/logic-tables/package-and-feature-and-price/1-feature/hang-so

Possible values:

CodestringOptional

Filter by the code.

NamestringOptional

Filter by the name.

DescriptionstringOptional

Filter by the description.

TagsstringOptional

Filter by the tags.

NotesstringOptional

Filter by the notes.

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:

KeywordsstringOptional

Filter by the keywords.

SortDataFieldstringOptional

The sort data field to sort. By default, the value is ID.

SortOrderstring · enumOptional

Specifies the sorting order type for a collection.

Possible values:

PageNumberinteger · int32Optional

The page number of the pagination. Default value is 0.

PageSizeinteger · int32Optional

The page size of the pagination. Default value is 200.

Header parameters

Brand-URLstringRequired

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

Example: YOUR_BRAND_URL

Responses

200

The request was successful.

application/json

This provides interfaces for API responses 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: 1Read-onlyRequired

This is the message to be displayed to the user.

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

get

/api/v1/features

HTTPcURLJavaScriptPython

GET /api/v1/features HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "items": [
      {
        "id": "sApKpllz4sAplsmzha",
        "parentBrandId": "ParentBrandId",
        "eventId": "TrackingEventId",
        "code": "Code",
        "name": "Name",
        "unit": null,
        "defaultValue": null,
        "helpURL": null,
        "image": "https://www.example.com/image.jpg",
        "styles": "{\"color\": \"red\"}",
        "description": "Description",
        "tags": "Tag1, Tag2",
        "zOrder": 1,
        "status": "Active"
      }
    ],
    "totalItems": 1,
    "pageNumber": null,
    "pageSize": null
  },
  "errors": []
}