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

« Previous Version 4 Current »

Function name

create-clients

Parameters

  • data (Required). It is an array of fields. The details of the fields are as follows :

name (Optional) String. Name of the client.
login (Optional). String. Login name of the user. If login is present, the user will be counted towards your license count.
password (Optional). String. Password of the user.
email (Optional). String. Email of the user. For users with login, email is mandatory.
privileges (Optional). Numeric. Values of 0, 1 or 2.  0 means view tasks, 1 means view updates, 2 means add updates.
template_client_id (Numeric). ID of the client whose preferences (Input/Display date format, dashboard, privileges) to be copied. 
custom_field_1 (Optional). The custom field attached to client. You need to use the Formula Key of the custom field. 

 

When your data format is XML, you should post something like this: 

<data>
    <item>
      <name>Jack Miller</name>
      <login>jackmiller</login>
      <password>castles123</password>
      <email>jack@celoxis.com</email>
      <template_client_id>232334</template_client_id>
      <client_ref_no>AIQ_87</client_ref_no>             <!-- Custom field attached to client> 
     </item>
    <item>
       <name>Mary Jane</name>
       <privileges>0,1</privileges>
    </item>
</data>

 

In case of JSON, you should submit an array of objects with the same properties.

[
  {
    "name":"Joe Cole",
    "login":"joe.cole",
    "password":"kaboom1",
    "email":"joe.cole@celoxis.com",
    "template_client_id":"232334",
    "client_ref_no":"AIQ_87"       <!-- Custom field attached to client> 
  }
  {
    "name":"Mary Jane",    
    ...
 }
]
  • No labels