Entity Category

Get Entity Category list

Retrieves all entity category records for an organization from the database.

GET

API_URL/api/wallet/entity-category

HEADERS

client_id   9b16ae5638534ae1961fb370f874b6cc

client_secret   sk_9b16ae5638534ae1961fb370f874b6cc

content-type   application/json

Sample result

{
    "status": 200,
    "result": [
        {
            "id": 1,
            "organisation_id": 1,
            "name": "Johnathan 456",
            "parent_category_id": null,
            "is_active": 1,
            "created_at": "2024-03-01T03:38:53.000000Z",
            "updated_at": "2024-03-01T03:38:53.000000Z",
            "deleted_at": null
        }
    ]
}

Get Entity Category by ID

Retrieves a specific entity category record by its ID from the database.

GET

API_URL/api/wallet/entity-category/{id}

HEADERS

client_id   9b16ae5638534ae1961fb370f874b6cc

client_secret   sk_9b16ae5638534ae1961fb370f874b6cc

content-type   application/json

Sample result

{
    "status": 200,
    "result": {
        "id": 2,
        "organisation_id": 1,
        "name": "Johnathan 456",
        "parent_category_id": null,
        "is_active": 1,
        "created_at": "2024-03-01T03:38:55.000000Z",
        "updated_at": "2024-03-01T03:38:55.000000Z",
        "deleted_at": null
    }
}

Create Entity Category

Creates an entity category by organisation id and storing it in MasChain.

POST

API_URL/api/wallet/entity-category

HEADERS

client_id   9b16ae5638534ae1961fb370f874b6cc

client_secret   sk_9b16ae5638534ae1961fb370f874b6cc

content-type   application/json

BODY

Name	Type	Required
name	string	Yes
parent_category_id	int	Yes

Sample request

{
    "name":"Johnathan 456",
    "parent_category_id":"1"
}

Sample result

{
    "status": 200,
    "result": {
        "organisation_id": 1,
        "name": "Johnathan 456",
        "parent_category_id": null,
        "updated_at": "2024-03-01T03:38:55.000000Z",
        "created_at": "2024-03-01T03:38:55.000000Z",
        "id": 3
    }
}

Update Entity Category by ID

Update entity category by id and store to db.

PUT

API_URL/api/wallet/entity-category/{id}

HEADERS

client_id   9b16ae5638534ae1961fb370f874b6cc

client_secret   sk_9b16ae5638534ae1961fb370f874b6cc

content-type   application/json

BODY

Name	Type	Required
name	string	Yes
parent_category_id	int	Yes

Sample request

{
    "name":"Kien",
    "parent_category_id":"1"
}

Sample result

{
    "status": 200,
    "result": {
        "organisation_id": 1,
        "name": "Kien",
        "parent_category_id": null,
        "updated_at": "2024-03-01T03:38:55.000000Z",
        "created_at": "2024-03-01T03:38:55.000000Z",
        "id": 3
    }
}

Activate Entity Category by ID

Activate entity category by id.

PUT

API_URL/api/wallet/entity-category/{id}/activate

HEADERS

client_id   9b16ae5638534ae1961fb370f874b6cc*

client_secret   sk_9b16ae5638534ae1961fb370f874b6cc*

content-type   application/json

Sample result

{
    "status": 200,
    "result": {
        "id": 3,
        "organisation_id": 1,
        "name": "Kien",
        "parent_category_id": 1,
        "is_active": 1,
        "created_at": "2024-03-01T03:38:55.000000Z",
        "updated_at": "2024-03-01T03:39:18.000000Z",
        "deleted_at": null
    }
}

Deactivate Entity Category by ID

Deactivate entity category by id.

PUT

API_URL/api/wallet/entity-category/{id}/deactivate

HEADERS

client_id   9b16ae5638534ae1961fb370f874b6cc*

client_secret   sk_9b16ae5638534ae1961fb370f874b6cc*

content-type   application/json

Sample result

{
    "status": 200,
    "result": {
        "id": 3,
        "organisation_id": 1,
        "name": "Kien",
        "parent_category_id": 1,
        "is_active": 0,
        "created_at": "2024-03-01T03:38:55.000000Z",
        "updated_at": "2024-03-01T03:39:18.000000Z",
        "deleted_at": null
    }
}

Delete Entity Category by ID

Delete entity category by id.

DELETE

API_URL/api/wallet/entity-category/{id}

HEADERS

client_id   9b16ae5638534ae1961fb370f874b6cc*

client_secret   sk_9b16ae5638534ae1961fb370f874b6cc*

content-type   application/json

Sample result

{
    "status": 200,
    "result": "Success"
}