Location:

Custom Attribute Fields

It supports adding user-defined attribute fields to terminals and tracks. The terminal supports up to 5 and the track point supports up to 10.

Custom terminal attribute fields

Service Introduction

You can add custom attributes of the terminal through this request.

Interface address

https://lbs.navinfo.com/open-api/geofence/v1/track/terminal/column/add

Request method

GET/POST
The post request parameters should be transmitted in x-www-form-urlencoded mode

Request parameters

See the following table for the description of custom terminal attribute fields:

Parameter Type Meaning Required Default Remarks

ak

string

Developer Key

Yes

service_id

int

The service ID returned when creating the service

Yes

column

string

The name of the user-defined field for the terminal, up to 5 user-defined fields.

Yes

Note: user defined fields with the same name cannot appear under the same service; Data needs to be uploaded according to the defined type. For example, if it is defined as int, only numbers will be uploaded
the name only supports Chinese, English large and small letters, English underline "" English horizontal line "-" and number, the maximum length of the name shall not exceed 128 characters, and "" start.

type

string

Categories of custom fields

Yes

value range
string
double
int

list

string

Whether to participate in retrieval

No

value range
n:Represents that this field cannot be retrieved;
y:Represents that this field can be retrieved.
Note: this field cannot be modified after confirmation; Up to 2 custom fields are allowed to support retrieval.

Response data

name Type Meaning Remarks

code

int

Return status

message

string

Back to status description

Service example

Parameter Value Type Meaning Required Remarks

ak

your ak

string

Developer Key

Yes

Click to apply

service_id

int

The service ID returned when creating the service

Yes

column

string

The name of the user-defined field for the terminal, up to 5 user-defined fields.

Yes

Note: user defined fields with the same name cannot appear under the same service;
Data needs to be uploaded according to the defined type. For example, if it is defined as int, only numbers will be uploaded. The name only supports Chinese, English large and small letters, English underscore "" English horizontal line "-" and number, the maximum length of the name shall not exceed 128 characters, and "" start。

type

string

The category of the custom field.

Yes

value range
string
double
int

list

string

Whether to participate in retrieval

No

value range
n:Represents that this field cannot be retrieved;
y:Represents that this field can be retrieved.
Note: this field cannot be modified after confirmation; Up to 2 custom fields are allowed to support retrieval.

Run


                        

Custom track attribute fields

Service Introduction

You can add custom attributes for tracks with this request.

Interface address

https://lbs.navinfo.com/open-api/geofence/v1/track/point/column/add

Request method

GET/POST
The post request parameters should be transmitted in x-www-form-urlencoded mode

Request parameters

See the following table for the description of custom track attribute fields:

Parameter Type Meaning Required Default Remarks

ak

string

Developer Key

Yes

service_id

int

The service ID returned when creating the service

Yes

column

string

The name of the user-defined field for the track point, up to 10 custom fields. Custom fields with the same name cannot appear under the same service.

Yes

Data needs to be uploaded according to the defined type. For example, if it is defined as int, only numbers will be uploaded.
The name only supports Chinese, English large and small letters, English underscore "" English horizontal line "-" and number, the maximum length of the name shall not exceed 128 characters, and "" start.

type

string

Categories of custom fields

Yes

value range
string
double
int

Response data

name Type Meaning Remarks

code

int

Return status

message

string

Back to status description

Service example

Parameter Value Type Meaning Required Remarks

ak

your ak

string

Developer Key

Yes

Click to apply

service_id

int

The service ID returned when creating the service

Yes

column

string

The name of the user-defined field for the terminal, up to 5 user-defined fields.

Yes

Note: user defined fields with the same name cannot appear under the same service;
Data needs to be uploaded according to the defined type. For example, if it is defined as int, only numbers will be uploaded. The name only supports Chinese, English large and small letters, English underscore "" English horizontal line "-" and number, the maximum length of the name shall not exceed 128 characters, and "" start.

type

string

The category of the custom field.

Yes

value range
string
double
int

Run


                        
TOP