Skip to content

Latest commit

 

History

History

external_api

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 

External API Documentation


Get languages supported by an entity

URL: entities/languages/v1/<entity_name>

Method: GET

Supported Query Params: None

Response:

{
    "result": {
        "supported_languages": [
            "en",
            "hi",
            "mr"
        ]
    },
    "success": true,
    "error": ""
}

Add language support for an entity

URL: entities/languages/v1/<entity_name>

Method: POST

Request Body

{
    "supported_languages": [
        "en",
        "hi",
        "mr"
    ]
}

Response:

{
    "result": true,
    "success": true,
    "error": ""
}

Get data associated with the specific entity

URL: entities/data/v1/<entity_name>

Method: GET

Supported Query Params:

  • value_search_term (str): Search term to filter entity values
  • variant_search_term (str): Search term to filter entiy variants
  • empty_variants_only (bool): Filter only values with empty variants
  • from (int): Filter results offset for pagination
  • size (int): Filter results size for pagination

Response:

{
    "result": {
        "records": [
            {
                "variants": {
                    "hi": {
                        "_id": "AWhgNBQdLvkU3x32pO7K",
                        "value": [
                            "दिल्ली"
                        ]
                    },
                    "en": {
                        "_id": "AWhgNBQdLvkU3x32pO7L",
                        "value": [
                            "Delhi"
                        ]
                    }
                },
                "word": "Delhi"
            },
            {
                "variants": {
                    "hi": {
                        "_id": "AWhgNBQdLvkU3x32pO7I",
                        "value": [
                            "इंडिया"
                        ]
                    },
                    "en": {
                        "_id": "AWhgNBQdLvkU3x32pO7J",
                        "value": [
                            "India"
                        ]
                    }
                },
                "word": "India"
            }
        ],
        "total": 2
    },
    "success": true,
    "error": ""
}

Add/Edit/Remove data associated with a specific entity

URL: entities/data/v1/<entity_name>

Method: POST

Request Body:

{
    "edited": [
        {
            "variants": {
                "en": {
                    "_id": "AWhfjhmwLvkU3x32pO67",
                    "value": [
                        "India"
                    ]
                },
                "hi": {
                    "_id": "AWhfjhmwLvkU3x32pO68",
                    "value": [
                        "इंडिया"
                    ]
                }
            },
            "word": "India"
        }
    ],
    "deleted": [
        {
            "variants": {
                "en": {
                    "_id": "AWhfjhmwLvkU3x32pO67",
                    "value": [
                        "Delhi"
                    ]
                },
                "hi": {
                    "_id": "AWhfjhmwLvkU3x32pO68",
                    "value": [
                        "दिल्ली"
                    ]
                }
            },
            "word": "Delhi"
        }
    ],
    "replace": true
}

Response:

{
    "result": true,
    "success": true,
    "error": ""
}