*getPersonFields

Configuration Article | CA-20220907-TP-57

VDG Sense | API | Functions | Persons

1 Request
2 Response
3 Changelog

Note: This function requires an API license.

Returns a list of all available persons fields.

Request

command=getPersonFields

Response

<result errorcode="0">
  <personfields>
    <field>firstname</field>
    <field>lastname</field>
    <field>address</field>
    <field>postalcode</field>
    <field>city</field>
    <field>phone</field>
    <field>fax</field>
    <field>mobile</field>
    <field>licenseplate</field>
    <field>lastnameprefix</field>
    <field>notes</field>
    <field>reference</field>
    <field>expirationdate</field>
    <field>enableexpirationdate</field>
  </personfields>
</result>

node	value	remarks

node	value	remarks
/result
@errorcode	[number]	See error codes below
/result/personfields
field	[string]	name of the field in the database

error code	description	remarks

error code	description	remarks
0	Ok	Ok, no error
-18	General error	An undefined error occured

Changelog

2.6.1 – added