Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Note: This function requires an API license.

adds a person to the database. If an expiration date is given, the date will be checked and an error is returned if the date is not compatible.

Request

command=addPerson&firstname=[string]&lastname=[string]&address=[string]&postalcode=[string]&city=[string]&phone=[string]&fax=[string]&mobile=[string]&licenseplate=[string]&lastnameprefix=[string]&reference=[string]&notes=[string]&expirationdate=[string]&enabledexpirationdate=[boolean]

Response

<result errorcode="0">
  <person>
    <id>[uid]</id>
    <firstname>[string]</firstname>
    <lastname>[string]</lastname>
    <address>[string]</address>
    <postalcode>[string]</postalcode>
    <city>[string]</city>
    <phone>[string]</phone>
    <fax>[string]</fax>
    <mobile>[string]</mobile>
    <licenseplate>[string]</licenseplate>
    <lastnameprefix>[string]</lastnameprefix>
    <reference>[string]</reference>
    <notes>[string]</notes>
    <expirationdate>[string]</expirationdate>
    <enabledexpirationdate>[boolean]</enabledexpirationdate>
  </person>
</result>

node

value

remarks

/result

@errorcode

[number]

See error codes below

/result/person

id

[UID]

unique person id

firstname

[string]

firstname of the person

lastname 

[string]

lastname of the person

address

[string]

address of the person

postalcode

[string]

postal code of the person

city

[string]

city of the person

phone 

[string]

phone number of the person

fax 

[string]

fax number of the person

mobile

[string]

mobile number of the person

licenseplate

[string]

license plate of the person

notes

[string]

notes added to the person

expirationdate

[string]

 the date the person will be removed from the database

enabledexpirationdate

[boolean]

flag to indicate the person can be expired

error code

description

remarks

0

Ok

Ok, no error

-4

Invalid Timestamp 

 Invalid datetime format. See Timestamp.

 

Changelog

  • 2.6.1 – added

  • No labels