Add Visitor


JSON data ADD VISITOR

POST URL
https://api.nuveq.cloud/api/

BODY JSON
Name TYPE DESCRIPTION REQUIRED

port

STRING

1402

api_id

NUMBER (INT)

can retrive data on Nuveq Portal user setting

email

STRING

User Email

name

STRING

Visitor Full Name

phone

STRING

Visitor Phone Number

id_passport_number

STRING

Passport or Malaysian identity card Number

car_number

STRING

Vehicle Number

photo

STRING

Visitor Photo

Optional

invited_by

NUMBER (INT)

User Id who to visit or invite by

Optional

approved_by

NUMBER (INT)

User Id for approval

Optional

approved

NUMBER (INT)

0 - false | 1 - true

reason_for_visit

STRING

Reason visitor visit your site

Optional

visit_start_at

DATE TIME

Date for start visit ( 2022-12-22 08:30:00 )

visit_end_at

DATE TIME

Date for start visit ( 2022-12-22 08:30:00 )

enable_card

NUMBER (INT)

0 = false | 1 = true

Optional

card_number

NUMBER (INT)

Number of the card access

Optional (if the Card is Enabled this field is required)

enable_bluetooth

NUMBER (INT)

0 = false | 1 = true

Optional

enable_link

NUMBER (INT)

0 - false | 1 - true

Optional

enable_qr

NUMBER (INT)

0 - false | 1 - true

Optional

entry_schedule

NUMBER (INT)

can retrive data on API SCHEDULES - Get Schedules

exit_schedule

NUMBER (INT)

can retrive data on API SCHEDULES - Get Schedules

lift_group

NUMBER (INT)

can retrive data on API LIFT GROUP - Get Lift Group

visitor_type_id

NUMBER (INT)

Visitor Type id

Optional

site_id

NUMBER (INT)

can retrive data on API SITES - Get Sites

enable

NUMBER (INT)

0 - false | 1 - true

limit_use

NUMBER (INT)

0 - false | 1 - true

use_number

NUMBER (INT)

Number can be use how many times ( 0 - 8 ) Max 8

doors

NUMBER (INT)

can retrive data on API CONTROLLER - Get Controller ( can be more than one door ) "door":[{"door_id":1},{"door_id":2}]

token_key

NUMBER (INT)

can retrive data on Nuveq Portal user setting

BODY JSON STRING
{"port":STRING,"api_id":NUMBER,"email":STRING, "name":STRING, "phone":STRING, "id_passport_number":STRING, "car_number":STRING, "photo":STRING, "invited_by":NUMBER, "approved_by":NUMBER, "approved":NUMBER, "reason_for_visit":STRING, "visit_start_at":STRING DATE TIME, "visit_end_at":STRING DATE TIME, "enable_card":NUMBER, "card_number":NUMBER, "enable_bluetooth":NUMBER, "enable_link":NUMBER, "enable_qr":NUMBER, "entry_schedule":NUMBER, "exit_schedule":NUMBER, "lift_group":NUMBER, "visitor_type_id":NUMBER, "site_id":NUMBER, "enable":NUMBER, "limit_use":NUMBER, "use_number":NUMBER, "doors": [{"door_id":NUMBER}, {"door_id":NUMBER},{ "door_id":NUMBER}], "token_key":"__API_KEY__"}
JSON Return Data
data {
visitor_id: " ",
}

ERROR RETURN
ERROR STRING FIELD API DESCRIPTION

Invalid Email Address.

email

Email Address is invalid

Email Address is Required.

email

Email Address is empty

Visitor Name is Required.

name

Visitor Name is empty.

Visitor Phone is Required.

phone

Phone is empty.

Visitor Identify or Passport is Required.

id_passport_number

Passport or Identify Id is empty

Visitor Start Date is Required.

visit_start_at

Visitor Start Date is empty.

Visitor End Date is Required.

visit_end_at

Visitor End Dtae is empty.

Card Number Required.

card_number

Card Number is empty (if the Card Enable is True)

Entry Schedule is empty.

entry_schedule

Entry Schedule is empty

Exit Schedule is empty.

exit_schedule

Exit Schedule is empty.

Lift Group is empty

lift_group

Lift Group is empty

Number of uses is empty

use_number

Number of uses is empty

Fail to get Door

door_id

Door id is invalid

Card Number is empty.

card_enabled and card_no

Card is enabled but Card Number is empty

Invalid Email Address.

bluetooth_enabled and email

Bluetooth is enabled but User Email is invalid email address

Bluethooth Credential is Enable but there is no email value.

bluetooth_enabled and email

Bluetooth is enabled but User Email is empty

fail to Add User

Add User API

Either Server down or maintanance, check with administrator.