Section B - Add user API
B1 - Cloud Based Account
To add an user send a post request to /api/v1/add_user with the following data :
| Key | Mandatory | Value |
|---|---|---|
User Gruop ID |
Yes | Numeric |
Account ID |
Yes | String |
User Name |
Yes | String |
Password |
No | String |
User State |
No | {active, blacklisted, suspended} |
Activation Date |
No | {custom, now} |
Expiration Date |
No | {custom, never} |
Custom Activation Date |
No | dd-mm-yyyy H:m ,(will be used only when 'activationDate' is set as 'custom') |
Custom Expiration Date |
No | dd-mm-yyyy H:m, (will be used only when 'expirationDate' is set as 'custom') |
Phone Numner |
No | Numeric |
Email ID |
No | String |
B2 - ISP based Account
To add an user send a post request to /api/v1/add_user with the following data :
| Key | Mandatory | Value |
|---|---|---|
User Gruop ID |
Yes | Numeric |
Account ID |
Yes | String |
User Name |
Yes | String |
Password |
No | String |
User State |
No | {active, blacklisted, suspended} |
Activation Date |
No | {custom, now} |
Expiration Date |
No | {custom, never} |
Custom Activation Date |
No | dd-mm-yyyy H:m ,(will be used only when 'activationDate' is set as 'custom') |
Custom Expiration Date |
No | dd-mm-yyyy H:m, (will be used only when 'expirationDate' is set as 'custom') |
Phone Numner |
No | Numeric |
Email ID |
No | String |
First Name |
No | string |
Last Name |
No | String |
AltPhoneNumber |
No | Numeric |
altEmailId |
No | String |
address_line1 |
No | String |
address_line2 |
No | String |
address_city |
No | String |
address_pin |
No | Numeric |
address_state |
No | String |
address_country |
No | This should be two letter country ISO CODE |
address |
No | String |
installation_address_line1 |
No | String |
installation_address_line2 |
No | String |
installation_address_city |
No | String |
installation_address_pin |
No | Numeric |
installation_address_state |
No | String |
installation_address_country |
No | This should be two letter country ISO CODE. |
overridePriceEnable |
No | {on,off} |
overrideAmount |
No | Numeric |
overrideAmountBasedOn |
No | {withTax,withOutTax} |
location_details_not_import |
No | Value should be ''yes'' if area need to be added |
collection_area_import |
No | (Id of the area) |
collection_street_import |
No | (Id of the street) |
collection_block_import |
No | (Id of the bulding) |
caf_num |
No | Customer Acquisition Form Number |