Api/Customers/getFields asks for field configuration set up in your organisation. It can be used for save command.
Requirements
API user needs customers module to access to this command.
Syntax
Api/Customers/getFields
This command does not need any parameters, except API key.
Response
Inside fields element, there is list of field elements, what contain following elements:
- id: unique number of field
- type: what system type this field has. For possible values, see subtopic below.
- name: human-readable name
Those fields are defined under settings - customers dialog.
System types
Default, all fields have text
type, but all possible values are:
text, number, id, name, combo, date, html, address-1..address-7, latitude, longitude, m_style, phone, link, email, personid, visitCount, visitGroup, visitDrive
externalId
instead.name
instead.YYYY-mm-dd
rawaddress
, though.
Field types determine, what values can insert to each columns via save command.
Example
Here is how one example query may look like:
XML:
query: https://app.ecofleet.com/seeme/Api/Customers/getFields?key=apidemo-NJ8V7PENgkau5FYH
<?xml version="1.0" encoding="utf-8" ?>
<nodes>
<status>0</status>
<meta></meta>
<response>
<fields>
<field>
<id>35467</id>
<type>id</type>
<name>id</name>
</field>
<field>
<id>33096</id>
<type>name</type>
<name>name</name>
</field>
<field>
<id>33097</id>
<type>address-1</type>
<name>address</name>
</field>
<field>
<id>33098</id>
<type>phone</type>
<name>phone</name>
</field>
<field>
<id>33099</id>
<type>link</type>
<name>website</name>
</field>
</fields>
</response>
</nodes>
JSON:
Query: https://app.ecofleet.com/seeme/Api/Customers/getFields?key=apidemo-NJ8V7PENgkau5FYH&json
{
"status":0,
"meta":{},
"response":{
"fields":{
"___xmlNodeValues":[{
"___xmlNodeName":"field",
"field":{
"id":35467,
"type":"id",
"name":"id"
}
},{
"___xmlNodeName":"field",
"field":{
"id":33096,
"type":"name",
"name":"name"
}
},{
"___xmlNodeName":"field",
"field":{
"id":33097,
"type":"address-1",
"name":"address"
}
},{
"___xmlNodeName":"field",
"field":{
"id":33098,
"type":"phone",
"name":"phone"
}
},{
"___xmlNodeName":"field",
"field":{
"id":33099,
"type":"link",
"name":"website"
}
}]
}
}
}