Entity actions¶

Contains entity object description and API calls to interact with it.
Entity describes a class of objects for which representation and editable fields can be customized. For example, you can add your own custom fields to places entity or rearrange existing fields.

API path: /entity.

Entity object¶

{
    "id": 123,
    "type": "place",
    "settings": {
        "layout": {
                "sections": [{
                    "label": "Section label",
                    "field_order": [
                      "label",
                      "location",
                      "131212",
                      "tags",
                      "description"
                    ]
                }]
        }
    }
}

id - int. Entity identifier. type - enum. Currently, only "place" is supported. layout - object describes layout of fields for entity. sections - array of objects. Each section can contain one or more fields. At least one section must exist in a layout. label - string. Name of section. field_order - string array. Built-in fields and ids of custom fields (as strings).

entity types:

place - a place object, the same as is available through place API.

Builtin fields:

• label.
• location.
• tags.
• description.

list¶

Get list of entities which are available for customization.

parameters¶

Only session hash.

examples¶

curl -X POST 'https://api.navixy.com/v2/entity/list' \
    -H 'Content-Type: application/json' \ 
    -d '{"hash": "22eac1c27af4be7b9d04da2ce1af111b"}'

https://api.navixy.com/v2/entity/list?hash=a6aa75587e5c59c32d347da438505fc3

response¶

{
    "success": true,
    "list": [{
      "id": 123,
      "type": "place",
      "settings": {
          "layout": {
                  "sections": [{
                      "label": "Section label",
                      "field_order": [
                        "label",
                        "location",
                        "131212",
                        "tags",
                        "description"
                      ]
                  }]
          }
      }
    }]
}

errors¶

• General types only.

read¶

Gets entity by the id or by type.

parameters¶

Exactly one of these parameters must be specified. They can't be both null or both non-null.

examples¶

curl -X POST 'https://api.navixy.com/v2/entity/read' \
    -H 'Content-Type: application/json' \ 
    -d '{"hash": "22eac1c27af4be7b9d04da2ce1af111b", "id": "131312"}'

https://api.navixy.com/v2/entity/read?hash=a6aa75587e5c59c32d347da438505fc3&id=131312

response¶

{
    "success": true,
    "entity": {
        "id": 123,
        "type": "place",
        "settings": {
            "layout": {
                    "sections": [{
                        "label": "Section label",
                        "field_order": [
                          "label",
                          "location",
                          "131212",
                          "tags",
                          "description"
                        ]
                    }]
            }
        }
    }, 
    "fields": [{
       "id": 131312,
       "label": "Additional info", 
       "type":  "text",
       "required": true,
       "description": "Info about place"
    }]
}

• fields - array of objects. Fields associated with this entity. Described in field object.

errors¶

• 201 - Not found in the database – if there is no entity with such ID.

update(entity)¶

Updates settings of customizable entity. Entity must have a valid id.

required sub-user rights: places_custom_fields_update for entities with type place.

WARNING: entity.settings.layout.sections must contain ids of all builtin and custom fields which are associated with this entity. No fields can be omitted from layout, only reordering allowed. Fields cannot be duplicated, even in different sections.

parameters¶

example¶

curl -X POST 'https://api.navixy.com/v2/entity/update' \
    -H 'Content-Type: application/json' \ 
    -d '{"hash": "22eac1c27af4be7b9d04da2ce1af111b", "entity": {"id": 123, "type": "place", "settings": {"layout": {"sections": [{"label": "Section label", "field_order": ["label", "location", "131212", "tags", "description"]}]}}}'

response¶

{
    "success": true
}

errors¶

• 201 - Not found in the database – if there is no entity with such ID.
• 7 - Invalid parameters - if entity object violates restrictions described above.