Authorization

Add Headers in every request (Get, Post, Put, Delete) without header parameters API will not work.

Headers

Parameter Type Value Description
Content-Type string application/json Type should be json
api_key string FnjUxOE8aqK%I@?z This is App key

Base URL: http://imperium.dynalias.net:8013/skacommercialsweb/vms-api/










Add Visitor

Title Description
Url /v1e/add-visitor
Method

Mandatory Parameters Type Description
r_ic_passport String Resident Valid IC/Passport [Mandatory].
IC/Passport Lenght (Max = 20)
r_email String Resident Valid Email Address [Optional].
Email Should be in Format Contain @ Sign.
Email Length (Min = 10 to Max = 255)
r_unit_name String Resident Unit Name [Mandatory].
(Pattern: Block - Level - Number Example: A-33-07)
v_full_name String Visitor Full Name [Mandatory].
Full Name Pattern : Jhon Doe
Full Name Include Space between First and Last name
Full Name Length (Min = 8 to Max = 50)
v_ic_passport String Visitor Valid IC/Passport [Mandatory].
IC/Passport Lenght (Max = 20)
v_phone String Visitor Valid Phone Number [Optional].
Phone Number Must be In Numeric Format
Example1: +601725968063
Example2: 0172596806344
Length (Max = 15)
v_visit_start_date String Visitor Visit start Date Mentioned [Mandatory].
Date Format(Date, Time Stamp Example: 2021-11-25T13:19:04Z)
Length (Max = 250)
v_visit_end_date String Visitor Visit End Date Mentioned [Mandatory].
Date Format(Date, Time Stamp Example: 2021-11-25T13:19:04Z)
Length (Max = 250)
v_vehicle_number String Visitor Vehicle Number [Optional].
Default : Null
Length (Max = 50)
v_reason String Visitor Reason [Optional].
Length (Min = 10 to Max = 255)
Default: Null
v_email String Visitor Email[Optional].
Email Should be in Format Contain @ Sign.
Email Length (Min = 10 to Max = 255)

Status Code Description
Success 200 Visitor Added Successfully
Not Found 404 No HTTP resource was found that matches the request




Add Paramters in Json array

Json Array
{
    "api_key" : "FnjUxOE8aqK%I@?z",
    "r_ic_passport" : "123456789",
    "r_unit_name" : "A-3-23",
    "v_full_name" : "Mohsin",
    "v_ic_passport" : "1545790",
    "v_phone" : "+601299680",
    "v_visit_start_datetime": "2021-12-10T13:19:04Z",
    "v_visit_end_datetime": "2021-12-19T13:19:04Z",
    "v_vehicle_number" : "RIO-7741",
    "v_reason" : "No Reason",
    "v_email" : "alisaivi76@gmail.com"


    
}

Response

Status:200
{
    "status": "success",
    "errorCode": 0,
    "visit_id": 61,
    "v_email": "alisaivi76@gmail.com",
    "v_date_time": "10/12/2021 01:19 PM",
    "v_qr_code_image": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAFcAAABXAQMAAABLBksvAAAABlBMVEX///8AAABVwtN+AAAAsklEQVQ4jc3SsQ3DIBAF0LMo6OwFLLEGHSslExgvgFeiYw0kFnA6F5YvR+OkQJ/WJ4pXgPh8QfS0mZi9LcwZeCTlqXiCdiVYtR0dy/6u19QzqZXVnaFpyR/+3tJ0PWJ/VTQ9HXxZqQJ5kFR6fscMPFp1abM7gqZRn0vKwEMsXpvPQcA1XlRrysDSg5Q5MbL0GWql0K5sUVbHXs8vTdhBerj/UtNyrzuXSMA1fzK7zcDPmi/BMgJwO5SgigAAAABJRU5ErkJggg=="
}





Edit Visitor

Title Description
Url /v1e/edit-visits
Method

Mandatory Parameters Type Description
v_full_name String Visitor Name[Mandatory].
Full Name Pattern : Jhon Doe
Full Name Include Space between First and Last name
Full Name Length (Min = 8 to Max = 50)
v_phone String Visitor Valid Phone Number [Optional].
Phone Number Must be In Numeric Format
Example1: +601725968063
Example2: 0172596806344
Length (Max = 15)
v_ic_passport String Visitor Valid IC/Passport [Mandatory].
IC/Passport Lenght (Max = 20)
v_email String Visitor Email [Optional].
Email Should be in Format Contain @ Singl.
Email Length (Min = 10 to Max = 255)
v_visit_start_date String Visitor Visit start Date Mentioned [Mandatory].
Date Format(Date, Time Stamp Example: 2021-12-15T13:19:04Z)
Date Format (12 December, 2021 01:19 PM) also Acceptable
v_visit_end_date String Visitor Visit end Date Mentioned [Mandatory].
Date Format(Date, Time Stamp Example: 2021-12-15T13:19:04Z)
Date Format (12 December, 2021 01:19 PM) also Acceptable
visit_id String Visit Id [Mandatory]. Length (max = 11)
v_vehicle_number String Visitor Vehicle Number [Optional].
Default : Null
Length (Max = 50)
v_reason String Visitor Reason [Optional].
Length (Min = 10 to Max = 255)
Default: Null

Status Code Description
Success 200 Visitor Update Successfully
Not Found 404 No HTTP resource was found that matches the request




Add Paramters in Json array

Json Array
{
    "api_key" : "FnjUxOE8aqK%I@?z",
    "v_full_name": "Mohsin",
    "v_phone": "03170011200",
    "v_ic_passport": "546545790",
    "v_email": "alisaivi786@gmail.com",
    "v_visit_start_datetime": "2021-12-15T13:19:04Z",
    "v_visit_end_datetime": "2021-12-20T13:19:04Z",
    "v_car_number": "RIO-7741",
    "v_reason": "",
    "visit_id": "61"
}

Response

Status:200
{
    "status": "success",
    "errorCode": 0,
    "message": "Updated Successfully"
}





Get Single Visitor

Title Description
Url /v1e/get-single-visit
Method

Mandatory Parameters Type Description
visit_id String Visit Id [Mandatory].
Length (max = 11)

Status Code Description
Success 200 Visit Found Successfully
Not Found 404 No HTTP resource was found that matches the request




Add Paramters in Json array

Json Array
{
    "api_key" : "FnjUxOE8aqK%I@?z",
    "visit_id" : "46"    
}

Response

Status:200
	
{
    "status": "success",
    "errorCode": 0,
    "message": "Data Found",
    "data": {
        "visit_id": "46",
        "visitor_id": "14",
        "v_car_number": null,
        "v_pass_number": null,
        "v_reason": "No Reason",
        "v_visit_added_datetime": "2021-12-13 19:20:55",
        "v_visit_start_datetime": "10/12/2021, 13:19",
        "v_visit_end_datetime": "10/12/2021, 13:19",
        "v_visit_time": "2021-12-10T13:19:04Z",
        "v_visit_status": "-1",
        "v_full_name": "Mohsin",
        "v_phone": "03170011200",
        "v_ic_passport": "1546545790",
        "v_email": "alisaivi76@gmail.com",
        "v_date_added": "2021-12-13 18:58:26",
        "v_qr_code": "6802283101"
    }
}





Get Visitor info

Title Description
Url /v1e/get-visitors-info
Method

Mandatory Parameters Type Description
page_no Integer Page No [Optional].
page_no default (0)
r_ic_passport String Resident Valid IC/Passport [Optional].
IC/Passport Lenght (Max = 20)
r_email String Resident Valid Email Address [Optional].
Email Should be in Format Contain @ Singl.
Email Length (Min = 10 to Max = 255)
r_unit_name String Resident Unit Name [Optional].
(Pattern: Block - Level - Number Example: A-33-07)
visits_type String Visits Type [Optional].
Note: (visits_type = "today",visits_type = "upcoming",visits_type = "history",visits_type = "all")
Get Visits Details By Visit Types.
visits_type Must be in Lowercase order
Length (Max = 255)

Status Code Description
Success 200 Visit Found Successfully
Not Found 404 No HTTP resource was found that matches the request




Add Paramters in Json array

Json Array
{
    "api_key" : "FnjUxOE8aqK%I@?z",
    "r_ic_passport" : "123456789",
    "r_unit_name" : "A-3-23",
    "visits_type":"today"
}

Response

Status:200
{
    "status": "success",
    "errorCode": 0,
    "message": "Visitor Found.",
    "data": {
        "visit_id": "15",
        "Visitor_id": "8",
        "r_unit_name": "A-3-23",
        "v_full_name": "Mohsin Raza",
        "v_phone": "03170011200",
        "v_ic_passport": "5646545790",
        "v_email": "alisaivi76@gmail.com",
        "v_date_added": "2021-12-13 11:44:02",
        "v_qr_code": null,
        "v_visit_start_date": "10 December, 2021 01:19 PM",
        "v_visit_end_date": "10 December, 2021 01:19 PM"
    }
}





Search Visitor

Title Description
Url /v1e/search-visitors
Method

Mandatory Parameters Type Description
page_no String Page No [Mandatory].
page_no Default (0)
r_ic_passport String Resident Valid IC/Passport [Optional].
IC/Passport Lenght (Max = 20)
r_unit_name String Resident Unit Name [Optional].
(Pattern: Block - Level - Number Example: A-33-07)
v_term String v_term [Optional].
Note: (v_term May be Name of Visitor also term may be Passport Number)
Search Visitor by Term
Length (Max = 250)

Status Code Description
Success 200 Visit Found Successfully
Not Found 404 No HTTP resource was found that matches the request




Add Paramters in Json array

Json Array
{
    "api_key" : "FnjUxOE8aqK%I@?z",
    "page_no" : 0,
    "r_ic_passport" : "123456789",
    "r_unit_name" : "A-3-23",
    "v_term" : "546545790"

}

Response

Status:200
{
    "status": "success",
    "errorCode": 0,
    "message": "Visitor Found.",
    "data": [
        {
            "visit_id": "22",
            "v_full_name": "Mohsin",
            "v_phone": "03170011200",
            "v_email": "alisaivi786@gmail.com",
            "v_ic_passport": "546545790",
            "visit_status": "-1"
        },
        {
            "visit_id": "23",
            "v_full_name": "Mohsin",
            "v_phone": "03170011200",
            "v_email": "alisaivi786@gmail.com",
            "v_ic_passport": "546545790",
            "visit_status": "-1"
        },
        {
            "visit_id": "24",
            "v_full_name": "Mohsin",
            "v_phone": "03170011200",
            "v_email": "alisaivi786@gmail.com",
            "v_ic_passport": "546545790",
            "visit_status": "-1"
        },
        {
            "visit_id": "29",
            "v_full_name": "Mohsin",
            "v_phone": "03170011200",
            "v_email": "alisaivi786@gmail.com",
            "v_ic_passport": "546545790",
            "visit_status": "-1"
        },
        {
            "visit_id": "30",
            "v_full_name": "Mohsin",
            "v_phone": "03170011200",
            "v_email": "alisaivi786@gmail.com",
            "v_ic_passport": "546545790",
            "visit_status": "-1"
        }
    ]
}





Cancel Visitor

Title Description
Url /v1e/cancel-visit
Method

Mandatory Parameters Type Description
visit_id String Visit Id [Mandatory]. Length (max = 11)

Status Code Description
Success 200 Visit Cancel Successfully
Not Found 404 No HTTP resource was found that matches the request




Add Paramters in Json array

Json Array
{
    "api_key" : "FnjUxOE8aqK%I@?z",
    "visit_id": "30"
}

Response

Status:200
	
{
    "status": "success",
    "errorCode": 0,
    "message": "Visit has been Canceled."
}