Back to top

Intercorp BAS API

Overview

        Intercorp BAS API are built on Restful Interface in the aim to provide data exchange between other system vendors to enhance system functionality and features. The API allow data exchange in the format of JSON string.

Authorization

         To access API, you have to be authorized vendor and each vendor will be provided an id and secret code to access specific company project data. The vendor id and secret code will determine the access level for data exchange. Vendor have to call authorization method to get access token. Intercorp system will provide access token and refresh token as below:

Access Token

Authorization
POST/GetAuthorize

Schema
HideShow

Request Header

Authorization  : type : BASIC <space> string

Request Body

Content-Type:  application/x-www-form-urlencoded
username   : type :string
password   : type :string
grant_type : type :string
Request Header Parameters
HideShow
Authorization
string (required) Example: BASIC VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Unique code for each vendor

Request Body Parameters
HideShow
username
string (required) Example: Urovo

Unique code for each vendor

password
string (required) Example: EEF47D9A-DBA9-4D02-B7B0-04F4279A6D20

Vendor secret code

grant_type
string (required) Example: password

password

Response 200
Content-Type: application/json
[
    {
                        
        "access_token"              :type: string,
        "token_type"                :type: string,
        "expires_in"                :type: Integer,
        "refresh_token"             :type: string,
        "refresh_token_expires_in"  :type: string,
        "client_id"                 :type: string,
        ".issued"                   :type: datetime,
        ".expires"                  :type: datetime
    
    }
]
Example
HideShow
Request Header
Authorization: BASIC VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/x-www-form-urlencoded
Username  : Urovo
Password  : EEF47D9A-DBA9-4D02-B7B0-04F4279A6D20
grant_type: password
Response
Content-Type: application/json
[
    {
        "access_token"             : "soCdCK95l7MrUXo0hpd9jojr9lXdlUFIvsyNttZ1yIBGu75erFbYkCbA9_R6meAfI1K_bUnFpliDghNra2gNfkC6M0VNrZTyQ-R9ph-WzJYFCuRaE_27EkowoHWbzC4vLQ7DYQcyd_KkW9TDSNEC14PYoDIgjIgVoUzVEZ6Nzn1qe2ofetfloXGV9D-otsYQj_UWlTx7aBPnhIYN5jVTitvTPwuJaAVW8Uzyz7dVMubiec0QwWP50f2saLe3zk7u_0Z8-agskFFpkWyjvde1CWbDG1oXLDAayunZdy9P3p2ZTNQW6mqNFg3cZID1BniIxIeRna0aKjHlBGVizHv1eCdLDynC3zzlJNWh6CIIGp54M3EdHNBr54l2wWiPJQzURF9Ez7E-AiJDCDfMrutPTAxIB8TWQKglPliqFjswlzw",
        "token_type"               : "bearer",
        "expires_in"               : 599,
        "refresh_token"            : "6957779f9c634a8e8d2adfb248feac94",
        "refresh_token_expires_in" : "1200",
        "client_id"                : "Urovo",
        ".issued"                  : "Thu, 05 Nov 2020 07:41:23 GMT",
        ".expires"                 : "Thu, 05 Nov 2020 07:51:23 GMT"
    }
]

Access token using Refresh Token

Authorization
POST/GetAuthorize

Schema
HideShow

Request Header

Authorization  : type : BASIC <space> string

Request Body

Content-Type:  application/x-www-form-urlencoded
refresh_token  : type :string
grant_type     : type :string
Request Header Parameters
HideShow
Authorization
string (required) Example: BASIC VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body Parameters
HideShow
refresh_token
string (required) Example: 39e410610843456382469bd361e90d57

Refresh Token

grant_type
string (required) Example: refresh_token

refresh_token

Response 200
Content-Type: application/json
[
    {
        "access_token"              :type: string,
        "token_type"                :type: string,
        "expires_in"                :type: Integer,
        "refresh_token"             :type: string,
        "refresh_token_expires_in"  :type: string,
        "client_id"                 :type: string,
        ".issued"                   :type: datetime,
        ".expires"                  :type: datetime
    }
]
Example
HideShow
Request Header
Authorization: BASIC VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/x-www-form-urlencoded
refresh_token   : 6957779f9c634a8e8d2adfb248feac94
grant_type      : refresh_token
Response
Content-Type: application/json
[
    {
        "access_token"             : "soCdCK95l7MrUXo0hpd9jojr9lXdlUFIvsyNttZ1yIBGu75erFbYkCbA9_R6meAfI1K_bUnFpliDghNra2gNfkC6M0VNrZTyQ-R9ph-WzJYFCuRaE_27EkowoHWbzC4vLQ7DYQcyd_KkW9TDSNEC14PYoDIgjIgVoUzVEZ6Nzn1qe2ofetfloXGV9D-otsYQj_UWlTx7aBPnhIYN5jVTitvTPwuJaAVW8Uzyz7dVMubiec0QwWP50f2saLe3zk7u_0Z8-agskFFpkWyjvde1CWbDG1oXLDAayunZdy9P3p2ZTNQW6mqNFg3cZID1BniIxIeRna0aKjHlBGVizHv1eCdLDynC3zzlJNWh6CIIGp54M3EdHNBr54l2wWiPJQzURF9Ez7E-AiJDCDfMrutPTAxIB8TWQKglPliqFjswlzw",
        "token_type"               : "bearer",
        "expires_in"               : 599,
        "refresh_token"            : "6957779f9c634a8e8d2adfb248feac94",
        "refresh_token_expires_in" : "1200",
        "client_id"                : "Urovo",
        ".issued"                  : "Thu, 05 Nov 2020 07:41:23 GMT",
        ".expires"                 : "Thu, 05 Nov 2020 07:51:23 GMT"
    }
]

Country

    You can able to fetch Counrty.

Search Country

Country
GET/SearchCountry

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "start_index"    : type :integer,
                                "max_count"      : type :integer,
                                "client_code"    : type :string,
                                "Country_ID"     : type :integer,
                                "Country_Name"   : type :string
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
start_index
integer (required) Example: 1

Record Start index from the list

max_count
integer (required) Example: 20

Maximum Record to retrieve

client_code
string (required) Example: ICS

Client Code

Country_ID
Integer (Optional) Example: 50

Unique ID of Country

Country_Name
string (required) Example: Guatemala

Indicate Country

Response 200
Content-Type: application/json
[
    {
        "Country_ID"     :type: Integer,
        "Country_Name"   :type: string
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "start_index"   : 1,
    "max_count"     : 50,
    "client_code"   : "ICS"
}
Response 200
Content-Type: application/json
[
    {
        "Country_ID"     : 50,
        "Country_Name"   : "Guatemala"
    }
]

TimeZone

    You can able to fetch TimeZone.

Search TimeZone

TimeZone
GET/SearchTimeZone

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "start_index"  : type :integer,
                                "max_count"    : type :integer,
                                "client_code"  : type :string,
                                "TimeZone_ID"  : type :integer,
                                "Location"     : type :string,
                                "GMT"          : type :string,
                                "GMTOffset"    : type :decimal,
                                "TimeOffset"   : type :string
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
start_index
integer (required) Example: 1

Record Start index from the list

max_count
integer (required) Example: 20

Maximum Record to retrieve

client_code
string (required) Example: ICS

Client Code

TimeZone_ID
Integer (Optional) Example: 17

Unique ID of TimeZone

Location
string (Optional) Example: Atlantic Time (Canada)

Indicate TimeZone

GMT
string (Optional) Example: (GMT-04:00)

GMTOffset
Integer (Optional) Example: -4.00

TimeOffset
string (Optional) Example: 4:00

Response 200
Content-Type: application/json
[
    {
        "TimeZone_ID"   :type: Integer,
        "Location"      :type: string,
        "GMT"           :type: string,
        "GMTOffset"     :type: decimal,
        "TimeOffset"    :type: string
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "start_index"   : 1,
    "max_count"     : 50,
    "client_code"   : "ICS"
}
Response 200
Content-Type: application/json
[
  {
    "TimeZone_ID"   : 17,
    "Location"      : "Atlantic Time (Canada)",
    "GMT"           : "(GMT-04:00)",
    "GMTOffset"     : -4.00,
    "TimeOffset"    : "4:00"
  }
]

ReaderType

    You can able to fetch ReaderType.

ReaderType

SearchReaderType
GET/SearchReaderType

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "start_index"    : type :integer,
                                "max_count"      : type :integer,
                                "client_code"    : type :string,
                                "ReaderType_ID"  : type :integer,
                                "ReaderType_Name": type :string,
                                "Active"         : type :string
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
start_index
integer (required) Example: 1

Record Start index from the list

max_count
integer (required) Example: 20

Maximum Record to retrieve

client_code
string (required) Example: ICS

Client Code

ReaderType_ID
Integer (Optional) Example: 50

Unique ID of ReaderType

ReaderType_Name
string (Optional) Example: Guatemala

Indicate ReaderType

Active
string (Optional) Example: Y

Indicate Active Record ReaderType

Response 200
Content-Type: application/json
[
    {
        "ReaderType_ID"     :type: Integer,
        "ReaderType_Name"   :type: string,
        "Active"            :type: string
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "start_index"       : 1,
    "max_count"         : 50,
    "client_code"       : "ICS",
    "ReaderType_ID"     : "3",
    "ReaderType_Name"   : "INTERCORP",
    "Active"            : "Y"
}
Response 200
Content-Type: application/json
[
    {
        "ReaderType_ID"     : 3,
        "ReaderType_Name"   : "INTERCORP",
        "Active"            : "Y"

    }
]

ReaderModel

    You can able to fetch ReaderModel.

ReaderModel

SearchReaderModel
GET/SearchReaderModel

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "start_index"     : type :integer,
                                "max_count"       : type :integer,
                                "client_code"     : type :string,
                                "ReaderModel_ID"  : type :integer,
                                "ReaderModel_Name": type :string,
                                "Active"          : type :string
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
start_index
integer (required) Example: 1

Record Start index from the list

max_count
integer (required) Example: 20

Maximum Record to retrieve

client_code
string (required) Example: ICS

Client Code

ReaderModel_ID
Integer (Optional) Example: 1

Unique ID of ReaderModel

ReaderModel_Name
string (Optional) Example: FACEATT2

Indicate ReaderModel

Active
string (Optional) Example: Y

Indicate Active Record ReaderModel

Response 200
Content-Type: application/json
[
    {
        "ReaderModel_ID"     :type: Integer,
        "ReaderModel_Name"   :type: string,
        "Active"             :type: string
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "start_index"       : 1,
    "max_count"         : 50,
    "client_code"       : "ICS",
    "ReaderModel_ID"    : "1",
    "ReaderModel_Name"  : "FACEATT2",
    "Active"            : "Y"

}
Response 200
Content-Type: application/json
[
    {
        "ReaderModel_ID"     : 1,
        "ReaderModel_Name"   : "FACEATT2",
        "Active"             : "Y"

    }
]

AuthenticationMethod

    You can able to fetch AuthenticationMethod.

AuthenticationMethod

SearchAuthenticationMethod
GET/SearchAuthenticationMethod

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "start_index"              : type :integer,
                                "max_count"                : type :integer,
                                "client_code"              : type :string,
                                "AuthenticationMethod_ID"  : type :integer,
                                "AuthenticationMethod_Name": type :string,
                                "Active"                   : type :string
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
start_index
integer (required) Example: 1

Record Start index from the list

max_count
integer (required) Example: 20

Maximum Record to retrieve

client_code
string (required) Example: ICS

Client Code

AuthenticationMethod_ID
Integer (Optional) Example: 1

Unique ID of AuthenticationMethod

AuthenticationMethod_Name
string (Optional) Example: CARD+FACE

Indicate AuthenticationMethod

Active
string (Optional) Example: Y

Indicate Active Record AuthenticationMethod

Response 200
Content-Type: application/json
[
    {
        "AuthenticationMethod_ID"   :type: Integer,
        "AuthenticationMethod_Name" :type: string,
        "Active"                    :type: string
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "start_index"               : 1,
    "max_count"                 : 50,
    "client_code"               : "ICS",
    "AuthenticationMethod_ID"   : "1",
    "AuthenticationMethod_Name" : "CARD+FACE",
    "Active"                    : "Y"
}
Response 200
Content-Type: application/json
[
    {
        "AuthenticationMethod_ID"   : 1,
        "AuthenticationMethod_Name" : "CARD+FACE",
        "Active"                    : "Y"

    }
]

AuthenticationMode

    You can able to fetch AuthenticationMode.

AuthenticationMode

SearchAuthenticationMode
GET/SearchAuthenticationMode

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "start_index"              : type :integer,
                                "max_count"                : type :integer,
                                "client_code"              : type :string,
                                "AuthenticationMode_ID"    : type :integer,
                                "AuthenticationMode_Name"  : type :string,
                                "Active"                   : type :string
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
start_index
integer (required) Example: 1

Record Start index from the list

max_count
integer (required) Example: 20

Maximum Record to retrieve

client_code
string (required) Example: ICS

Client Code

AuthenticationMode_ID
Integer (Optional) Example: 3

Unique ID of AuthenticationMode

AuthenticationMode_Name
string (Optional) Example: LILO

Indicate AuthenticationMode

Active
string (Optional) Example: Y

Indicate Active Record AuthenticationMode

Response 200
Content-Type: application/json
[
    {
        "AuthenticationMode_ID"   :type: Integer,
        "AuthenticationMode_Name" :type: string,
        "Active"                  :type: string
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "start_index"             : 1,
    "max_count"               : 50,
    "client_code"             : "ICS",
    "AuthenticationMode_ID"   : "3",
    "AuthenticationMode_Name" : "LILO",
    "Active"                  : "Y"
}
Response 200
Content-Type: application/json
[
    {
        "AuthenticationMode_ID"   : 3,
        "AuthenticationMode_Name" : "LILO",
        "Active"                  : "Y"

    }
]

ReaderClassification

    You can able to fetch ReaderClassification.

ReaderClassification

SearchReaderClassification
GET/SearchReaderClassification

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "start_index"                : type :integer,
                                "max_count"                  : type :integer,
                                "client_code"                : type :string,
                                "ReaderClassification_ID"    : type :integer,
                                "ReaderClassification_Name"  : type :string
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
start_index
integer (required) Example: 1

Record Start index from the list

max_count
integer (required) Example: 20

Maximum Record to retrieve

client_code
string (required) Example: ICS

Client Code

ReaderClassification_ID
Integer (Optional) Example: 3

Unique ID of ReaderClassification

ReaderClassification_Name
string (Optional) Example: LILO

Indicate ReaderClassification

Response 200
Content-Type: application/json
[
    {
        "ReaderClassification_ID"   :type: Integer,
        "ReaderClassification_Name" :type: string,
        "Active"                    :type: string
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "start_index"               : 1,
    "max_count"                 : 50,
    "client_code"               : "ICS",
    "ReaderClassification_ID"   : "1",
    "ReaderClassification_Name" : "READER"
}
Response 200
Content-Type: application/json
[
    {
        "ReaderClassification_ID"   : 1,
        "ReaderClassification_Name" : "READER",
        "Active"                    : "Y"

    }
]

DoorList

    You can able to fetch DoorList.

DoorList

SearchDoorList
GET/SearchDoorList

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "start_index"      : type :integer,
                                "max_count"        : type :integer,
                                "client_code"      : type :string,
                                "DoorList_ID"      : type :integer,
                                "DoorList_Code"    : type :string
                                "DoorList_Name"    : type :string
                                "Level_Detail_ID"  : type :integer
                                "Active"           : type :string
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
start_index
integer (required) Example: 1

Record Start index from the list

max_count
integer (required) Example: 20

Maximum Record to retrieve

client_code
string (required) Example: ICS

Client Code

DoorList_ID
Integer (Optional) Example: 16

Unique ID of DoorList

DoorList_Code
string (Optional) Example: DL4

Indicate DoorList Code DoorList

DoorList_Name
string (Optional) Example: DL4

Indicate DoorList Name DoorList

Level_Detail_ID
Integer (Optional) Example: 2

Indicate DoorList

Active
string (Optional) Example: Y

Indicate Active Record DoorList

Response 200
Content-Type: application/json
[
    {
        "DoorList_ID"   :type: Integer,
        "DoorList_Code" :type: string,
        "DoorList_Name" :type: string,
        "Active"        :type: string
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "start_index"   : 1,
    "max_count"     : 50,
    "client_code"   : "ICS",
    "DoorList_ID"   : "16",
    "DoorList_Code" : "DL4"
    "DoorList_Name" : "DL4"
    "Active"        : "Y"
}
Response 200
Content-Type: application/json
[
    {
        "DoorList_ID"   : 16,
        "DoorList_Code" : "DL4",
        "DoorList_Name" : "DL4"
    }
]

PayrollGroup

    You can able to fetch PayrollGroup.

PayrollGroup

PayrollGroup
GET/SearchPayrollGroup

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "start_index"      : type :integer,
                                "max_count"        : type :integer,
                                "client_code"      : type :string,
                                "PayrollGroup_ID"  : type :integer,
                                "PayrollGroup_Code": type :string,
                                "PayrollGroup_Name": type :string,
                                "Level_Detail_ID"  : type :integer,
                                "Active"           : type :string
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
start_index
integer (Required) Example: 1

Record Start index from the list

max_count
integer (Required) Example: 20

Maximum Record to retrieve

client_code
string (Required) Example: ICS

Client Code

PayrollGroup_ID
Integer (Optional) Example: 16

Unique ID of Payroll Group

PayrollGroup_Code
string (Optional) Example: DL4

Indicate PayrollGroup Code in Payroll Group

PayrollGroup_Name
string (Optional) Example: DL4

Indicate PayrollGroup Name in Payroll Group

Level_Detail_ID
Integer (Required) Example: 2

Indicate Payroll Group

Active
string (Optional) Example: Y

Indicate Active Record Payroll Group

Response 200
Content-Type: application/json
[
    {
        "PayrollGroup_ID"   :type: Integer,
        "PayrollGroup_Code" :type: string,
        "PayrollGroup_Name" :type: string,
        "Active"            :type: string
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "start_index"       : 1,
    "max_count"         : 50,
    "client_code"       : "ICS",
    "PayrollGroup_ID"   : 3,
    "PayrollGroup_Code" : "GENERAL",
    "PayrollGroup_Name" : "GENERAL",
    "Level_Detail_ID"   : 5,
    "Active"            : "Y"
}
Response 200
Content-Type: application/json
[
    {
        "PayrollGroup_ID"   : "3",
        "PayrollGroup_Code" : "GENERAL",
        "PayrollGroup_Name" : "GENERAL"
    }
]

Nationality

        You can able to add the nationality data.

Add Nationality

Nationality
POST/AddNationality

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"    : type :string,
                                "Nationality"    : type :string
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Client Code

Nationality
string (required) Example: India

Indicate Country Name

Response 200
Content-Type: application/json
[
    {
        "Status"                :type: string,                        
        "Message"               :type: string,
        "Nationality_Details"   :type: array,
        "Nationality_ID"        :type: integer,
        "Nationality"           :type:string
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"   : "ICS",
    "Nationality"   : "America"
}
Response 200
Content-Type: application/json
[
    {
        "Status"            : "Success",
        "Message"           : "Record added successfully",
        "Nationality_Details": [            
            {
                "Nationality_ID" : "85",
                "Nationality"    : "America"
            }
        ]   
    }
]

Edit Nationality

Nationality
PUT/EditNationality

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"    : type :string,
                                "Nationality_ID" : type :integer,
                                "Nationality"    : type :string,
                                "Active"         : type :string
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Client Code

Nationality_ID
integer (required) Example: 85

Indicate Nationality id

Nationality
string (required) Example: America

Indicate Nationality Name

Active
string (required) Example: N

Indicate Country is Active/InActive Yes/No

Response 200
Content-Type: application/json
[
    {
        "Status"             :type: string,                        
        "Message"            :type: string,
        "Nationality_Details":type: array,
        "Nationality_ID"     :type: integer,
        "Nationality"        :type: string
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"   : "ICS",
    "Nationality_ID": 85,
    "Nationality"   : "America",
    "Active"        : "N"
}
Response 200
Content-Type: application/json
[
    {
        "Status"             : "Success",
        "Message"            : "Record updated successfully",
        "Nationality_Details": [            
            {
                "Nationality_ID": "85",
                "Nationality"   : "America"
            }
        ]   
    }
]

Search Nationality

Nationality
GET/SearchNationality

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"    : type :string,
                                "start_index"    : type :integer,
                                "max_count"      : type :integer,
                                "Nationality_ID" : type :integer,
                                "Nationality"    : type :string,
                                "Active"         : type :Char,
                                "mode"           : type :char,
                                "fromdate"       : type :string,
                                "todate"         : type :string

}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Client Code

startindex
integer (required) Example: 1

Record Start index from the list

maxcount
integer (required) Example: 20

Maximum Record to retrieve

Nationality_ID
integer (optional) Example: 15

Respective country id

Nationality
string (optional) Example: INDIAN

Respective country name

Active
Char (optional) Example: Y

This parameter is to get Nationality based on Active data.

mode
string (optional) Example: C

This parameter is to indicate whether data to be filtered based on created or modified date. Provide 'C' for CREATE and 'M' for MODIFY

fromdate
string (optional) Example: YYYY-MM-DDThh:mm:ss.sTZD (eg 2020-07-16T19:20:30+01:00)

This parameter is to get Nationality list based on create or modified date given on MODE.

todate
string (optional) Example: YYYY-MM-DDThh:mm:ss.sTZD (eg 2020-07-16T19:20:30+01:00)

This parameter is to get Nationality based on create or modified date given on MODE.

Response 200
Content-Type: application/json
[
    {
        "Nationality_ID"    :type: integer,
        "Nationality"       :type: string,
        "Active"            :type: string,
        "CreatedDateTime"   :type: datetime,
        "ModifiedDateTime"  :type: datetime
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"   : "ICS",
    "start_index"   : 1,
    "max_count"     : 20,
    "Nationality_ID": 15,
    "Nationality"   : "INDIAN",
    "mode"          : "C",
    "fromdate"      : "2016-01-20T10:00:00+05:30",
    "todate"        : "2020-11-20T10:00:00+05:30",
    "Active"        : "Y"
}
Response 200
Content-Type: application/json
[
    {
        "Nationality_ID"        : 15,
        "Nationality"           : "INDIAN",
        "Active"                : "Y",
        "CreatedBy"             : "Super Admin",
        "CreatedDateTime"       : "2016-09-17T08:10:29+05:30",
        "ModifiedBy"            : "Super Admin",
        "ModifiedDateTime"      : "2016-09-17T08:10:29+05:30"
    }
]

Delete Nationality

Nationality
DELETE/DeleteNationality

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"           : type :string,
                                "Nationality_Details"   :  [            
        {
                                "Nationality_ID" : type :integer            
        }
    ]  
    
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Client Code

NationalityDetail
Nationality_ID
integer (required) Example: 5

Respective Nationality_ID

Response 200
Content-Type: application/json
[
    {
        "Nationality_ID":type: integer,
        "Status"        :type: string,                        
        "Message"       :type: string
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"           :"ICS",
    "Nationality_Details"   : [            
        {
            "Nationality_ID" :"5"            
        }
    ]
}
Response 200
Content-Type: application/json
[
    {
        "Nationality_ID": 1,
        "Status"        : "Success",
        "Message"       : "Record(s) deleted successfully"
  
    }
]

ResidentialDocumentType

    You can able to fetch all authorized client ResidentialDocumentType details filtered based on parameter.

Add ResidentialDocumentType

Add ResidentialDocumentType
POST/AddResidentialDocumentType

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"           : type :string,
                                "Level_Detail_ID"       : type :integer,
                                "ResDoc_Type"           : type :string,
                                "Expiry_Req"            : type :char,  
                                "RefNum_Req"            : type :char,
                                "FileUpld_Req"          : type :char,    
                                "FileUpld_Mandatory"    : type :char                            
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Indicate specific client code

Level_Detail_ID
string (required) Example: 1

ResDoc_Type
string (required) Example: WORK PERMIT

Name of Residential Document Type

Expiry_Req
char (required) Example: Y

Whether expiry time is required or not

RefNum_Req
char (required) Example: Y

Whether reference number is required or not

FileUpld_Req
char (optional) Example: Y

Whether File Upload is required or not

FileUpld_Mandatory
char (optional) Example: Y

Whether File Upload is Mandatory or not

Response 200
Content-Type: application/json
[
    {
        "Status"            :type: string,                        
        "Message"           :type: string,
        "ResDocType_Details":type: array,
        "ResDocType_ID"     :type: string,
        "ResDoc_Type"       :type: string
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"        : "ICS",
    "Level_Detail_ID"    : 1,
    "ResDoc_Type"        : "WORK PERMIT",
    "Expiry_Req"         : "Y",
    "RefNum_Req"         : "Y",
    "FileUpld_Req"       : "Y",
    "FileUpld_Mandatory" : "Y"
}
Response 200
Content-Type: application/json
[
    {
        "Status"                : "Success",
        "Message"               : "Record added successfully",
        "ResDocType_Details": [            
            {
                "ResDocType_ID" : "40",
                "ResDoc_Type"   : "WORK PERMIT"
            }
        ]   
    }
]

Edit ResidentialDocumentType

Edit ResidentialDocumentType
PUT/EditResidentialDocumentType

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"        :type :string,
                                "ResDocType_ID"      :type :integer,
                                "Level_Detail_ID"    :type :integer,
                                "ResDoc_Type"        :type :string,
                                "Expiry_Req"         :type :char,    
                                "RefNum_Req"         :type :char,
                                "Active"             :type :char,
                                "FileUpld_Req"       :type :char,    
                                "FileUpld_Mandatory" :type :char                               
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Indicate specific client code

ResDocType_ID
string (required) Example: 40

Unique Id of Residential Document Type

Level_Detail_ID
string (required) Example: 1

ResDoc_Type
string (required) Example: WORK PERMIT

Name of Residential Document Type

Expiry_Req
char (required) Example: Y

Whether expiry time is required or not

RefNum_Req
char (required) Example: Y

Whether reference number is required or not

Active
char (required) Example: Y

Whether Residential Document Type is Active or not

FileUpld_Req
char (optional) Example: Y

Whether File Upload is required or not

FileUpld_Mandatory
char (optional) Example: Y

Whether File Upload is Mandatory or not

Response 200
Content-Type: application/json
[
    {
        "Status"            :type: string,                        
        "Message"           :type: string,
        "ResDocType_Details":type: array,
        "ResDocType_ID"     :type: string,
        "ResDoc_Type"       :type: string
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"       : "ICS",
    "ResDocType_ID"     : 40,
    "Level_Detail_ID"   : 1,
    "ResDoc_Type"       : "WORK PERMIT",    
    "Expiry_Req"        : "Y",
    "RefNum_Req"        : "Y",
    "Active"            : "Y",
    "FileUpld_Req"      : "Y",
    "FileUpld_Mandatory": "Y"
}
Response 200
Content-Type: application/json
[
    {
        "Status"                    : "Success",
        "Message"                   : "Record updated successfully",
        "ResDocType_Details" : [            
            {
                "ResDocType_ID" : "40",
                "ResDoc_Type"   : "WORK PERMIT"
            }
        ]   
    }
]

Search ResidentialDocumentType

Search ResidentialDocumentType
GET/SearchResidentialDocumentType

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"         : type :string,
                                "start_index"    	  : type :integer,
                                "max_count"      	  : type :integer,
                                "ResDocType_ID"       : type :integer,
                                "ResDoc_Type"         : type :string,
                                "Expiry_Req"          : type :char,
                                "RefNum_Req"          : type :char,
                                "FileUpld_Req"        : type :char,
                                "FileUpld_Mandatory"  : type :char,
                                "Active"              : type :char,
                                "Level_Detail_ID"     : type :integer,
                                "mode"                : type :char,
                                "fromdate"       	  : type :string,
                                "todate"         	  : type :string
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Indicate specific client code

ResDocType_ID
integer (optional) Example: 40

Unique Id of Residential Document Type

Level_Detail_ID
integer (optional) Example: 2

ResDoc_Type
string (optional) Example: WORK PERMIT

Name of Residential Document Type

Expiry_Req
char (optional) Example: Y

Whether expiry time is required or not

RefNum_Req
char (optional) Example: Y

Whether reference number is required or not

FileUpld_Req
char (optional) Example: Y

Whether File Upload is required or not

FileUpld_Mandatory
char (optional) Example: Y

Whether File Upload is Mandatory or not

start_index
integer (required) Example: 1

Record Start index from the list

max_count
integer (required) Example: 20

Maximum Record to retrieve

mode
string (optional) Example: C

This parameter is to indicate whether data to be filtered based on created or modified date. Provide 'C' for CREATE and 'M' for MODIFY

fromdate
string (optional) Example: YYYY-MM-DDThh:mm:ss.sTZD (eg 2020-07-16T19:20:30+01:00)

This parameter is to get Residential document type list based on create or modified date given on MODE.

todate
string (optional) Example: YYYY-MM-DDThh:mm:ss.sTZD (eg 2021-07-16T19:20:30+01:00)

This parameter is to get Residential document type list based on create or modified date given on MODE.

Response 200
Content-Type: application/json
[
    {
        "ResDocType_ID"     :type: integer,
        "ResDoc_Type"       :type: string,
        "Expiry_Req"        :type: char,
        "RefNum_Req"        :type: char,        
        "Active"            :type: char,
        "FileUpld_Req"      :type: char,
        "FileUpld_Mandatory":type: char,
        "CreatedDateTime"   :type: datetime,
        "ModifiedDateTime"  :type: datetime,
        "Level_Detail_ID"   :type: integer
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"       : "ICS",
    "start_index"       : 1,
    "max_count"         : 20,
    "Level_Detail_ID"   : 5,
    "ResDocType_ID"     : 5,
    "ResDoc_Type"       : "WORK PERMIT",
    "Expiry_Req"        : "Y",
    "RefNum_Req"        : "Y",
    "Active"            : "Y",
    "FileUpld_Req"      : "Y",
    "FileUpld_Mandatory": "Y",
    "mode"              : "C",
    "fromdate"          : "2017-03-01T10:00:00+05:30",
    "todate"            : "2020-11-20T10:00:00+05:30"
}
Response 200
Content-Type: application/json
[
    {
        "ResDocType_ID"      : 5,
        "ResDoc_Type"        : "WORK PERMIT",
        "Expiry_Req"         : "Y",
        "RefNum_Req"         : "Y",
        "Active"             : "Y",
        "FileUpld_Req"       : "Y",
        "FileUpld_Mandatory" : "Y",
        "CreatedDateTime"    : "2017-03-28T07:06:06+05:30",
        "ModifiedDateTime"   : "2017-03-28T07:06:06+05:30",
        "Level_Detail_ID"    : 5
    }
]

Client

    You can able to fetch all authorized client information based on filtered parameter.

Search Client

Client
GET/SearchClient

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{  
                                "client_code" : type :string,
                                "mode"        : type :char,
                                "fromdate"    : type :string,
                                "todate"      : type :datetime,  
                                "active"      : type :char
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ALL

Indicate specific client code or use “All” for all client

mode
Char (optional) Example: C

This parameter is to indicate whether data to be filtered based on created or modified date. Provide 'C' for CREATE and 'M' for MODIFY

fromdate
datetime (optional) Example: 2017-03-01T16:00:00.000+08:00

This parameter is to get client list based on create or modified date given on MODE.

todate
datetime (optional) Example: 2017-03-20T22:38:17.943+08:00

This parameter is to get client list based on create or modified date given on MODE.

Active
string (optional) Example: Y

This parameter is to get client list based on their active status. Provide "Y" for active and "N" for non-active

Response 200
Content-Type: application/json
[
    {
        "client_code"     : type: string,
        "client_name"     : type: string,
        "address"         : type: string,
        "email"           : type: string,
        "active"          : type: string,
        "Createddatetime" : type: datetime,
        "Modifieddatetime": type: datetime
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"   : "ALL",
    "mode"          : "C",
    "fromdate"      : "2017-03-01T16:00:00.000+08:00",
    "todate"        : "2017-03-20T22:38:17.943+08:00",
    "active"        : "Y"
}
Response 200
Content-Type: application/json
[
    {
        "client_code"     : "ICS",
        "client_name"     : "INTERCORP SOLUTIONS PTE LTD",
        "address"         : "82 Playfair Road, #10-01, D’Lithium, Singapor"
        "email"           : "hajira@intercorpsolutions.com"
        "active"          : "Y"
        "Createddatetime" : "2017-03-19T22:38:17.943"
        "Modifieddatetime": "2017-05-02T15:43:48.24"
    }
]

Site

    You can able to fetch all authorized client Site details filtered based on parameter.

Add Site

Add Site
POST/AddSite

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"      : type :string
                                "Level_ID"         : type :integer
                                "ParentEntity_ID"  : type :integer
                                "Site_Code"      : type :string
                                "Site_Name"      : type :string
                                "Country_ID"       : type :integer
                                "TimeZone_ID"      : type :integer
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Indicate specific client code

Level_ID
integer (required) Example: 4

Indicate Specific Level(REGION-1,COUNTRY-2,COMPANY-3,ENTITIES-4)

ParentEntity_ID
integer (required) Example: 20058

Indicate Specific Parent ID

Site_Code
string (required) Example: America

Unique Code of Site

Site_Name
string (required) Example: America

Unique Name of Site

Country_ID
integer (required) Example: 2

Indicate specific Country ID

TimeZone_ID
integer (required) Example: 17

Indicate specific TimeZone ID

Response 200
Content-Type: application/json
[
    {
        "Status"                    :type: string,                        
        "Message"                   :type: string,
        "Site_Details"            : [            
            {
                "Level_Detail_ID"   : type: integer,
                "Site_Code"       : type: string
            }
        ]   
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"           : "ICS",
    "Level_ID"              : 2,
    "ParentEntity_ID"       : 1,
    "Site_Code"           : "America",
    "Site_Name"           : "America",
    "Country_ID"            : 17,
    "TimeZone_ID"           : 17
}
Response 200
Content-Type: application/json
[
    {
        "Status"             : "Success",
        "Message"            : "Record added successfully",
        "Site_Details"     : [            
            {
                "ID"         : "20082",
                "Site_Code": "America"
            }
        ]   
    }
]

Edit Site

Edit Site
PUT/EditSite

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"      : type :string,
                                "Level_Detail_ID"  : type :integer,
                                "Level_ID"         : type :integer,
                                "ParentEntity_ID"  : type :integer,
                                "Site_Code"      : type :string,
                                "Site_Name"      : type :string,
                                "Country_ID"       : type :integer,
                                "TimeZone_ID"      : type :integer  
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Indicate specific client code

Level_Detail_ID
integer (required) Example: 20086

Unique Id of Entity

Level_ID
integer (required) Example: 4

Indicate Specific Level(REGION-1,COUNTRY-2,COMPANY-3,ENTITIES-4)

ParentEntity_ID
integer (required) Example: 20058

Indicate Specific Parent ID

Site_Code
string (required) Example: America

Unique Code of Site

Site_Name
string (required) Example: America

Unique Name of Site

Country_ID
integer (required) Example: 2

Indicate specific Country ID

TimeZone_ID
integer (required) Example: 17

Indicate specific TimeZone ID

Response 200
Content-Type: application/json
[
    {
        "Status"                    :type: string,                        
        "Message"                   :type: string,
        "Site_Details"            : [            
            {
                "Level_Detail_ID"   : type: integer,
                "Site_Code"       : type: string
            }
        ]   
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"           : "ICS",
    "Level_Detail_ID"       : 20086,
    "Level_ID"              : 2,
    "ParentEntity_ID"       : 20058,
    "Site_Code"           : "America",
    "Site_Name"           : "America",
    "Country_ID"            : 17,
    "TimeZone_ID"           : 17
}
Response 200
Content-Type: application/json
[
    {
        "Status"             : "Success",
        "Message"            : "Record edited successfully",
        "Site_Details"     : [            
            {
                "ID"         : "20082",
                "Site_Code": "America"
            }
        ]   
    }
]

Search Site

Search Site
GET/SearchSite

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{                                                                
                                "client_code"      : type :string,
                                "Level_ID"         : type :integer,
                                "Level_Name"       : type :string,
                                "ParentEntity_ID"  : type :integer,
                                "ParentSite_Name"  : type :string,
                                "Level_Detail_ID"  : type :integer,
                                "Site_Code"        : type :string,
                                "Site_Name"        : type :string,
                                "Country_ID"       : type :integer,
                                "Country_Name"     : type :string,
                                "TimeZone_ID"      : type :integer,
                                "TimeZone_Name"    : type :string,  	
                                "mode"             : type :char,
                                "fromdate"         : type :string,
                                "todate"           : type :string
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Indicate specific client code

Level_ID
integer (Optional) Example: 4

Indicate Specific Level ID(REGION-1,COUNTRY-2,COMPANY-3,ENTITIES-4)

Level_Name
string (Optional) Example: ENTITIES

Indicate Specific Level Name(REGION-1,COUNTRY-2,COMPANY-3,ENTITIES-4)

ParentEntity_ID
integer (Optional) Example: 20058

Indicate Specific Parent ID

ParentSite_Name
string (Optional) Example: 20058

Indicate Specific Parent Name

Site_Code
string (Optional) Example: America

Unique Code of Site

Site_Name
string (Optional) Example: America

Unique Name of Site

Country_ID
integer (Optional) Example: 2

Indicate specific Country ID

Country_Name
string (Optional) Example: Singapore

Indicate specific Country Name

TimeZone_ID
integer (Optional) Example: 17

Indicate specific TimeZone ID

TimeZone_Name
string (Optional) Example: Kuala Lumpur,Singapore

Indicate specific TimeZone Name

mode
string (optional) Example: C

This parameter is to indicate whether data to be filtered based on created or modified date. Provide 'C' for CREATE and 'M' for MODIFY

fromdate
string (optional) Example: YYYY-MM-DDThh:mm:ss.sTZD (eg 2020-07-16T19:20:30+01:00)

This parameter is to get Site list based on create or modified date given on MODE.

todate
string (optional) Example: YYYY-MM-DDThh:mm:ss.sTZD (eg 2021-07-16T19:20:30+01:00)

This parameter is to get Site list based on create or modified date given on MODE.

Response 200
Content-Type: application/json
[
    {
        "Level_Detail_ID" :type: integer,
        "Level_ID"        :type: integer,         
        "Level_Name"      :type: string,
        "ParentEntity_ID" :type: integer,
        "ParentSite_Name" :type: string,
        "Site_Code"       :type: string,
        "Site_Name"       :type: string,
        "Country_ID"      :type: integer,
        "Country_Name"    :type: string,
        "TimeZone_ID"     :type: integer,
        "TimeZone_Name"   :type: string,
        "Createddatetime" :type: datetime,        
        "Modifieddatetime":type: datetime
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"      : "ICS",
    "Level_Detail_ID"  : 5,
    "Level_ID"         : 3,
    "Level_Name"       : "COMPANY",
    "parentEntity_ID"  : 2,
    "parentEntity_Name": "SG",
    "site_code"        : "ALPHA_CONSTRUCTION",
    "site_name"        : "ALPHA_CONSTRUCTION",
    "Country_ID"       : 115,
    "Country_Name"     : "Singapore",
    "TimeZone_ID"      : 65,
    "TimeZone_Name"    : "Kuala Lumpur, Singapore",
    "mode"             : "C",
    "fromdate"         : "2017-03-20T10:00:00+05:30",
    "todate"           : "2020-11-20T10:00:00+05:30"
}
Response 200
Content-Type: application/json
[
    {
        "Level_Detail_ID" : 5,
    	"Level_ID"        : 3,
    	"Level_Name"      : "COMPANY",
    	"ParentEntity_ID" : 2,
    	"ParentSite_Name" : "SG",
    	"Site_Code"       : "ALPHA_CONSTRUCTION",
    	"Site_Name"       : "ALPHA_CONSTRUCTION",
    	"Country_ID"      : 115,
    	"Country_Name"    : "Singapore",
    	"TimeZone_ID"     : 65,
    	"TimeZone_Name"   : "Kuala Lumpur, Singapore",
    	"Createddatetime" : "2017-03-20T11:16:41+05:30",
    	"Modifieddatetime": "2020-06-23T19:34:44+05:30" 
    }
]

Delete Site

Delete Site
DELETE/DeleteSite

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
    "client_code" : type :string
    "Site_Details": [
            {
                "Level_Detail_ID" : type :integer
            }
        ]
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Indicate specific client code

Site_Details
array (required) Example: []

Contain Site Unique Id List

Level_Detail_ID
integer (required) Example: 20071

Unique Id of Site

Response 200
Content-Type: application/json
[
    {
        "Status"    :type: string,                        
        "Message"   :type: string,        
        "ID"        :type: string
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
"client_code"                  : "ICS",
"Site_Details"               : [
        {
            "Level_Detail_ID"  : 2002
        },
             {
            "Level_Detail_ID"  : 2004
        }
    ]
}
Response 200
Content-Type: application/json
[
    {
        "Status"    : "Success",
        "Message"   : "Record(s) deleted successfully",
        "ID"        : "2002"

    }
]

Location

        You can able to fetch all different site location under specific site.

Search Site Location

Location
GET/SearchSiteLocation

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "start_index"    : type :string,
                                "max_count"      : type :integer,
                                "client_code"    : type :string,
                                "site_code"      : type :string,
                                "location_code"  : type :string, 
                                "mode"           : type :char,
                                "fromdate"       : type :string,
                                "todate"         : type :string,
                                "active"         : type :char                                                                                 
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
start_index
integer (required) Example: 1

Record Start index from the list

max_count
integer (required) Example: 20

Maximum Record to retrieve

client_code
string (required) Example: ICS

Client Code

site_code
string (required) Example: ICS

Indicate site code

location_code
string (required) Example: ALL

Provide specific location code or “ALL” to get all location code.

mode
string (optional) Example: C

This parameter is to indicate whether data to be filtered based on created or modified date. Provide 'C' for CREATE and 'M' for MODIFY

fromdate
string (optional) Example: YYYY-MM-DDThh:mm:ss.sTZD (eg 2020-07-16T19:20:30+01:00)

This parameter is to get profile list based on create or modified date given on MODE.

todate
string (optional) Example: YYYY-MM-DDThh:mm:ss.sTZD (eg 2021-07-16T19:20:30+01:00)

This parameter is to get Profile list based on create or modified date given on MODE.

active
string (optional) Example: Y

This parameter is to get Site location list based on their active status. Provide "Y" for active and "N" for non-active

Response 200
Content-Type: application/json
[
    {
        "location_code"     :type: string,
        "location_desc"     :type: string,
        "active"            :type: string,        
        "Createddatetime"   :type: datetime,     
        "Modifieddatetime"  :type: datetime,
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "start_index"   : 1,
    "max_count"     : 50,
    "client_code"   : "ICS",
    "site_code"     : "ALL",
    "location_code" : "ABC",
    "Active"        : "Y",
    "mode"          : "C",
    "fromdate"      : "2017-03-22T10:00:00+05:30",
    "todate"        : "2020-11-20T10:00:00+05:30"
}
Response 200
Content-Type: application/json
[
  {
    "location_code"     : "ICS",
    "location_desc"     : "INTERCORP SOLUTIONS PTE LTD",
    "active"            : "Y",  
    "Createddatetime"   : "2017-03-22T14:27:13",  
    "Modifieddatetime"  : "2020-07-30T12:42:21"
  },
  {
    "location_code"     : "MAIN_ACCESS",
    "location_desc"     : "MAIN ACCESS",
    "active"            : "Y",  
    "Createddatetime"   : "2017-03-22T12:56:00+05:30",  
    "Modifieddatetime"  : "2020-03-22T12:56:00+05:30"
  }
]

Division

        You can able to add the division data.

Add Division

Division
POST/AddDivision

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"                  : type :string,    
                                "Level_Detail_ID"              : type :string,
                                "Division_Code"                : type :string,
                                "Division_Desc"                : type :string,
                                "Reference_ID"                 : type :string,
                                "Department_Category_Detail"   : [            
            {
                                "Dept_ID"          : type :integer,
                                "Category_ID"      : type :integer
            }
        ]  
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Client Code

Level_Detail_ID
integer (required) Example: 5

Level Detail ID

Division_Code
string (required) Example: OPERATIONS

Division code user defined

Division_Desc
string (optional) Example: OPERATIONS

Division Desc user defined

Reference_ID
string (optional) Example: 12345

Reference_ID user defined

Department_Category_Detail
Array (optional) Example: India

Department_Category_Detail combination of Department and Category

Response 200
Content-Type: application/json
[
    {
        "Status"                 :type: string,                        
        "Message"                :type: string,
        "Division_Detail"        : [            
            {
                "Division_ID"   : type: integer,
                "Division_Desc" : type: string,
                "Division_Code" : type: string
            }
        ]  
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"                   :"ICS",
    "Level_Detail_ID"               :5,
    "Division_Code"                 :"Operations",
    "Division_Desc"                 :"Operations",
    "Reference_ID"                  :"12345",
    "Department_Category_Detail"    : [            
            {
                "Dept_ID"           : 4,
                "Category_ID"       : 55
            }
        ]   
}
Response 200
Content-Type: application/json
[
    {
        "Status"                : "Success",
        "Message"               : "Record added successfully",
        "Division_Detail"       : [            
            {
                "Division_ID"   : "1",
                "Division_Desc" : "Operations",
                "Division_Code" : "Operations"
            }
        ]   
    }
]

Edit Division

Division
PUT/EditDivision

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"                : type :string,
                                "Level_Detail_ID"            : type :string,
                                "Division_ID"                : type :string,
                                "Division_Code"              : type :string,
                                "Division_Desc"              : type :string,
                                "Reference_ID"               : type :string,
                                "Active"                     : type :string,
                                "Department_Category_Detail" : [
        {
                                "Dept_ID"            : type  :integer,
                                "Category_ID"        : type  :integer
        }
    ]
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Client Code

Level_Detail_ID
integer (required) Example: 5

Level Detail ID

Division_ID
integer (required) Example: 5

Division ID

Division_Code
string (required) Example: OPERATIONS

Division code user defined

Division_Desc
string (optional) Example: OPERATIONS

Division Desc user defined

Reference_ID
string (optional) Example: 12345

Reference_ID user defined

Active
string (optional) Example: 12345

Active/InActive

Department_Category_Detail
string (optional) Example: India

Department_Category_Detail combination of Department and Category

Response 200
Content-Type: application/json
[
    {
        "Status"                 :type: string,                        
        "Message"                :type: string,
        "Division_Detail"        : [            
            {
                "Division_ID"   : type: integer,
                "Division_Desc" : type: string,
                "Division_Code" : type: string
            }
        ]  
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"                   :"ICS",
    "Level_Detail_ID"               :5,
    "Division_ID"                   :80,
    "Division_Code"                 :"Operations",
    "Division_Desc"                 :"Operations",
    "Reference_ID"                  :"12345",
    "Active"                        :"N",
    "Department_Category_Detail"    : [            
            {
                "Dept_ID"           :4,
                "Category_ID "      :55
            }
        ]   
}
Response 200
Content-Type: application/json
[
    {
        "Status"                : "Success",
        "Message"               : "Record updated successfully",
        "Division_Detail"       : [            
            {
                "Division_ID"   : "80",
                "Division_Code" : "Operations",
                "Division_Desc" : "Operations"
            }
        ]   
    }
]

Search Division

Division
GET/SearchDivision

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"      : type :string,
                                "start_index"      : type :integer,
                                "max_count"        : type :integer,
                                "Level_Detail_ID"  : type :integer,
                                "Division_ID"      : type :integer,
                                "Division_Code"    : type :string,
                                "Division_Desc"    : type :string,
                                "Reference_ID"     : type :integer,                                                
                                "Active"           : type :char,
                                "mode"             : type :char,
                                "fromdate"         : type :string,
                                "todate"           : type :string
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
start_index
integer (required) Example: 1

Record Start index from the list

max_count
integer (required) Example: 20

Maximum Record to retrieve

client_code
string (required) Example: ICS

Client Code

Level_Detail_ID
integer (optional) Example: 5

Indicate LevelDetailID

Division_ID
integer (optional) Example: 85

Division_ID Unique ID

Division_Code
string (optional) Example: OPERATIONS

Division code user defined

Division_Desc
string (optional) Example: OPERATIONS

Division Desc user defined

Reference_ID
string (optional) Example: 12345

Reference_ID user defined

Active
string (optional) Example: Y

Active/InActive

mode
string (optional) Example: C

This parameter is to indicate whether data to be filtered based on created or modified date. Provide 'C' for CREATE and 'M' for MODIFY

fromdate
string (optional) Example: YYYY-MM-DDThh:mm:ss.sTZD (eg 2020-07-16T19:20:30+01:00)

This parameter is to get Division list based on create or modified date given on MODE.

todate
string (optional) Example: YYYY-MM-DDThh:mm:ss.sTZD (eg 2021-07-16T19:20:30+01:00)

This parameter is to get Division list based on create or modified date given on MODE.

Response 200
Content-Type: application/json
[
    {
        "Division_ID"                 :type: integer,
        "Division_Code"               :type: string,
        "Division_Desc"               :type: string,
        "Reference_ID"                :type: string,        
        "Department_Category_Details" : [            
            {
                "Category_Code"       :type :string,
                "Category_Desc"       :type :string,
                "Department_Code"     :type :string,
                "Department_Desc"     :type :string
            }
        ], 
       "Active"                       :type: string,        
       "CreatedDateTime"              :type: datetime,        
       "ModifiedDateTime"             :type: datetime                                 
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"     : "ICS",
    "start_index"     : 1,
    "max_count"       : 50,
    "Level_Detail_ID" : 5,
    "Division_ID"     : 1,
    "Division_Code"   : "SALES",
    "Division_Desc"   : "SALES",
    "Reference_ID"    : "12345",
    "Active"          : "Y",
    "mode"            : "C",
    "fromdate"        : "2017-03-01T12:00:00+05:30",
    "todate"          : "2020-11-21T12:00:00+05:30"
}
Response 200
Content-Type: application/json
[
    {
        "Division_ID"                 : "1",
        "Division_Code"               : "SALES",
        "Division_Desc"               : "SALES",
        "Reference_ID"                : 12345,        
        "Department_Category_Details" : [            
            {
                "Category_Code"       : "CAT0001",
                "Category_Desc"       : "Labour Team",
                "Department_Code"     : "DEP001",
                "Department_Desc"     : "Labour Dept"
            }
        ],
        "Active"                      : "Y",
        "CreatedDateTime"             : "2017-03-20T13:25:49+05:30",        
        "ModifiedDateTime"            : "2018-03-20T13:25:49+05:30"                                 
    }
]

Delete Division

Division
DELETE/DeleteDivision

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"                  : type :string,
                                "Department_Category_Detail"   : [            
        {
                                "Division_ID"  : type :integer
        }
     ]  
    
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Client Code

Department_Category_Details
Division_ID
integer (required) Example: 25

Respective division ID

Response 200
Content-Type: application/json
[
    {
        "Sno"      :type: integer,
        "Status"   :type: string,                        
        "Message"  :type: string
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"                :"ICS",
    "Department_Category_Detail" : [            
        {
             "Division_ID"    :85
        }
    ] 
}
Response 200
Content-Type: application/json
[
    {
        "Sno"        : "85",
        "Status"     : "Success",
        "Message"    : "Record(s) deleted successfully"
    }
]

Department

    You can able to fetch all authorized client Department details filtered based on parameter.

Add Department

Add Department
POST/AddDepartment

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
    "client_code"               : type :string,
    "Level_Detail_ID"           : type :integer,                                           
    "Dept_Code"                 : type :string,
    "Dept_Desc"                 : type :string,
    "Reference_ID"              : type :string,                           
    "Division_Category_Details" : [
        {
            "Division_ID"       : type :string,
            "Category_ID"       : type :string
        }
    ]                             
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Indicate specific client code

Level_Detail_ID
integer (required) Example: 1

Dept_Code
string (required) Example: Administrative

Unique Code of Department

Dept_Desc
string (required) Example: Administrative

Description of Department Code

Reference_ID
string (required) Example: 3

Reference Id of Department

Division_Category_Details
array (required) Example: []

Division_ID
integer (required) Example: 11

Unique Id of Division

Category_ID
integer (required) Example: 123

Unique Id of Category

Response 200
Content-Type: application/json
[
    {
        "Status"                :type: string,                        
        "Message"               :type: string,        
        "Department_Detail"     : [            
                {
                   "ID"         : type: integer,
                   "Dept_Code"  : type: string
                }
            ]
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"               : "ICS",
    "Level_Detail_ID"           : 1,
    "Dept_Code"                 : "Administrative",
    "Dept_Desc"                 : "Administrative",
    "Reference_ID"              : 3,
    "Division_Category_Details" : [
        {
            "Division_ID"       : 11,
            "Category_ID"       : 123
        }
    ]  
}
Response 200
Content-Type: application/json
[
    {
        "Status"                : "Success",
        "Message"               : "Record added successfully",
        "Department_Detail"     : [            
            {
                "ID"             : "20",
                "Dept_Code"      : "Administrative"
            }
        ]   
    }
]

Edit Department

Edit Department
PUT/EditDepartment

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"                      : type :string,
                                "Level_Detail_ID"                  : type :integer,                                        
                                "Dept_Code"                        : type :string,
                                "Dept_Desc"                        : type :string,
                                "Reference_ID"                     : type :string,
                                "Active"                           : type :char,
                                "Dept_ID"                          : type :integer                                   
                                "Division_Category_Details"        : [
        {
                                "Division_ID"          : type :integer,
                                "Category_ID"          : type :integer
        }
    ]
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Indicate specific client code

Level_Detail_ID
integer (required) Example: 1

Dept_Code
string (required) Example: Administrative

Unique Code of Department

Dept_Desc
string (required) Example: Administrative

Description of Department Code

Dept_ID
integer (required) Example: 3

Reference Id of Department

Active
char (required) Example: 3

Active

Reference_ID
string (required) Example: 3

Reference Id of Department

Division_Category_Details
array (required) Example: []

Division_ID
integer (required) Example: 11

Unique Id of Division

Category_ID
integer (required) Example: 123

Unique Id of Category

Response 200
Content-Type: application/json
[
    {
        "Status"                :type: string,                        
        "Message"               :type: string,
        "Department_Detail"     : [            
                {
                    "ID"        : type: integer,
                    "Dept_Code" : type: string
                }
            ]
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"               : "ICS",
    "Level_Detail_ID"           : 1,
    "Dept_Code"                 : "Administrative",
    "Dept_Desc"                 : "Administrative",
    "Reference_ID"              : 3,
    "Active"                    : "Y",
    "Dept_ID"                   : 3,
    "Division_Category_Details" : [
        {
            "Division_ID"       : 11,
            "Category_ID"       : 123
        }
    ]  
}
Response 200
Content-Type: application/json
[
    {
        "Status"            : "Success",
        "Message"           : "Record updated successfully",
        "Department_Detail" : [            
            {
                "ID"        : "20082",
                "Dept_Code" : "Administrative"
            }
        ]   
    }
]

Search Department

Search Department
GET/SearchDepartment

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"      : type :string,
                                "start_index"      : type :integer,
                                "max_count"        : type :integer,
                                "Level_Detail_ID"  : type :integer,
                                "Dept_ID"          : type :integer,
                                "Dept_Code"        : type :string,
                                "Dept_Desc"        : type :string,
                                "Reference_ID"     : type :integer,
                                "Active"           : type :char,
                                "mode"             : type :char,
                                "fromdate"         : type :string,
                                "todate"           : type :string
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
start_index
integer (required) Example: 1

Record Start index from the list

max_count
integer (required) Example: 20

Maximum Record to retrieve

client_code
string (required) Example: ICS

Indicate specific client code

Level_Detail_ID
integer (optional) Example: 5

Indicate LevelDetailID

Dept_ID
integer (optional) Example: 60

Unique Id of Department

Dept_Code
string (optional) Example: Administrative

Unique Code of Department

Dept_Desc
string (optional) Example: Administrative

Description of Department Code

Active
char (optional) Example: Y

Active/InActive

Reference_ID
string (optional) Example: 3

Reference Id of Department

mode
string (optional) Example: C

This parameter is to indicate whether data to be filtered based on created or modified date. Provide 'C' for CREATE and 'M' for MODIFY

fromdate
string (optional) Example: YYYY-MM-DDThh:mm:ss.sTZD (eg 2020-07-16T19:20:30+01:00)

This parameter is to get Department list based on create or modified date given on MODE.

todate
string (optional) Example: YYYY-MM-DDThh:mm:ss.sTZD (eg 2021-07-16T19:20:30+01:00)

This parameter is to get Department list based on create or modified date given on MODE.

Response 200
Content-Type: application/json
[
    {
        "Dept_Code"                  :type: string,
        "Dept_Desc"                  :type: string,
        "Reference_ID"               :type: string,
        "Division_Category_Details"  :type: array,
        "Division_ID"                :type: integer,
        "Division_Desc"              :type: string,
        "Category_ID"                :type: integer,
        "Category_Desc"              :type: string,
        "Active"                     :type: char,
        "LastActiveDate"             :type: datetime,
        "Level_Detail_ID"            :type: integer,
        "CreatedDateTime"            :type: datetime,
        "ModifiedDateTime"           :type: datetime
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"    : "ICS",
    "start_index"    : 1,
    "max_count"      : 50,
    "Level_Detail_ID": 5,
    "Dept_ID"        : 10,
    "Dept_Code"      : "Tech",
    "Dept_Desc"      : "Technology",
    "Reference_ID"   : "12345",
    "Active"         : "Y",
    "mode"           : "C",
    "fromdate"       : "2017-03-01T12:00:00+05:30",
    "todate"         : "2020-11-21T12:00:00+05:30"
}
Response 200
Content-Type: application/json
[
    {
        "Dept_Code"                  : "Tech",
        "Dept_Desc"                  : "Technology",
        "Reference_ID"               : "1",
        "Division_Category_Details"  : [
                    {
                        "Division_ID"   : 117,
                        "Division_Desc" : "000002 ~ ICSTEST1",
                        "Category_ID"   : 10024,
                        "Category_Desc" : "C0391~Labour Team"                   
                    }
            ]
        "Active"                     : "Y",
        "LastActiveDate"             : "2017-03-20T13:38:47",
        "Level_Detail_ID"            : 2,
        "CreatedDateTime"            : "2017-03-21T19:53:47+05:30",
        "ModifiedDateTime"           : "2020-10-13T21:13:15+05:30"
    }
]

Delete Department

Delete Department
DELETE/DeleteDepartment

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"                 : type :string,
                                "Division_Category_Details"   : [            
            {
                                "Dept_ID"  : type :integer
            }
     ] 
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Indicate specific client code

Division_Category_Details
array (required) Example: []

Contain Unique Id and Unique Code

Dept_ID
integer (required) Example: 80

Unique Id of Department

Response 200
Content-Type : application/json
[
    {
        "Status"        :type: string,                        
        "Message"       :type: string,        
        "ID"            :type: integer
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"               : "ICS",
    "Division_Category_Details" : [
        {
            "Dept_ID"           : 80
        }
    ]
}
Response 200
Content-Type : application/json
[
    {
        "Status"    : "Success",
        "Message"   : "Record(s) deleted successfully",
        "ID"        : 80
    }
]

Category

        You can able to add the category data.

Add Category

Category
POST/AddCategory

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"                  : type :string,                                           
                                "Level_Detail_ID"              : type :string,
                                "Category_Code"                : type :string,
                                "Category_Desc"                : type :string,
                                "Reference_ID"                 : type :string,
                                "Division_Department_Details"  : [            
        {
                                "Dept_ID"              : type :integer,
                                "Division_ID"          : type :integer
        }
    ]  
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Client Code

Level_Detail_ID
integer (required) Example: 5

Level Detail ID

Category_Code
string (required) Example: OPERATIONS

Category code user defined

Category_Desc
string (optional) Example: OPERATIONS

Category Desc user defined

Reference_ID
string (optional) Example: 12345

Reference_ID user defined

Department_Category_Detail
string (optional) Example: India

Department_Category_Detail combination of Department and Division

Response 200
Content-Type: application/json
[
    {
        "Status"                :type: string,                        
        "Message"               :type: string,
       "Category_Detail"        : [            
            {
                "Category_ID"   : type: integer,
                "Category_Code" : type: string,
                "Category_Desc" : type: string
            }
        ] 
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"                :"ICS",
    "Level_Detail_ID"            :5,
    "Category_Code"              :"Operations",
    "Category_Desc"              :"Operations",
    "Reference_ID"               :"12345",
    "Division_Department_Details": [            
        {
            "Dept_ID"            : 12,
            "Division_ID"        : 22
        }
    ]   
}
Response 200
Content-Type: application/json
[
    {
        "Status"                : "Success",
        "Message"               : "Record added successfully",
        "Category_Detail"       : [            
            {
                "Category_ID"   : "1",
                "Category_Code" : "Operations"
                "Category_Desc" : "Operations"
            }
        ]   
    }
]

Edit Category

Category
PUT/EditCategory

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"                  : type :string,                                           
                                "Level_Detail_ID"              : type :string,
                                "Category_ID"                  : type :string,
                                "Category_Code"                : type :string,
                                "Category_Desc"                : type :string,
                                "Reference_ID"                 : type :string,
                                "Active"                       : type :string,
                                "Division_Department_Details"  : [            
        {                                            
                                "Dept_ID"              : type :integer,
                                "Division_ID"          : type :integer
        }
    ]  
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Client Code

LevelDetailID
integer (required) Example: 5

Level Detail ID

Category_ID
integer (required) Example: 5

Category ID

Category_Code
string (required) Example: OPERATIONS

Division code user defined

Category_Desc
string (optional) Example: OPERATIONS

Division Desc user defined

Reference_ID
string (optional) Example: 12345

Reference_ID user defined

Active
string (optional) Example: 12345

Active/InActive

Department_Category_Detail
string (optional) Example: India

Department_Category_Detail combination of Department and Category

Response 200
Content-Type: application/json
[
    {
        "Status"                 :type: string,                        
        "Message"                :type: string,
         "Category_Detail"      : [            
            {
                "Category_ID"    : type: integer,
                "Category_Code"  : type: string,
                "Category_Desc"  : type: string
            }
        ] 
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"                   :"ICS",
    "Level_Detail_ID"               :5,
    "Category_ID"                   :80,
    "Category_Code"                 :"Operations",
    "Category_Desc"                 :"Operations",
    "Reference_ID"                  :"12345",
    "Active"                        :"N",
    "Division_Department_Details"   : [            
        {
            "Dept_ID"               :12,
            "Division_ID"           :22
                
        }
    ]   
}
Response 200
Content-Type: application/json
[
    {
        "Status"                 : "Success",
        "Message"                : "Record updated successfully",
        "Category_Detail"        : [            
            {
                "Category_ID"    : "80",
                "Category_Code"  : "Operations"
                "Category_Desc"  : "Operations"
            }
        ]   
    }
]

Search Category

Category
GET/SearchCategory

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"      : type :string,
                                "start_index"      : type :integer,
                                "max_count"        : type :integer, 
                                "Level_Detail_ID"  : type :integer,
                                "Category_ID"      : type :integer,
                                "Category_Code"    : type :string,
                                "Category_Desc"    : type :string,
                                "Reference_ID"     : type :integer,                                                
                                "Active"           : type :char,
                                "mode"             : type :char,
                                "fromdate"         : type :string,
                                "todate"           : type :string
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
start_index
integer (required) Example: 1

Record Start index from the list

max_count
integer (required) Example: 20

Maximum Record to retrieve

client_code
string (required) Example: ICS

Client Code

Level_Detail_ID
integer (optional) Example: 5

Indicate LevelDetailID

Category_ID
integer (optional) Example: 5

Category ID

Category_Code
string (optional) Example: OPERATIONS

Division code user defined

Category_Desc
string (optional) Example: OPERATIONS

Division Desc user defined

Reference_ID
string (optional) Example: 12345

Reference_ID user defined

Active
string (optional) Example: Y

Active/InActive

mode
string (optional) Example: C

This parameter is to indicate whether data to be filtered based on created or modified date. Provide 'C' for CREATE and 'M' for MODIFY

fromdate
string (optional) Example: YYYY-MM-DDThh:mm:ss.sTZD (eg 2020-07-16T19:20:30+01:00)

This parameter is to get Category list based on create or modified date given on MODE.

todate
string (optional) Example: YYYY-MM-DDThh:mm:ss.sTZD (eg 2021-07-16T19:20:30+01:00)

This parameter is to get Category list based on create or modified date given on MODE.

Response 200
Content-Type: application/json
[
    {
        "Category_ID"                   :type: integer,
        "Category_Code"                 :type: string,
        "Category_Desc"                 :type: string,
        "Reference_ID"                  :type: string,        
        "Department_Category_Details"   : [            
                    {
                        "Division_Code"         :type :string,
                        "Division_Desc"         :type :string,
                        "Department_Code"       :type :string,
                        "Department_Desc"       :type :string,
                    }
                ],
        "Active"                        :type: string,
        "CreatedDateTime"               :type: datetime,
        "ModifiedDateTime"              :type: datetime
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"    : "ICS",
    "start_index"    : 1,
    "max_count"      : 50,
    "Level_Detail_ID": 5,
    "Category_ID"    : 22,
    "Category_Code"  : "ADMINISTRATOR",
    "Category_Desc"  : "ADMINISTRATOR",
    "Reference_ID"   : "12345",
    "Active"         : "Y",
    "mode"           : "C",
    "fromdate"       : "2017-04-17T12:00:00+05:30",
    "todate"         : "2020-11-21T12:00:00+05:30"
}
Response 200
Content-Type: application/json
[
    {
        "Category_ID"                     : "22",
        "Category_Code"                   : "ADMINISTRATOR",
        "Category_Desc"                   : "ADMINISTRATOR",
        "Reference_ID"                    : "Super Admin",        
        "Division_Department_Details"     : [            
            {
                "Division_Code"           :"CAT0001",
                "Division_Desc"           :"Labour Team",
                "Department_Code"         :"DEP001",
                "Department_Desc"         :"Labour Dept",
            }
        ],  
        "Active"                          : "Super Admin",
        "CreatedDateTime"                 : "2017-04-17T12:00:00+05:30",
        "ModifiedDateTime"                : "2020-11-21T12:00:00+05:30"
    }
]

Delete Category

Category
DELETE/DeleteCategory

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"                  : type :string,
                                "Division_Department_Details"  :  [            
        {
                                "Category_ID"           : type :integer                         
        }
    ]  
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Client Code

Department_Category_Details
Category_ID
integer (required) Example: 25

Respective Category ID

Response 200
Content-Type: application/json
[
    {
        "Sno"      :type: integer,
        "Status"   :type: string,                        
        "Message"  :type: string
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"                   : "ICS",
    "Division_Department_Details"   : [            
        {
            "Category_ID"           : 85
        }
    ] 
}
Response 200
Content-Type: application/json
[
    {
        "Sno"        : "85",
        "Status"     : "Success",
        "Message"    : "Record(s) deleted successfully"
    }
]

Company

        You can able to add the Company data.

Add Company

Company
POST/AddCompany

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"           : type :string,
                                "Level_Detail_ID"       : type :integer,
                                "Company_Code"          : type :string,
                                "Company_Desc"          : type :string,
                                "Address"               : type :string,
                                "Country_ID"            : type :integer,
                                "Postal_Code"           : type :string,
                                "Email"                 : type :string,
                                "Phone"                 : type :string,
                                "Fax"                   : type :string,
                                "Website"               : type :string,
                                "Tax_Registration_No"   : type :string,
                                "Sector_ID"             : type :integer,
                                "Company_Registered_No" : type :string,
                                "OrganisationType_ID"   : type :integer,
                                "Company_Type"          : type :string
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Client Code

Level_Detail_ID
integer (required) Example: 5

Indicate LevelDetailID

Company_Code
string (required) Example: ICS001

Indicate CompanyCode

Company_Desc
string (optional) Example: ICS India

Indicate CompanyDesc

Address
string (required) Example: India

Indicate Address

Country_ID
integer (required) Example: 5

Indicate CountryID

Postal_Code
string (required) Example: 600001

Indicate PostalCode

Email
string (required) Example: India@gmail.com

Indicate Email

Phone
string (required) Example: 9900000000

Indicate ContactNo

Fax
string (optional) Example: INDFAX123

Indicate Fax

Website
string (optional) Example: TEST@WEB.COM

Indicate Website

Tax_Registration_No
string (required) Example: 123456

Indicate TaxRegistrationNo

Sector_ID
integer (required) Example: 1

Indicate SectorID

Company_Registered_No
string (required) Example: UEN1012453

Indicate CompanyRegistrationNo

OrganisationType_ID
integer (required) Example: 4

Indicate OrganisationTypeID

Company_Type
string (optional) Example: PUBLIC

Indicate CompanyType

Response 200
Content-Type: application/json
[
        {
            "Status"   :type: string,
            "Message"  :type: string,
            "Company_Details": [
                    {
                        "Company_ID"   :type: integer,
                        "Company_Code" :type:string,
                        "Company_Desc" :type:string
                    }
                ]
        }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"           :"ICS",
    "Level_Detail_ID"       : 1,
    "Company_Code"          :"ALPHA",
    "Company_Desc"          :"ALPHA CONSTRUCTION",
    "Address"               :"Singapore",
    "Country_ID"            : 1,
    "Postal_Code"           :"1234567890",
    "Email"                 :"ICS",
    "Phone"                 :"9858585858",
    "Fax"                   :"Singapre@gmail.com",
    "Website"               :"Singapre@Web.in",
    "Tax_Registration_No"   :"123456",
    "Sector_ID"             : 1,
    "Company_Registered_No" :"UEN1012453",
    "OrganisationType_ID"   : 1,
    "Company_Type"          :"PUBLIC"
}
Response 200
Content-Type: application/json
[
    {
        "Status"         : "Success",
        "Message"        : "Record added successfully",
        "Company_Details": [            
            {
                "Company_ID"         : "85",
                "Company_Code"       : "ALPHA",
                "Company_Description": "ALPHA CONSTRUCTION"
            }
        ]   
    }
]

Edit Company

Company
PUT/EditCompany

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"           : type :string,
                                "Level_Detail_ID"       : type :integer,
                                "Company_ID"            : type :integer,
                                "Company_Code"          : type :string,
                                "Company_Desc"          : type :string,
                                "Address"               : type :string,
                                "Country_ID"            : type :integer,
                                "Postal_Code"           : type :string,
                                "Email"                 : type :string,
                                "Phone"                 : type :string,
                                "Fax"                   : type :string,
                                "Website"               : type :string,
                                "Tax_Registration_No"   : type :string,
                                "Sector_ID"             : type :integer,
                                "Company_Registered_No" : type :string,
                                "OrganisationType_ID"   : type :integer,
                                "Company_Type"          : type :string,
                                "Active"                : type :string
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Client Code

Level_Detail_ID
integer (required) Example: 5

Indicate LevelDetailID

Company_ID
integer (required) Example: 85

Indicate CompanyyID

Company_Code
string (required) Example: ICS001

Indicate CompanyCode

Company_Desc
string (required) Example: ICS India

Indicate CompanyDesc

Address
string (required) Example: India

Indicate Address

Country_ID
integer (required) Example: 5

Indicate CountryID

Postal_Code
string (required) Example: 600001

Indicate PostalCode

Email
string (required) Example: India@gmail.com

Indicate Email

Phone
string (required) Example: 9900000000

Indicate ContactNo

Fax
string (optional) Example: INDFAX123

Indicate Fax

Website
string (optional) Example: TEST@WEB.COM

Indicate Website

Tax_Registration_No
string (required) Example: 123456

Indicate TaxRegistrationNo

Sector_ID
integer (required) Example: 1

Indicate SectorID

Company_Registered_No
string (required) Example: UEN1012453

Indicate CompanyRegistrationNo

OrganisationType_ID
integer (required) Example: 4

Indicate OrganisationTypeID

Company_Type
string (optional) Example: PUBLIC

Indicate CompanyType

Active
string (required) Example: N

Indicate Active Y/N

Response 200
Content-Type: application/json
[
    {
        "Status"         :type: string,
        "Message"        :type: string,
        "Company_Details": [
            {
                "Company_ID"   :type: integer,
                "Company_Code" :type:string,
                "Company_Desc" :type:string
            }
        ]
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"          :"ICS",
    "Level_Detail_ID"      : 1,
    "Company_ID"           : 85,
    "Company_Code"         :"ALPHA",
    "Company_Desc"         :"ALPHA CONSTRUCTION",
    "Address"              :"Singapore",
    "Country_ID"           : 1,
    "Postal_Code"          :"1234567890",
    "Email"                :"ICS",
    "Phone"                :"9825364512",
    "Fax"                  :"Singapre@gmail.com",
    "Website"              :"Singapre@Web.in",
    "Tax_Registration_No"  :"123456",
    "Sector_ID"            : 1,
    "Company_Registered_No":"UEN1012453",
    "OrganisationType_ID"  : 1,
    "Company_Type"         :"PUBLIC",
    "Active"               :"N"
}
Response 200
Content-Type: application/json
[
    {
        "Status"                : "Success",
        "Message"               : "Record updated successfully",
        "Company_Details"       : [            
            {
                "Company_ID"    : "85",
                "Company_Code"  : "ALPHA",
                "Company_Desc"  : "ALPHA CONSTRUCTION"
            }
        ]   
    }
]

Search Company

Company
GET/SearchCompany

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"           : type :string,
                                "start_index"    	    : type :integer,
                                "max_count"      	    : type :integer,
                                "Company_ID"            : type :integer,
                                "Level_Detail_ID"       : type :integer,
                                "Company_Code"          : type :string,
                                "Company_Desc"          : type :string,
                                "Address"               : type :string,
                                "Country_ID"            : type :integer,
                                "Country_Name"          : type :string,
                                "Postal_Code"           : type :string,
                                "Email"                 : type :string,
                                "Phone"                 : type :string,
                                "Fax"                   : type :string,
                                "Website"               : type :string,
                                "Tax_Registration_No"   : type :string,
                                "Sector_ID"             : type :integer,
                                "Sector_Name"           : type :string,
                                "Company_Registered_No" : type :string,
                                "OrganisationType_ID"   : type :integer,
                                "OrganisationType_Name" : type :string,
                                "Company_Type"          : type :string,
                                "Active"                : type :char,
                                "mode"                  : type :char,
                                "fromdate"       	    : type :string,
                                "todate"         	    : type :string
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
start_index
integer (required) Example: 1

Record Start index from the list

max_count
integer (required) Example: 20

Maximum Record to retrieve

client_code
string (required) Example: ICS

Client Code

Company_ID
integer (optional) Example: 85

Respective CompanyID

Level_Detail_ID
integer (optional) Example: 5

Indicate LevelDetailID

Company_Code
string (optional) Example: ICS001

Indicate CompanyCode

Company_Desc
string (optional) Example: ICS India

Indicate CompanyDesc

Address
string (optional) Example: India

Indicate Address

Country_ID
integer (optional) Example: 5

Indicate CountryID

Country_Name
integer (optional) Example: 5

Indicate Country Name

Postal_Code
string (optional) Example: 600001

Indicate PostalCode

Email
string (optional) Example: India@gmail.com

Indicate Email

Phone
string (optional) Example: 9900000000

Indicate ContactNo

Fax
string (optional) Example: INDFAX123

Indicate Fax

Website
string (optional) Example: TEST@WEB.COM

Indicate Website

Tax_Registration_No
string (optional) Example: 123456

Indicate TaxRegistrationNo

Sector_ID
integer (optional) Example: 1

Indicate SectorID

Sector_Name
integer (optional) Example: 1

Indicate Sector Name

Company_Registered_No
string (optional) Example: UEN1012453

Indicate CompanyRegistrationNo

OrganisationType_ID
integer (optional) Example: 4

Indicate OrganisationTypeID

OrganisationType_Name
integer (optional) Example: 4

Indicate OrganisationTypeName

Company_Type
string (optional) Example: PUBLIC

Indicate CompanyType

Active
string (optional) Example: Y

Active/InActive

mode
string (optional) Example: C

This parameter is to indicate whether data to be filtered based on created or modified date. Provide 'C' for CREATE and 'M' for MODIFY

fromdate
string (optional) Example: YYYY-MM-DDThh:mm:ss.sTZD (eg 2020-07-16T19:20:30+01:00)

This parameter is to get Company list based on create or modified date given on MODE.

todate
string (optional) Example: YYYY-MM-DDThh:mm:ss.sTZD (eg 2021-07-16T19:20:30+01:00)

This parameter is to get Company list based on create or modified date given on MODE.

Response 200
Content-Type: application/json
[
    {
        "Company_ID"            :type: integer,
        "Company_Code"          :type: string,
        "Company_Desc"          :type: string,
        "Address"               :type: string,
        "Country_ID"            :type: integer,
        "Country_Name"          :type: string,
        "Postal_Code"           :type: string,
        "Email"                 :type: string,
        "Phone"                 :type: string,
        "Fax"                   :type: string,
        "Website"               :type: string,
        "Tax_Registration_No"   :type: string,
        "Sector_ID"             :type: integer,
        "Sector_Name"           :type: string,
        "Company_Registered_No" :type: string,
        "OrganisationType_ID"   :type: integer,
        "OrganisationType_Name" :type: string,
        "Company_Type"          :type: string,
        "Active"                :type: string,
        "CreatedDateTime"       :type: datetime,
        "ModifiedDateTime"      :type: datetime
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
  {
    "start_index"          : 1,
    "max_count"            : 50,
    "client_code"          : "ICS",
    "Level_Detail_ID"      : 5,
    "Company_Code"         : "freelancer",
    "Company_Desc"         : "freelancer",
    "Address"              : "17/37, Ramakuttylayout, Kavundampalayam,\r\nCoimbatore, tamilnadu, india",
    "Country_ID"           : 56,
    "Country_Name"         : "India",
    "Postal_Code"          : "641030",
    "Email"                : "hariarvindgan@gmail.com",
    "Phone"                : "8883898202",
    "Fax"                  : "Singapre@gmail.com",
    "Website"              : "Singapre@Web.in",
    "Tax_Registration_No"  : "123456",
    "Sector_ID"            : 1,
    "Sector_Name"          : "ENGINEERING",
    "Company_Registered_No": "12345",
    "OrganisationType_ID"  : 1,
    "OrganisationType_Name": "UEN",
    "Company_Type"         : "Private",
    "Active"               : "Y",
    "mode"                 : "C",
    "fromdate"             : "2020-10-30T10:00:00+05:30",
    "todate"               : "2020-11-20T10:00:00+05:30"
}
Response 200
Content-Type: application/json
[
    {
        "Company_ID"             : "85",
        "Company_Code"           : "freelancer",
        "Company_Desc"           : "freelancer",
        "Address"                : "17/37, Ramakuttylayout, Kavundampalayam,\r\nCoimbatore, tamilnadu, india",
        "Country_ID"             : "56",
        "Country_Name"           : "India",
        "Postal_Code"            : "123456",
        "Email"                  : "admin@abcorg.com"
        "Phone"                  : "9457898585",
        "Fax"                    : "INDFAX00",
        "Website"                : "india@web.in",
        "Tax_Registration_No"    : "INDIACOMP001",
        "Sector_ID"              : "1",
        "Sector_Name"            : "ENGINEERING",
        "Company_Registered_No"  : "INDIACOMP001",
        "OrganisationType_ID"    : "1",
        "OrganisationType_Name"  : "ITR",
        "Company_Type"           : "PUBLIC",
        "Active"                 : "Y",
        "CreatedDateTime"        : "2020-10-30T11:48:24+05:30",
        "ModifiedDateTime"       : "2020-10-30T12:47:47+05:30"
    }
]

Company

Company
DELETE/DeleteCompany

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"      : type :string,
                                "Company_Details"  : [            
        {
                                "Company_ID"   : type :integer
        }
    ]  
    
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Client Code

CompanyDetail
Company_ID
integer (required) Example: 25

Respective CompanyID

Response 200
Content-Type: application/json
[
    {
        "Company_ID":type: integer,
        "Status"    :type: string,                        
        "Message"   :type: string
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"      :"ICS",
    "Company_Details"  : [                        
        {
            "Company_ID"  :85
                
        }
    ]
}
Response 200
Content-Type: application/json
[
    {
        "Company_ID" : 1,
        "Status"     : "Success",
        "Message"    : "Record(s) deleted successfully"
    }
]

Designation

    You can able to fetch all authorized client Designation details filtered based on parameter.

Add Designation

Add Designation
POST/AddDesignation

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"          : type :string,
                                "Designation_Code"     : type :string,
                                "Designation_Desc"     : type :string,
                                "Level_Detail_ID"      : type :integer
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Indicate specific client code

Designation_Code
string (required) Example: HR

Unique Code of Designation

Designation_Desc
string (required) Example: HR

Description of Designation Code

Level_Detail_ID
integer (required) Example: 1

Response 200
Content-Type: application/json
[
    {
        "Status"                :type: string,
        "Message"               :type: string,
        "Designation_Details"        : [
            {
                 "Designation_ID"   : type: integer,
                 "Designation_Code" : type: string
            }
        ]
    }
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"       : "ICS",
    "Designation_Code"  : "HR",
    "Designation_Desc"  : "HR",
    "Level_Detail_ID"   : 1
}
Response 200
Content-Type: application/json
[
    {
        "Status"                : "Success",
        "Message"               : "Record added successfully",
        "Designation_Details" : [            
            {
                "Designation_ID"  : 22,
                "Designation_Code": "HR"
            }
        ]   
    }
]

Edit Designation

Edit Designation
PUT/EditDesignation

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"       : type :string,
                                "Designation_ID"    : type :integer,                               
                                "Designation_Code"  : type :string,
                                "Designation_Desc"  : type :string,
                                "Active"            : type :char,                                
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Indicate specific client code

Designation_ID
integer (required) Example: 22

Unique Id of Designation

Designation_Code
string (required) Example: HR

Unique Code of Designation

Designation_Desc
string (required) Example: HR

Description of Designation Code

Active
char (required) Example: Y

Response 200
Content-Type: application/json
[
    {
        "Status"                :type: string,
        "Message"               :type: string,
        "Designation_Details"   : [
            {
                "Designation_ID"   : type: integer,
                "Designation_Code" : type: string
            }
        ]
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"       : "ICS",
    "Designation_ID"    : 22,
    "Designation_Code"  : "HR",
    "Designation_Desc"  : "HR",   
    "Active"            : "Y"
}
Response 200
Content-Type: application/json
[
    {
        "Status"                  : "Success",
        "Message"                 : "Record updated successfully",
        "Designation_Details": [            
            {
                "Designation_ID"  : 22,
                "Designation_Code": "HR"
            }
        ]   
    }
]

Search Designation

Search Designation
GET/SearchDesignation

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"      : type :string,
                                "start_index"      : type :integer,
                                "max_count"        : type :integer,
                                "Designation_ID"   : type :integer,
                                "Designation_Code" : type :string,
                                "Designation_Desc" : type :string,
                                "Level_Detail_ID"  : type :integer,
                                "Active"           : type :char,
                                "mode"             : type :char,
                                "fromdate"         : type :string,
                                "todate"           : type :string
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Indicate specific client code

start_index
integer (required) Example: 1

Record Start index from the list

max_count
integer (required) Example: 20

Maximum Record to retrieve

Designation_ID
integer (optional) Example: 22

Unique Id of Designation

Designation_Code
string (optional) Example: 22

Code of Designation Code

Designation_Desc
string (optional) Example: 22

Description of Designation Desc

Level_Detail_ID
integer (optional) Example: 5

Active
Char (optional) Example: Y

Active / InActive

mode
Char (optional) Example: C

This parameter is to indicate whether data to be filtered based on created or modified date. Provide 'C' for CREATE and 'M' for MODIFY

fromdate
string (optional) Example: YYYY-MM-DDThh:mm:ss.sTZD (eg 2020-07-16T19:20:30+01:00)

This parameter is to get Designation list based on create or modified date given on MODE.

todate
string (optional) Example: YYYY-MM-DDThh:mm:ss.sTZD (eg 2021-07-16T19:20:30+01:00)

This parameter is to get Designation list based on create or modified date given on MODE.

Response 200
Content-Type: application/json
[
    {
        "Designation_ID"    :type: integer,
        "Designation_Code"  :type: string,
        "Designation_Desc"  :type: string,
        "Active"            :type: string,
        "CreatedDateTime"   :type: datetime,
        "ModifiedDateTime"  :type: datetime
        
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"       : "ICS",
    "start_index"       : 1,
    "max_count"         : 50,
    "Designation_ID"    : 1,
    "Designation_Code"  : "EMPLOYEE",
    "Designation_Desc"  : "EMPLOYEE",
    "Level_Detail_ID"   : 5,
    "Active"            : "Y",
    "mode"              : "C",
    "fromdate"          : "2018-02-01T10:00:00+05:30",
    "todate"            : "2020-11-20T10:00:00+05:30"
}
Response 200
Content-Type: application/json
[
    {
        "Designation_ID"    : 1,
        "Designation_Code"  : "EMPLOYEE",
        "Designation_Desc"  : "EMPLOYEE",
        "CreatedBy"         : "Super Admin",
        "CreatedDateTime"   : "2018-02-12T11:24:18+05:30",
        "ModifiedBy"        : "Super Admin",
        "ModifiedDateTime"  : "2018-02-12T11:24:18+05:30",
        "Active"            : "Y",
    }
]

Delete Designation

Delete Designation
DELETE/DeleteDesignation

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"          : type :string,
                                "Designation_Details"  : [
            {
                                "Designation_ID"   : type :integer
            }
        ]
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Indicate specific client code

DesignationDetail
array (required) Example: []

Contain Unique Id and Unique Code

Designation_ID
integer (required) Example: 22

Unique Id of Designation

DesignationCode
string (required) Example: HR

Unique Code of Designation

Response 200
Content-Type: application/json
[
    {
        "Designation_ID":type: integer,
        "Status"        :type: string,
        "Message"       :type: string
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"            : "ICS",
    "Designation_Details"    : [
        {
            "Designation_ID" : 22           
        }
    ]
}
Response 200
Content-Type: application/json
[
    {
            "Designation_ID": 1,
            "Status"        : "Success",
            "Message"       : "Record(s) deleted successfully"
    }
]

Sector

        You can able to add the Sector data.

Add Sector

Sector
POST/AddSector

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"      : type :string,                                            
                                "Level_Detail_ID"  : type :integer,
                                "Sector_Code"      : type :string
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Client Code

Level_Detail_ID
integer (required) Example: 5

Indicate LevelDetailID

Sector_Code
string (required) Example: CONSTRUCTION

Indicate SectorCode

Response 200
Content-Type: application/json
[
    {
        "Status"             :type: string,                        
        "Message"            :type: string,
        "Sector_Detail"      : [            
            {
                "Sector_ID"  : type: integer,
                "Sector_Code": type: string
            }
        ]  
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"     :"ICS",
    "Level_Detail_ID" :1,
    "Sector_Code"     :"CONSTRUCTION"
}
Response 200
Content-Type: application/json
[
    {
        "Status"            : "Success",
        "Message"           : "Record added successfully",
        "Sector_Detail"     : [            
            {
                "Sector_ID"  : 85,
                "Sector_Code": "CONSTRUCTION"
            }
        ]   
    }
]

Edit Sector

Sector
PUT/EditSector

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"     : type :string,                                            
                                "Level_Detail_ID" : type :integer,
                                "Sector_ID"       : type :integer,
                                "Sector_Code"     : type :string,
                                "Active"          : type :char
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Client Code

Level_Detail_ID
integer (required) Example: 5

Indicate LevelDetailID

Sector_ID
integer (required) Example: 4

Indicate SectorID

Sector_Code
string (required) Example: CONSTRUCTION

Indicate SectorCode

Active
string (optional) Example: N

Indicate Country is Active/InActive Yes/No

Response 200
Content-Type: application/json
[
    {
        "Status"               :type: string,                        
        "Message"              :type: string,
        "Sector_Detail"        : [            
            {
                "Sector_ID"    : type: integer,
                "Sector_Code"  : type: string
            }
        ] 
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"    :"ICS",
    "Level_Detail_ID":1,
    "Sector_ID"      :85,
    "Sector_Code"    :"CONSTRUCTION",
    "Active"         :"N"
}
Response 200
Content-Type: application/json
[
    {
        "Status"             : "Success",
        "Message"            : "Record updated successfully",
        "Sector_Detail"      : [            
            {
                "Sector_ID"  : 85,
                "Sector_Code": "CONSTRUCTION"
            }
        ]   
    }
]

Search Sector

Sector
GET/SearchSector

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"      : type :string,
                                "start_index"      : type :integer,
                                "max_count"        : type :integer,
                                "Level_Detail_ID"  : type :integer,
                                "Sector_ID"        : type :integer,
                                "Sector_Code"      : type :string,                                               
                                "Active"           : type :char,
                                "mode"             : type :char,
                                "fromdate"         : type :string,
                                "todate"           : type :string
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
start_index
integer (required) Example: 1

Record Start index from the list

max_count
integer (required) Example: 20

Maximum Record to retrieve

client_code
string (required) Example: ICS

Client Code

Level_Detail_ID
integer (optional) Example: 5

Indicate LevelDetailID

SectorID
integer (optional) Example: 85

Respective SectorID

Sector_Code
string (optional) Example: CONSTRUCTION

Indicate SectorCode

Active
string (optional) Example: Y

Active/InActive

mode
string (optional) Example: C

This parameter is to indicate whether data to be filtered based on created or modified date. Provide 'C' for CREATE and 'M' for MODIFY

fromdate
string (optional) Example: YYYY-MM-DDThh:mm:ss.sTZD (eg 2021-07-16T19:20:30+01:00)

This parameter is to get profile list based on create or modified date given on MODE.

todate
string (optional) Example: YYYY-MM-DDThh:mm:ss.sTZD (eg 2021-07-16T19:20:30+01:00)

This parameter is to get Profile list based on create or modified date given on MODE.

Response 200
Content-Type: application/json
[
    {
        "Sector_ID"          :type: integer,
        "Sector_Code"        :type: string,
        "Active"             :type: string,
        "CreatedDateTime"    :type: datetime,
        "ModifiedDateTime"   :type: datetime
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "start_index" : 1,
    "max_count"   : 50,
    "client_code" : "ICS",
    "Sector_ID"   : 1,
    "Sector_Code" : "ENGINEERING",
    "Active"      : "Y",
    "mode"        : "C",
    "fromdate"    : "2019-04-20T10:00:00+05:30",
    "todate"      : "2020-11-20T10:00:00+05:30"
}
Response 200
Content-Type: application/json
[
    {
        "Sector_ID"        : 85,
        "Sector_Code"      : "ENGINEERING",
        "Active"           : "Y",
        "CreatedDateTime"  : "2019-04-24T08:16:42+05:30",
        "ModifiedDateTime" : "2021-02-06T14:50:31+05:30"
    }
]

Delete Sector

Sector
DELETE/DeleteSector

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"         : type :string,
                                "Sector_Details"      : [            
        {
                                "Sector_ID"   : type :integer
        }
    ]  
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Client Code

Sector_Details
Sector_ID
integer (required) Example: 25

Respective SectorID

Response 200
Content-Type: application/json
[
    {
        "Sno"      :type: integer,
        "Status"   :type: string,                        
        "Message"  :type: string
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"       :"ICS",
    "Sector_Details"    : [            
        {
            "Sector_ID" :85
        }
    ]
}
Response 200
Content-Type: application/json
[
    {
        "Sno"        : 1,
        "Status"     : "Success",
        "Message"    : "Record(s) deleted successfully"
    }
]

ReaderAccessGroup

    You can able to fetch all authorized client ReaderAccessGroup details filtered based on parameter.

Add ReaderAccessGroup

Add ReaderAccessGroup
POST/AddReaderAccessGroup

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"            : type :string,
                                "ReaderAccessGroup_Code" : type :string,
                                "Description"            : type :string,
                                "Level_Detail_ID"        : type :integer,                               
    "ReaderAccessRights"     : [
        {
            "ReaderGroup_ID"     : type :integer,
            "Reader_ID"          : type :integer
        }
    ]                               
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Indicate specific client code

ReaderAccessGroup_Code
string (required) Example: Administrative

Unique Code of Reader Access Group

Description
string (required) Example: Administrative

Description of Reader Access Group

Level_Detail_ID
integer (required) Example: 1

ReaderAccessRights
array (required) Example: []

ReaderGroup_ID
integer (required) Example: 1

Reader_ID
string (required) Example: 6

Response 200
Content-Type: application/json
[
    {
        "Status"                            :type: string,                        
        "Message"                           :type: string,
        "ReaderAccessGrp_Detail"            : [            
                {
                   "ID"                     : type: integer,
                   "ReaderAccessGroup_Code" : type: string
                }
           ] 
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"                   : "ICS",
    "ReaderAccessGroup_Code"        : "Administrative",
    "Description"                   : "Administrative",
    "Level_Detail_ID"               : 1,
    "ReaderAccessRights"            : [
        {
            "ReaderGroup_ID"        : 1,
            "Reader_ID"             : 6
        }
    ]  
}
Response 200
Content-Type: application/json
[
    {
        "Status"                        : "Success",
        "Message"                       : "Record added successfully",
        "ReaderAccessGrp_Detail"        : [            
            {
                "ID"                     : "20",
                "ReaderAccessGroup_Code" : "Administrative"
            }
        ]   
    }
]

Edit ReaderAccessGroup

Edit ReaderAccessGroup
PUT/EditReaderAccessGroup

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
    "client_code"           : type :string,
    "ReaderAccessGroup_ID"  : type :integer,
    "ReaderAccessGroup_Code": type :string,
    "Description"           : type :string,
    "Active"                : type :char,
    "Level_Detail_ID"       : type :integer,                               
    "ReaderAccessRights"    : [
        {
            "ReaderGroup_ID": type :integer,
            "Reader_ID"     : type :integer
        }
    ]                
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Indicate specific client code

ReaderAccessGroup_ID
integer (required) Example: 57

Unique Code of Reader Access Group

ReaderAccessGroup_Code
string (required) Example: Administrative

Unique Code of Reader Access Group

Description
string (required) Example: Administrative

Description of Reader Access Group

Active
char (required) Example: Y

Whether Reader Access Group is active or not

Level_Detail_ID
integer (required) Example: 1

ReaderAccessRights
array (required) Example: []

ReaderGroup_ID
integer (required) Example: 1

Reader_ID
string (required) Example: 6

Response 200
Content-Type: application/json
[
    {
        "Status"                        :type: string,                        
        "Message"                       :type: string,
        "ReaderAccessGrp_Detail"        : [            
            {
                "ID"                    : type: integer,
                "ReaderAccessGroup_Code": type: string
            }
        ] 
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"                   : "ICS",
    "ReaderAccessGroup_ID"          : 57,
    "ReaderAccessGroup_Code"        : "Administrative",
    "Description"                   : "Administrative",
    "Active"                        : "Y",
    "Level_Detail_ID"               : 1,
    "ReaderAccessRights"            : [
        {
            "ReaderGroup_ID"        : 1 ,
            "Reader_ID"             : 6
        }
    ]  
}
Response 200
Content-Type: application/json
[
    {
        "Status"                        : "Success",
        "Message"                       : "Record updated successfully",
        "ReaderAccessGrp_Detail"        : [            
            {
                "ID"                    : "57",
                "ReaderAccessGroup_Code": "Administrative"
            }
        ]   
    }
]

Search ReaderAccessGroup

Search ReaderAccessGroup
GET/SearchReaderAccessGroup

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"              : type :string,
                                "start_index"              : type :integer,
                                "max_count"                : type :integer,
                                "Level_Detail_ID"          : type :integer,                                           
                                "ReaderAccessGroup_ID"     : type :integer,
                                "ReaderAccessGroup_Code"   : type :string,
                                "Description"              : type :string,                                               
                                "Active"                   : type :char,
                                "mode"                     : type :char,
                                "fromdate"                 : type :string,
                                "todate"                   : type :string   
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
start_index
integer (required) Example: 1

Record Start index from the list

max_count
integer (required) Example: 20

Maximum Record to retrieve

client_code
string (required) Example: ICS

Client Code

Level_Detail_ID
integer (optional) Example: 5

Indicate LevelDetailID

ReaderAccessGroup_ID
integer (optional) Example: 57

Unique Code of Reader Access Group

ReaderAccessGroup_Code
string (optional) Example: Administrative

Unique Code of Reader Access Group

Description
string (optional) Example: Administrative

Description of Reader Access Group

Active
string (optional) Example: Y

Active/InActive

mode
string (optional) Example: C

This parameter is to indicate whether data to be filtered based on created or modified date. Provide 'C' for CREATE and 'M' for MODIFY

fromdate
string (optional) Example: YYYY-MM-DDThh:mm:ss.sTZD (eg 2020-07-16T19:20:30+01:00)

This parameter is to get Reader Access group list based on create or modified date given on MODE.

todate
string (optional) Example: YYYY-MM-DDThh:mm:ss.sTZD (eg 2021-07-16T19:20:30+01:00)

This parameter is to get Reader Access group list based on create or modified date given on MODE.

Response 200
Content-Type: application/json
[
    {
        "ReaderAccessGroup_ID"   :type: integer,
        "ReaderAccessGroup_Code" :type: string,
        "Description"            :type: string,
        "Item_Details"           : [
                {
                    "Item_ID"  : type: integer,
                    "Item_Desc": type: string                   
                }
        ],   
        "Active"                 :type: char,
        "LastActiveDate"         :type: datetime, 
        "CreatedDateTime"        :type: datetime,
        "ModifiedDateTime"       :type: datetime
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"           : "ICS",
    "start_index"           : 1,
    "max_count"             : 50,
    "Level_Detail_ID"       : 5,
    "ReaderAccessGroup_ID"  : 19,
    "ReaderAccessGroup_Code": "GENERAL",
    "Description"           : "GENERAL",
    "Active"                : "Y",
    "mode"                  : "C",
    "fromdate"              : "2017-04-17T10:00:00+05:30",
    "todate"                : "2020-11-20T10:00:00+05:30"
}
Response 200
Content-Type: application/json
[
    {
        "ReaderAccessGroup_ID"  : 57,
        "ReaderAccessGroup_Code": "GENERAL",
        "Description"           : "GENERAL",
        "Item_Details"          : [
            {
                    "Item_ID"  : LD_10049_RG_1,
                    "ItemDesc" : "HUAWEI_HQ_LEVEL5_DOOR_ENTRANCE"                  
            }
        ],
        "Active"                : "Y",
        "Level_Detail_ID"       : 2,
        "CreatedDateTime"       : "2017-04-17T10:00:00+05:3",
        "ModifiedDateTime"      : "2020-11-20T10:00:00+05:30"
    }
]

Delete ReaderAccessGroup

Delete ReaderAccessGroup
DELETE/DeleteReaderAccessGroup

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
    "client_code"                   :type :string
    "ReaderAccessRights"            : [
        {
            "ReaderAccessGroup_ID"  : type :integer
        }
    ]
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Indicate specific client code

ReaderAccessRights
array (required) Example: []

Contain Unique Id and Unique Code

ReaderAccessGroup_ID
integer (required) Example: 57

Unique Id of ReaderAccessGroup

Response 200
Content-Type : application/json
[
    {
        "Status"    :type: string,                        
        "Message"   :type: string,        
        "ID"        :type: integer
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"                   : "ICS",
    "ReaderAccessRights"            : [
        {
           "ReaderAccessGroup_ID"   : 57
        }
    ]
}
Response 200
Content-Type : application/json
[
    {
        "Status"    : "Success",
        "Message"   : "Record(s) deleted successfully",
        "ID"        : 57
  
    }
]

Profile

        You can able to fetch profile filter based on parameters.

Add Profile

Profile
POST/AddProfile

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json

    {
    "client_code"              : type :string,
    "Identity_No"              : type :string,
    "Level_Detail_ID"          : type :integer,
    "Last_Level_Entity"        : type :string,
    "Staff_ID"                 : type :string,
    "Biometric_ID"             : type :integer,
    "Name"                     : type :string,
    "GenderCode"               : type :string,
    "DOB"                      : type :string,
    "PlaceOf_Birth"            : type :string,
    "CountryOf_Birth"          : type :string,
    "NationalityCode"          : type :string,
    "CountryOf_Residence"      : type :integer,
    "EducationCode"            : type :string,
    "ReligionCode"             : type :string,
    "BloodGroupCode"           : type :string,
    "MaritalStatusCode"        : type :string,
    "SpouseName"               : type :string,
    "NoofChildren"             : type :integer,
    "Children_Details"         : type :Array,
    "Email"                    : type :string,
    "Contact_No"               : type :string,
    "Contact_Address"          : type :string,
    "EmCon_Person"             : type :string,
    "EmCon_No"                 : type :string,
    "EmContact_Address"        : type :string,
    "DivisionCode"             : type :string,
    "DepartmentCode"           : type :string,
    "CategoryCode"             : type :string,
    "SectionCode"              : type :string,
    "ReaderaccessgroupCode"    : type :string,
    "ShiftCode"                : type :string,
    "DateApplication"          : type :string,
    "Passport"                 : type :string,
    "CountryOf_PassportIssue"  : type :string,
    "Passport_Expiry"          : type :string,
    "Permit_Number"            : type :string,
    "InComeTax_No"             : type :string,
    "Effective_Date"           : type :string,
    "ProfileImage"             : type :string,
    "CustomValues"             : type :Array
    
    }
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Client Code

Identity_No
string (required) Example: 175IdentityNo

Level_Detail_ID
integer (required) Example: 5

LevelDetailID

Last_Level_Entity
string (required) Example: Y

LastLevelEntity

Staff_ID
string (required) Example: 1015

StaffID

Biometric_ID
string (required) Example: 1015

BiometricID

Name
string (required) Example: Jagan

Name

GenderCode
string (required) Example: Male

Gender

DOB
string (optional) Example: 09/10/1992

DOB

PlaceOf_Birth
string (required) Example: Chennai

PlaceOfBirth

CountryOf_Birth
string (required) Example: India

CountryOfBirth

NationalityCode
string (required) Example: Indian

Nationality

CountryOf_Residence
integer (required) Example: India

CountryOfResidence

EducationCode
string (optional) Example: Primary

Education

ReligionCode
string (optional) Example: Hindu

Religion

BloodGroupCode
string (optional) Example: O+

BloodGroup

MaritalStatusCode
string (optional) Example: Married

MaritalStatus

SpouseName
string (optional) Example: Jessy

NoofChildren
integer (optional) Example: 0

NoofChildren

Children_Details
Array (optional) Example: 

Children_Details

Email
string (optional) Example: jegam@gmail.com

Email

Contact_No
string (optional) Example: 8080808080

ContactNo

Contact_Address
string (optional) Example: chennai

ContactAddress

EmCon_Person
string (optional) Example: jegan

EmConPerson

EmCon_No
string (optional) Example: 808055050

EmConNo

EmContact_Address
string (required) Example: chennai, tamilnadu

EmContactAddress

DivisionCode
string (required) Example: Implementation

Division

DepartmentCode
string (required) Example: Hardware

Department

CategoryCode
string (required) Example: Opscat

Category

SectionCode
string (required) Example: Fulltime

Section

ReaderaccessgroupCode
string (required) Example: MGMT

ReaderAccessGroup

ShiftCode
string (required) Example: General

Shift

DateApplication
string (optional) Example: 11/03/2020

DateApplication

Passport
string (required) Example: PASSIND00232

Passport

CountryOf_PassportIssue
string (required) Example: India

CountryOfPassportIssue

Passport_Expiry
string (required) Example: 12/01/2027

PassportExpiry

Permit_Number
string (optional) Example: 123456

PermitNumber

InComeTax_No
string (optional) Example: TAX0025052

InComeTaxNo

Effective_Date
string (required) Example: YYYY-MM-DDThh:mm:ss.sTZD (eg 2020-07-16T19:20:30+01:00)

Effective Date

ProfileImage
string (optional) Example: UHJvZmlsZS9kZWZhdWx0LmpwZw==

ProfileImage

CustomValues
Array (optional) Example: 

CustomValues

Response 200
Content-Type: application/json
[
    {
        "Status"      :type: string,
        "Message"     :type: string,
        "Profile_Details":[
                {
                    "Profile_ID"  :type: integer,
                    "Name"        :type: string,
                    "Staff_ID"    :type: string,
                    "Biometric_ID":type: integer
                }
            ]
        }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json

    {
    "client_code"           : "ICS",
    "Identity_No"           : 175,
    "Level_Detail_ID"       : 5,
    "Last_Level_Entity"     : "Y",
    "Staff_ID"              : "1015",
    "Biometric_ID"          : 1018,
    "Name"                  : "jegan",
    "GenderCode"            : "Male",
    "DOB"                   : "09/10/1992",
    "PlaceOf_Birth"         : "Chennai",
    "CountryOf_Birth"       : "India",
    "NationalityCode"       : "Indian",
    "CountryOf_Residence"   : "India",
    "EducationCode"         : "Secondary",
    "ReligionCode"          : "Hindu",
    "BloodGroupCode"        : "O+",
    "MaritalStatusCode"     : "Married",
    "SpouseName"            : "jessy",
    "NoofChildren"          : 1,
    "Children_Details": [
    {
    "Sno"      : 1,
    "Childname": "Jeffere",
    "DOB  "    : "09/10/1999"
    }
    ],
    "Email"                  : "jegan@gmail.com",
    "Contact_No"             : "8080808080",
    "Contact_Address"        : "Chennai",
    "EmCon_Person"           : "James",
    "EmCon_No"               : "8080808080",
    "EmContact_Address"      : "Chennai",
    "DivisionCode"           : "Implementation",
    "DepartmentCode"         : "Hardware",
    "CategoryCode"           : "Opscat",
    "SectionCode"            : "Fulltime",
    "ReaderAccessGroupCode"  : "MGMT",
    "ShiftCode"              : "General",
    "DateApplication"        : "11/03/2020",
    "Passport"               : "PASSIND00232",
    "CountryOf_PassportIssue": "India",
    "Passport_Expiry"        : "12/01/2027",
    "Permit_Number"          : "123456",
    "InComeTax_No"           : "TAX0025052",
    "Effective_Date"         : "2021-03-30T09:12:00+05:30",
    "ProfileImage"           : "UHJvZmlsZS9kZWZhdWx0LmpwZw==",
    "CustomValues": [
    {
    "CustomName"     : "Smoking status",
    "Description"    : "NO"
    }]
    
    }
Response 200
Content-Type: application/json
[
    {
       "Status"            : "Success",
       "Message"           : "Record added successfully",
       "Profile_Details"   : [            
            {
                "Profile_ID"  : "85",
                "Name"        : "Jegan",
                "Staff_ID"    : "1015",
                "Biometric_ID": "1017"
            }
        ]   
    }
]

Edit Profile

Profile
PUT/EditProfile

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json

    {
    "client_code"             : type :string,
    "Identity_No"             : type :string,
    "Profile_ID"              : type :integer,
    "Level_Detail_ID"         : type :integer,
    "Last_Level_Entity"       : type :string,
    "Staff_ID"                : type :string,
    "Biometric_ID"            : type :integer,
    "Name"                    : type :string,
    "GenderCode"              : type :string,
    "DOB"                     : type :string,
    "PlaceOf_Birth"           : type :string,
    "CountryOf_Birth"         : type :string,
    "NationalityCode"         : type :string,
    "CountryOf_Residence"     : type :integer,
    "EducationCode"           : type :string,
    "ReligionCode"            : type :string,
    "BloodGroupCode"          : type :string,
    "MaritalStatusCode"       : type :string,
    "SpouseName"              : type :string,
    "NoofChildren"            : type :integer,
    "Children_Details"        : type :Array,
    "Email"                   : type :string,
    "Contact_No"              : type :string,
    "Contact_Address"         : type :string,
    "EmCon_Person"            : type :string,
    "EmCon_No"                : type :string,
    "EmContact_Address"       : type :string,
    "DivisionCode"            : type :string,
    "DepartmentCode"          : type :string,
    "CategoryCode"            : type :string,
    "SectionCode"             : type :string,
    "ReaderaccessgroupCode"   : type :string,
    "ShiftCode"               : type :string,
    "DateApplication"         : type :string,
    "Passport"                : type :string,
    "CountryOf_PassportIssue" : type :string,
    "Passport_Expiry"         : type :string,
    "Permit_Number"           : type :string,
    "InComeTax_No"            : type :string,
    "Effective_Date"          : type :string,
    "ProfileImage"            : type :string,
    "CustomValues"            : type :Array
    
    }
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Client Code

Identity_No
string (required) Example: 175IdentityNo

Profile_ID
integer (required) Example: 175ProfileID

Level_Detail_ID
integer (required) Example: 5

LevelDetailID

Last_Level_Entity
string (required) Example: Y

LastLevelEntity

Staff_ID
string (required) Example: 1015

StaffID

Biometric_ID
string (required) Example: 1015

BiometricID

Name
string (required) Example: Jagan

Name

GenderCode
string (required) Example: Male

Gender

DOB
string (optional) Example: 09/10/1992

DOB

PlaceOf_Birth
string (required) Example: Chennai

PlaceOfBirth

CountryOf_Birth
string (required) Example: India

CountryOfBirth

NationalityCode
string (required) Example: Indian

Nationality

CountryOf_Residence
integer (required) Example: India

CountryOfResidence

EducationCode
string (optional) Example: Primary

Education

ReligionCode
string (optional) Example: Hindu

Religion

BloodGroupCode
string (optional) Example: O+

BloodGroup

MaritalStatusCode
string (optional) Example: Married

MaritalStatus

SpouseName
string (optional) Example: Jessy

NoofChildren
integer (optional) Example: 0

NoofChildren

Children_Details
Array (optional) Example: 

Children_Details

Email
string (optional) Example: jegam@gmail.com

Email

Contact_No
string (optional) Example: 8080808080

ContactNo

Contact_Address
string (optional) Example: chennai

ContactAddress

EmCon_Person
string (optional) Example: jegan

EmConPerson

EmCon_No
string (optional) Example: 808055050

EmConNo

EmContact_Address
string (required) Example: chennai, tamilnadu

EmContactAddress

DivisionCode
string (required) Example: Implementation

Division

DepartmentCode
string (required) Example: Hardware

Department

CategoryCode
string (required) Example: Opscat

Category

SectionCode
string (required) Example: Fulltime

Section

ReaderaccessgroupCode
string (required) Example: MGMT

ReaderAccessGroup

ShiftCode
string (required) Example: General

Shift

DateApplication
string (optional) Example: 11/03/2020

DateApplication

Passport
string (required) Example: PASSIND00232

Passport

CountryOf_PassportIssue
string (required) Example: India

CountryOfPassportIssue

Passport_Expiry
string (required) Example: 12/01/2027

PassportExpiry

Permit_Number
string (optional) Example: 123456

PermitNumber

InComeTax_No
string (optional) Example: TAX0025052

InComeTaxNo

Effective_Date
string (optional) Example: YYYY-MM-DDThh:mm:ss.sTZD (eg 2020-07-16T19:20:30+01:00)

Effective Date

ProfileImage
string (optional) Example: UHJvZmlsZS9kZWZhdWx0LmpwZw==

ProfileImage

CustomValues
Array (optional) Example: 

CustomValues

Response 200
Content-Type: application/json
[
        {
            "Status"      :type: string,
            "Message"     :type: string,
            "Profile_Details":[
                    {
                        "Profile_ID"  :type: integer,
                        "Name"        :type: string,
                        "Staff_ID"    :type: string,
                        "Biometric_ID":type: integer
                    }
                ]
         }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json

    {
    "client_code"           : "ICS",
    "Identity_No"           : 175,
    "Profile_ID"            : 11060,
    "Level_Detail_ID"       : 5,
    "Last_Level_Entity"     : "Y",
    "Staff_ID"              : "1015",
    "Biometric_ID"          : 1018,
    "Name"                  : "jegan",
    "GenderCode"            : "Male",
    "DOB"                   : "09/10/1992",
    "PlaceOf_Birth"         : "Chennai",
    "CountryOf_Birth"       : "India",
    "NationalityCode"       : "Indian",
    "CountryOf_Residence"   : "India",
    "EducationCode"         : "Secondary",
    "ReligionCode"          : "Hindu",
    "BloodGroupCode"        : "O+",
    "MaritalStatusCode"     : "Married",
    "SpouseName"            : "jessy",
    "NoofChildren"          : 1,
    "Children_Details": [
    {
    "Sno"      : 1,
    "Childname": "Jeffere",
    "DOB  "    : "09/10/1999"
    }
    ],
    "Email"                  : "jegan@gmail.com",
    "Contact_No"             : "8080808080",
    "Contact_Address"        : "Chennai",
    "EmCon_Person"           : "James",
    "EmCon_No"               : "8080808080",
    "EmContact_Address"      : "Chennai",
    "DivisionCode"           : "Implementation",
    "DepartmentCode"         : "Hardware",
    "CategoryCode"           : "Opscat",
    "SectionCode"            : "Fulltime",
    "ReaderAccessGroupCode"  : "MGMT",
    "ShiftCode"              : "General",
    "DateApplication"        : "11/03/2020",
    "Passport"               : "PASSIND00232",
    "CountryOf_PassportIssue": "India",
    "Passport_Expiry"        : "12/01/2027",
    "Permit_Number"          : "123456",
    "InComeTax_No"           : "TAX0025052",
    "Effective_Date"         : "2021-03-30T09:12:00+05:30",
    "ProfileImage"           : "UHJvZmlsZS9kZWZhdWx0LmpwZw==",
    "CustomValues": [
    {
    "CustomName"     : "Smoking status",
    "Description"    : "NO"
    }
    ]

    
    }
Response 200
Content-Type: application/json
[
    {
        "Status"          : "Success",
        "Message"         : "Record updated successfully",
        "Profile_Details" : [            
            {
                "Profile_ID"  : "85",
                "Name"        : "Jegan",
                "Staff_ID"    : "1015",
                "Biometric_ID": "1017"
            }
        ]   
    }
]

Search Profile

Profile
GET/SearchProfile

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "start_index"    : type :integer,
                                "max_count"      : type :integer,
                                "client_code"    : type :string,
                                "Biometric_ID"   : type :long,
                                "Profile_ID"     : type :string,
                                "Unique_ID"      : type :string,
                                "Reference_ID"   : type :string,
                                "mode"           : type :char,
                                "fromdate"       : type :string,
                                "todate"         : type :string,
                                "Active"         : type :char
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
start_index
integer (required) Example: 1

Record Start index from the list

max_count
integer (required) Example: 20

Maximum Record to retrieve

client_code
string (required) Example: ICS

Client Code

biometric_ID
long (optional) Example: 1001

Unique profile biometric information id

Profile_ID
string (optional) Example: "P001"

Unique ID of profile

Unique_ID
string (optional) Example: 1

Unique ID of profile

Reference_ID
string (optional) Example: CIN123

Unique Third party integration ID

mode
string (optional) Example: C

This parameter is to indicate whether data to be filtered based on created or modified date. Provide 'C' for CREATE and 'M' for MODIFY

fromdate
string (optional) Example: YYYY-MM-DDThh:mm:ss.sTZD (eg 2020-07-16T19:20:30+01:00)

This parameter is to get profile list based on create or modified date given on MODE.

todate
string (optional) Example: YYYY-MM-DDThh:mm:ss.sTZD (eg 2021-07-16T19:20:30+01:00)

This parameter is to get Profile list based on create or modified date given on MODE.

active
string (optional) Example: Y

This parameter is to get Profile list based on their active status. Provide "Y" for active and "N" for non-active

Response 200
Content-Type: application/json
[
    {
        "Profile_ID"        :type: string,
        "Unique_ID"         :type: string,
        "Reference_ID"      :type: string,
        "Biometric_ID"      :type: string,
        "Name"              :type: string,
        "Gender"            :type: string,
        "DateOfBirth"       :type: datetime,
        "Nationality"       :type: string,
        "Email"             :type: string,
        "Address"           :type: string,
        "ContactNo"         :type: string,
        "Org_Details"              :type: array,
            [
                {
		    "site_code"         :type: string,
		    "site_name"         :type: string,
		    "division_code"     :type: string,
		    "division_desc"     :type: string,
		    "department_code"   :type: string,
		    "department_desc"   :type: string,
		    "category_code"     :type: string,
		    "category_desc"     :type: string,
		    "section_code"      :type: string,
		    "section_desc"      :type: string,
		    "designation_code"  :type: string,
		    "designation_desc"  :type: string,
		    "EffectiveDate"     :type: datetime,   
		    "active"            :type: string
                }
            ],
        "active"            :type: string, 
        "Createddatetime"   :type: datetime,
        "Modifieddatetime"  :type: datetime
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "start_index" : 1,
    "max_count"   : 50,
    "client_code" : "ICS",
    "Biometric_ID": "10187",
    "Profile_ID"  : "11108",
    "Unique_ID"   : "220",
    "Reference_ID": "12345",
    "Active"      : "Y",
    "mode"        : "C",
    "fromdate"    : "2020-03-24T10:00:00+05:30",
    "todate"      : "2021-03-27T10:00:00+05:30"
}
Response 200
Org_Details property may contain additional custom field values If any defined.
Content-Type: application/json
[
  {
    "Profile_ID"        : "P001",
    "Unique_ID"         : "",
    "Reference_ID"      : "NA",
    "Biometric_ID"      : "1001",
    "Name"              : "Mark Antony",
    "Gender"            : "1",
    "DateOfBirth"       : "1980-08-19T00:00:00",
    "Nationality"       : "SINGAPOREAN",
    "Email"             : "abc@intercorpsolutions.com",
    "Address"           : "27 New Industrial Road",
    "ContactNo"         : "93390228",
    "Org_Details"              : 
        [
            {
		"site_code"         : "I0001", 
		"site_name"         : "ALPHA_CONSTRUCTION", 
		"division_code"     : "sale_Div", 
		"division_desc"     : "sale_Div",
		"department_code"   : "Sales_dept", 
		"department_desc"   : "Sales_dept",
		"category_code"     : "sale_categ", 
		"category_desc"     : "sale_categ",
		"section_code"      : "SUPERVISOR", 
		"section_desc"      : "SUPERVISOR",
		"designation_code"  : "EMPLOYEE", 
		"designation_desc"  : "EMPLOYEE",
		"EffectiveDate"     : "2016-01-01T00:00:00",
		"active"            : "N"
            }
            {
		"site_code"         : "I0002", 
		"site_name"         : "ABC", 
		"division_code"     : "ADMIN", 
		"division_desc"     : "ADMIN",
		"department_code"   : "NA", 
		"department_desc"   : "NA",
		"category_code"     : "NA", 
		"category_desc"     : "NA",
		"section_code"      : "MANAGER", 
		"section_desc"      : "MANAGER",
		"designation_code"  : "EMPLOYEE", 
		"designation_desc"  : "EMPLOYEE",
		"EffectiveDate"     : "2000-03-01T00:00:00",
		"active"            : "Y"
            }
        ],
    "active"            : "Y", 
    "Createddatetime"   : "22017-04-09T22:15:29",
    "Modifieddatetime"  : "2020-07-01T17:08:46",  
  },
     {                                                                                                                                                                                                                                  {
    "Profile_ID"        : "P002",
    "Unique_ID"         : "",
    "Reference_ID"      : "NA",
    "Biometric_ID"      : "1002",
    "Name"              : "Lidiana",
    "Gender"            : "2",
    "DateOfBirth"       : "1979-10-09T00:00:00",
    "Nationality"       : "HONG KONG",
    "Email"             : "xyz@intercorpsolutions.com",
    "Address"           : "1",
    "ContactNo"         : "98765295",
    "Org_Details"              : 
        [
            {
		"site_code"         : "I0001", 
		"site_name"         : "ALPHA_CONSTRUCTION", 
		"division_code"     : "sale_Div", 
		"division_desc"     : "sale_Div",
		"department_code"   : "Sales_dept", 
		"department_desc"   : "Sales_dept",
		"category_code"     : "sale_categ", 
		"category_desc"     : "sale_categ",
		"section_code"      : "SUPERVISOR", 
		"section_desc"      : "SUPERVISOR",
		"designation_code"  : "EMPLOYEE", 
		"designation_desc"  : "EMPLOYEE",
		"EffectiveDate"     : "2016-01-01T00:00:00",
		"active"            : "N"
            }
            {
		"site_code"         : "I0002", 
		"site_name"         : "ABC", 
		"division_code"     : "ADMIN", 
		"division_desc"     : "ADMIN",
		"department_code"   : "NA", 
		"department_desc"   : "NA",
		"category_code"     : "NA", 
		"category_desc"     : "NA",
		"section_code"      : "MANAGER", 
		"section_desc"      : "MANAGER",
		"designation_code"  : "EMPLOYEE", 
		"designation_desc"  : "EMPLOYEE",
		"EffectiveDate"     : "2000-03-01T00:00:00",
		"active"            : "Y"
            }
        ],
    "active"            : "Y", 
    "Createddatetime"   : "2017-04-09T22:43:49",
    "Modifieddatetime"  : "2020-04-13T14:33:22"  
  }
]

Search Site Profile

Site Profile
GET/SearchSiteProfile

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "start_index"    : type :integer,
                                "max_count"      : type :integer,
                                "client_code"    : type :string,
                                "site_code"      : type :string,
                                "BiometricID"    : type :long,
                                "ProfileID"      : type :string,
                                "UniqueID"       : type :string,
                                "ReferenceID"    : type :string,
                                "mode"           : type :char,
                                "fromdate"       : type :string,
                                "todate"         : type :string,
                                "active"         : type :char
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
start_index
integer (required) Example: 1

Record Start index from the list

max_count
integer (required) Example: 20

Maximum Record to retrieve

client_code
string (required) Example: ICS

Client Code

site_code
string (required) Example: ICS

Indicate site code

biometricid
long (optional) Example: 1001

Unique profile biometric information id

ProfileID
string (optional) Example: "P001"

Unique ID of profile

UniqueID
string (optional) Example: 1

Unique ID of profile

ReferenceID
string (optional) Example: CIN123

Unique Third party integration ID

mode
string (optional) Example: C

This parameter is to indicate whether data to be filtered based on created or modified date. Provide 'C' for CREATE and 'M' for MODIFY

fromdate
string (optional) Example: YYYY-MM-DDThh:mm:ss.sTZD (eg 2020-07-16T19:20:30+01:00)

This parameter is to get profile list based on create or modified date given on MODE.

todate
string (optional) Example: YYYY-MM-DDThh:mm:ss.sTZD (eg 2020-07-16T19:20:30+01:00)

This parameter is to get Profile list based on create or modified date given on MODE.

active
string (optional) Example: Y

This parameter is to get Profile list based on their active status. Provide "Y" for active and "N" for non-active

Response 200
Content-Type: application/json
[
    {
                        
        "ProfileID"     :type: string,
        "UniqueID"      :type: string,
        "ReferenceID"   :type: string,
        "BiometricID"   :type: string,
        "Name"          :type: string,
        "Gender"        :type: string,
        "DateOfBirth"   :type: datetime,
        "Nationality"   :type: string,
        "Email"         :type: string,
        "Address"       :type: string,
        "ContactNo"     :type: string,
        "EffectiveDate" :type: datetime,
        "Org_Details"   :type: array,
            [
                {
			"division_code"     :type: string,
			"division_desc"     :type: string,
			"department_code"   :type: string,
			"department_desc"   :type: string,
			"category_code"     :type: string,
			"category_desc"     :type: string,
			"section_code"      :type: string,
			"section_desc"      :type: string,
			"designation_code"  :type: string,
			"designation_desc"  :type: string,
			"EffectiveDate"     :type: datetime,   
			"active"            :type: string
                }
            ],	
        "active"            :type: string,
        "CreatedDateTime"   :type: datetime,
        "ModifiedDateTime"  :type: datetime
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "start_index" : 1,
    "max_count"   : 50,
    "client_code" : "ICS",
    "site_code"   : "ICS",
    "Biometric_ID": "10187",
    "Profile_ID"  : "11108",
    "Unique_ID"   : "220",
    "Reference_ID": "12345",
    "Active"      : "Y",
    "mode"        : "C",
    "fromdate"    : "2020-03-24T10:00:00+05:30",
    "todate"      : "2021-03-27T10:00:00+05:30"
}
Response 200
Org_Details property may contain additional custom field values If any defined.
Content-Type: application/json
[
    {
        "ProfileID"     : "P001",
        "UniqueID"      : "",
        "ReferenceID"   : "NA",
        "BiometricID"   : "1001",
        "Name"          : "Mark Antony",
        "Gender"        : "1",
        "DateOfBirth"   : "1980-08-19T00:00:00",
        "Nationality"   : "SINGAPOREAN",
        "Email"         : "abc@intercorpsolutions.com",
        "Address"       : "27 New Industrial Road",
        "ContactNo"     : "93390228",
        "EffectiveDate" : "2020-08-19T00:00:00",
        "Org_Details"   : 
        [
            {
		"division_code"     : "sale_Div", 
		"division_desc"     : "sale_Div",
		"department_code"   : "Sales_dept", 
		"department_desc"   : "Sales_dept",
		"category_code"     : "sale_categ", 
		"category_desc"     : "sale_categ",
		"section_code"      : "SUPERVISOR", 
		"section_desc"      : "SUPERVISOR",
		"designation_code"  : "EMPLOYEE", 
		"designation_desc"  : "EMPLOYEE",
		"EffectiveDate"     : "2016-01-01T00:00:00",
		"active"            : "N"
            }
            {
		"division_code"     : "ADMIN", 
		"division_desc"     : "ADMIN",
		"department_code"   : "NA", 
		"department_desc"   : "NA",
		"category_code"     : "NA", 
		"category_desc"     : "NA",
		"section_code"      : "MANAGER", 
		"section_desc"      : "MANAGER",
		"designation_code"  : "EMPLOYEE", 
		"designation_desc"  : "EMPLOYEE",
		"EffectiveDate"     : "2000-03-01T00:00:00",
		"active"            : "Y"
            }
        ],
    "active"            : "Y",
    "CreatedDateTime"   : "2016-01-01T00:00:00",  
    "ModifiedDateTime"  : "2016-01-01T00:00:00",                       
  },
  {                                                                                                                                                                                                                                  {
    "ProfileID"     : "P002",
    "UniqueID"      : "",
    "ReferenceID"   : "NA",
    "BiometricID"   : "1002",
    "Name"          : "Lidiana",
    "Gender"        : "2",
    "DateOfBirth"   : "1979-10-09T00:00:00",
    "Nationality"   : "HONG KONG",
    "Email"         : "xyz@intercorpsolutions.com",
    "Address"       : "1",
    "ContactNo"     : "98765295",
    "EffectiveDate" : "2016-01-01T00:00:00",
	"Org_Details"   : 
        [
            {
		"division_code"     : "sale_Div", 
		"division_desc"     : "sale_Div",
		"department_code"   : "Sales_dept", 
		"department_desc"   : "Sales_dept",
		"category_code"     : "sale_categ", 
		"category_desc"     : "sale_categ",
		"section_code"      : "SUPERVISOR", 
		"section_desc"      : "SUPERVISOR",
		"designation_code"  : "EMPLOYEE", 
		"designation_desc"  : "EMPLOYEE",
		"EffectiveDate"     : "2016-01-01T00:00:00",
		"active"            : "N"
            }
            {
		"division_code"     : "ADMIN", 
		"division_desc"     : "ADMIN",
		"department_code"   : "NA", 
		"department_desc"   : "NA",
		"category_code"     : "NA", 
		"category_desc"     : "NA",
		"section_code"      : "MANAGER", 
		"section_desc"      : "MANAGER",
		"designation_code"  : "EMPLOYEE", 
		"designation_desc"  : "EMPLOYEE",
		"EffectiveDate"     : "2000-03-01T00:00:00",
		"active"            : "Y"
            }
        ],
    "active"            : "Y",
    "CreatedDateTime"   : "2016-01-01T00:00:00",  
    "ModifiedDateTime"  : "2016-01-01T00:00:00",                       
  }
]

Transaction

        You can able to fetch all different site transactions under specific site.

Add Transaction

Transaction
POST/AddTransaction

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"       :type :string,                                                                            
                                "Biometric_ID"      :type: integer,
                                "Auth_DateTime"     :type: string,
                                "Auth_Status"       :type: string,
                                "Photo"             :type: Base64string,
                                "Machine_Num"       :type: integer,
                                "Device_ID"         :type: string,
                                "GPS_Location"      :type: string,
                                "Body_Temp"         :type: decimal,
                                "Is_Abnormal"       :type: string,
                                "Wear_Mask"         :type: string
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Client Code

Biometric_ID
integer (required) Example: 12

BiometricID

Auth_DateTime
string (required) Example: 2020-09-09T13:05:46+08:00

AuthDateTime with Timezone

Auth_Status
string (required) Example: Check-In

Auth_Status Should be 'Check-In' or 'Check-Out'

Photo
Base64string (optional) Example: /9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAoHCBISEhgREhIYEhgZEhQYGBIaGhUcGBkcGBoaGR4ZGBgcIS4mHB4tIxgYJjgmKy8xNzU1GiQ7QD0zPy40NTEBDAwMEA8QGhISHj4kJCs3NDQ0NDQxNTQ9NDQ0NDE0PjQxNDQ0NDQ0MTQ0NDQxNDQ0NDQ0NDQ0PTQ0NDQ0NDQ0NP/AABEIALcBEwMBIgACEQEDEQH/xAAcAAEAAQUBAQAAAAAAAAAAAAAAAQIDBQYHBAj/xABCEAACAQIEAwYDBAYIBwEAAAABAgADEQQSITEFQVEGBxMiYXEygZEjQmKhFLHB0eHwJFJygpKiwvEWMzRDU2OTF//EABkBAQEBAQEBAAAAAAAAAAAAAAACAQMEBf/EACARAQEAAgICAwEBAAAAAAAAAAABAhEDIRIxE0FRIjL/2gAMAwEAAhEDEQA/AOuyZEmAERECYiICTEQEqlMqgIiICIiAiJaqVlX4mA9yBAuxOedrO8enhz4eFy1X5sb5BrbQj4vl9Zq2I718YUCrTpo3/kALD6E2mbV412yJx7B96ld6qZ6aJTLrm0Ytl52IO837s/2sw+MYpTzZlVWIIsBc2tfmY3C41scSkGVTUkRECmIiAkSZEBERAiIiAiIgRERAkRECAkyJMBESYCIiAlURAREQEREDyY/FrRptUchVVSzEmwAE+b+O8Yr4mq71qjXLnS5AA6BdgANJ1rvT4ktOh4BzXcXGW3Jh8V9hOJ4bCPVqCmtySx6+37JFq8YjEPsSbX1B5/P03lo1FU8267zoOD7Bo6DxHOa3LaYviXYSsjfZi4tpzvaTOTF0+LJqoqodiR1/2ntwWKqUXFSk7KwHlZWIPX9m08fFMBUoOFdShNz7y1Srkg62Omg0le50nuXVdd7H95BLJQxaMSSB4/qT95QNBrOqKwIuJ8qLUIN7kfz166Tq/d929zZMJiSfiVUq+5+F/wB/tebLpOWO/Tq8SmVSkEplUQKYiIERJkQEiTIgIiICIiAiIgSIkSYASYiAlUplUBERAREQE8+NxK06bO7BQoJLHYT0Tn/eN2iSmooKC7B0LoM2tvOKflB3AuegEy3TZN1rPePxGnXyMlTMy5jkykELe4Yk7A6TEdhsCGqNVIuQPpeanjuLGrWeowy52JsNhfkPQTcOzlOqmHrZajKpy5VRPtG8t9Gucq+wnLL1Y74e5XR8Ehta0yGS+hE5vw/FV6KeL/SCVqAFGYlWU63GYkH6D3Ey+K7UJiaYTCVHZ8pZiodCqg2Nyy33IFluSegBI4+Onby2xfejwRnVMSikhAwdbagNY5vWxH5zlquFN7fELe06lT4d4lREIxihiiGozqwzHXMAQxA1tqTsdppHbDha4TFHDqS1tS7WBa4BAstgCM3ITvh1048nfbFZ821x1Pra+vWe7h1YoysLXB2tuNb2+UxuHrFWIJuDfWek1AGFtByOnX/eXUR9H9kO0CY/DCqoyMpKPTvcqw9eYIsQfWZ+cg7sMeuHqGm+orlAHGbRtQEPIbmdfjG7iMsdUiIlJJTKpTASJMiAiIgRBiICIiAiIgTEQIExECBVERAREQEREDxcXxy4fD1cQwuKdJ3IG5yKTYfScK7Z43GPWz1qIoq/mOXewTwyt7n+qZ2PtRxejRptRqIarPTb7IW1UggliSABofpOIY+pVxJp0qh8Pw6BALEgsFGwJ3Y6ctd5GVdMZ9tUqL5iNdCd/n/CdL7H4xalIOinyqiVk53UWzr1HpvY+gvzbGU8jMt72ZlJ31BsSDNj7AY8U8U1MkgVF05eZTcD5gmTyTeO3Tjy1lpv/EsYgFqSEudM7qyIn4jnALfK8yBwIpUqL0ArtTp5Apa2dGsWFx966qwPW45mefH0agqI6OvhsDnYqWdTy52KzKYKjTRQVrAkgaKjc97Amwnmj2WfajB4lSwKUmV1IJptlUA76uCRb1W/znL+8xP6SmbzMUZmO1yW39B0HICdSp4aoWNSsy7nIFXKwW2gc31PO3L1nH+3GNNXGOq2IXKg9LdPXedOP/WnLm141rTkE3vvrb1nuvmysoBIUXvbU7TyItjZlv69Nf4T0YRxdgbm66DlfbX856K8mLN9nKhWvTBLKpqL8JIIYag3vysJ9F8IxHiUVcnMbFS2mpUlSdOtp884DC0zlqOPEUOLKC65iwGjaaC9gbEHU22nYu75stN6asTTFWoE1zAea+VSdSBqL85ON7VnP5blEROjiSmVRApiIgRERAiIiAiIgJMiTASZEmAiJVAREQEREBIJkzzY3VCl7ZgRf5QNX7UYhRV0YDPhqqO29l0K3Gmty1tR8RHS/IuLY2piKgqOmYLUTYDUrlSxJ9hces6V2jwYId3bKKbK3hopykrcgkjRRYczrY+lub8UqolIjMue4zILgjYllbMQ9yWFwNtfSccvbtj6a5xBWzsxAGZs1r3tfkTPL4TA5kJuCCpB1BB0t0NxPfxLHtVyXygrTRFyj7qjS/Uz19kcL4uMopfMBUV3H9ghrfUCXE1v3Znj4dVp4ghXyiznRX/cfSbvRemi5iQul76Wmr8b7OKjFQNL5kP4W2+m3ymKxlB0TKBfSeO3Vse2f1Ir7a9t1pqaWF87kEeJ91epHUzltEE+ZiSc2YsT63ufXf6zYu0HB6tFRUqrlLi6IdCR1t0mtJc+tvfWenjmpt5uW7qRUBcjcG+nqZdpUmDAAX632vKMKgY8lO535a6S/wA7LvzO8u1GMbnwThgYkVLEIUuVDKbvsQSctx5fK39a/LXpPYai4Ry3mTP5H0tcXz5QNAL2BtoSpM0LsPXpmoqVF/7gZ25Hf6A6fSdgwWFpob07BTrkFst78hy32kYzd2rO6mnuQ6SqInZwIiIFMRECIiICRJkQEREBJkSYCTIEmAlUpEqgIiICIiAmP4tUK0zlJBtfNZdBublvKNAdTMhOd973aBaOE/REb7WrYm1rqga5v0zFcvqM0ytjVOM9ssudaf2rMxtUbKFsFVCUK6kHL0GlxzJnPsXiy58wGttBfpbQy3Vq6DckW3t8/wBs8ijzZh129D/vJmP66XL8XVcgjKDcG9513ur7MXojH1PifOqD8KsFvb3VtehE5MF1n1BwvDrQw1KiiFVSkiBWIuAABrbczpI5W2rfEcIKtMD74BynTX8Jv1tLPCuColqlTK78hbyr9dzMyqaW9J4qpamxqL8NrunX8Q/F+uRcMbl5KmeUx8duT989UGvSRdWSi7MOgdlAPp8JnNgpC5V00vf+M3/vQq06tdcRSBa58JmJXK2QsbKt76EMDcC9poDVMtgLX689f1TL7XOouU1Cak7CX8ONQAL7aDS/8Z4XuBr89zeTh3OgO37uV403beOA4WpSxKKBvY+a1iNCR0bfady4blNNLEHyjUbbT564dxSoyqjsXRSbKb5lBtcK2/LbbQaTu/Z3DtSp+EVIC/CSVN1+X86yceq3k7xjNxETq4IMmIgUxEQIiTIgJEmRAREQJEQIgBJiICVSmVQEREBERACfM/bbi7YrHVqpGX7UoE6LTOVT72W59SZ9FcbxngYWtX5pQqOPdVJA+tp8rYpyWLHe+p6+8CiqdPoJaI/VLlTcD1/fJtNGa7MYPx8bhqQ+/Xp3/sqwdv8AKrT6W3a3ScM7n8J4nEPEI0pUnb5tZB+TN9J3SkNCes1ittNfylmolxaXHO0qcTBwnvUwq0MUADo4dwn3VJIuQOVzrNDAAKk6+nttebz3wVc/EsnJMPTHzLO37RNEDg8ue/X2k3Fcy37XGYXsbnTc2/KVIR8pQ7EjMTvp7bbQNdtIkblkymAYg9NOs+h+zfEv0mktQJlGRLWbMLMoa17CzC4BE+bKQ11M+guwGDC8Pwz5MpKFidybs1t/hFrGw3/Xnjq7ZctzTbYkCTKSREQEplUpgJEmQYCDEGBERECRECICTIEmAlUplUBERAREs4zEeHTeoRfIjPbrlUtb8oHO+97tBUo0lwSZftqbtUJBzBVZcoXXS5DX30E4dWa97zL8f41XxtY18Q+ZyTYD4UXkiDko1+pJ1MxLazRSDcj2MuSwh29jLwPX8oHVu5DD/wDVVPTDoD/9Cf1rOvLsBOYdxyj9FxDcziVB9gi2/WZ062s1ilj5xK2GsoZbm/rLoNoHzp3n1CeK4kH7ppqPbw0P+ozUCtrAep+k33vS4ZUbi7rTRnaslJ1VRvZch9rZNSdpR/wbhsIgrcQxIH/pTQn0B+In2A2kXKT2vHDK+mjWJPoPzl9VmR49xDC1nQYTDrhadNMo/rub3LOSSTyAuTz6zHgm1x5v55Som9V6sFTuwFwLkC5tYX5k8hPpzg9MJQSmoGRERUYbMqqAGHvPn3sdhaVfF0EcZkasqsmuuuxn0dTQKAqgAAAADQADQADkIoqiImBERASmIgJBkyDAQYgwIiIgSIkSYASZEmAEqlIlUBERATE9qMVTpYLEVKhsooVBvYkspUAepJAmWnLe+56vg4dFNqZqVS63tdlChb9QAz/P5QONVqgLdJbYybjbb6S2y8hpc29NZoqwmFqVXyUkaox2VQSf4D1mz/8AAXEQgfw0JtfIHXOPTXS/zm59iMDToUxlADMBd+be5m4ZtNDPPlzXfT048M121juaWrQGKw9am9Mh6LgOpF8yupt1+AajrOmDEqtyzAAA2vv/ABmseIRre3rFTEMwsWvabOefcTeC/VbQKtxm66y3WxiopJNgASZgBxKoNBl+n8ZarVWqDK2x3tNvNNdE4Mt9rWKAqVjXIAcoEBG4QEta521JJ+XSY4Yvh9OplqvTaqfuFc7fLczGdrePpg2XDlGctTz3VgOZAV+dtOU1Fu3eL/7VOjQsLWVNfckmx+k5zHLO7rteTDCeMb1xDtFhMGjvmFOuELU6TYdgWJ0XytlspI39+k5NiMU9eo9Soczu7Ox5FmNzaRxDG1sTUNas5qO1ru25toB6AdJ5VNvTqP2z0Y46mnl5M/K7bJ2HJXieGKg3NdAV6i/7P2T6RnLu6zswpCcTqMGJV1pILG2pVnb8WjKB6k9LdRlVBERMCIiBTERASIiAkSZEBERASYEQAkyJMAJVKZVAREQE5H35Y0/0fDCwAFSqzc9wiqPQ+b6CdcnH+/aj58G4G4rqzcjlNMqp/wATn69IHJFtOn9juzmFFBalemtV3AbzgEIDsqg+m56zmB2nZeBurYemw2NND/lE482Vkmnfgxlyu3uq8IolbUyadhoFOg/um4/KY1sXXwzWqjxE5VUB8v8AbXW3uNPaZlagEl6oPKeWV7Fmjiw4DKQwIuCDcH2lwVZiMRgfDY1KHk1u1P7jetuR9RLmHxyvowKn1le0soHl5GmOv63ktisguToBeYpzTtzi/Exz63yBEH90XP5sZrwbc9LH+fpLmJxBqVHqHd6jv/iYn9soQb/Ke/Gakj5uV3lauiVCkWNgpY20CgknlYAb7y5w7DNUdKaC7NUCLfQXYgC55fEJ9A9i+xlHhqs+Y1azgB6h0Cjcqg5LfXXU2HQAal5u6rhtfDcNRMQGVnqO6owIZVa1gwOxNi1vxTc4iY0iIgJTKpTAREQIiIgJEmRAREQEmRJgJMiIExECBVERATC9q+AU+IYVsO9g1i1Opa5RwCFcempBHMEzNRA+eK/dhxZSbUEex3WrTsfUBiD9QJksHTx3DqI/TcM9KktlFXyMovsDkYmd1nGe9/jnj1f0JG8lEXcjnUcbf3UP1c9JOWMymqrHK43cWV7Y4MDWsP8AC/7pcodssK7rTpZqrsbKio1yfmBOVuoLbeg9hpPbwfi7YOr4iIrMMupuLWNyBbkbAGR8OLp8+TtdLC4ioQPDVLi9ndQfoLkycbwuoq5UXxHO9rBB8zNEwPebkLFsAjhr3+0Oa/LzMhnv/wD1xreTABRz+15+lklTjxiby5VsmD4BXX/mVLX5aWEv4ngFRqbBaii6sPMCLXFtxNMrd67kf9GnzqMf9EwPEu8TGVtMlOmLWsFYke12t+U28eP4ycuX6wPE8C+FqGlUKlhzUkr8iQJZo1VPOU4/GPXbO9gbWsBYadB8zPPQ3loZnAYo06tN9gro9vVWvr9J9UKwIBGxAI+c+S3NiP7In0T3bcc/S8AmY3elam3UgDyt81sPdTFG2xETAiIgJSZVKTAREgwERECIiICIiAkiRECZMRAQIiBVERAREQMR2p4yMDhKuJIuUWyrrYsxyoD6ZiL+k+b8XWZyWZizMS7MdyznMSZETYPANLt0WeFdTeIgXEMqiIEmWXWIiith5V+en8+8qoJEQx6a249h+qdA7oeLmjjFon4K6shH4lBqK35OP70mJo7rERJaREQEpiICREQEGREBERAREQP/2Q==

Base64String of Image

Machine_Num
integer (optional) Example: 36

Machine Number

Device_ID
string (optional) Example: D006

Device ID

GPS_Location
string (optional) Example: Y

GPS Location

Body_Temp
decimal (optional) Example: 37.05

Body Temperature

Is_Abnormal
string (optional) Example: N

Is_Abnormal should be 'Y' or 'N'

Wear_Mask
string (optional) Example: Y

Wear_Mask should be 'Y' or 'N'

Response 200
Content-Type: application/json
[
    {
        "Status"            :type: string,                        
        "Message"           :type: string,
        "Transaction_ID"    :type: integer
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"       :"ICS",    
    "Biometric_ID"      :12,
    "Auth_DateTime"     :"2020-09-09T13:05:46+08:00",
    "Auth_Status"       :"Check-In",
    "Photo"             :"/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAoHCBISEhgREhIYEhgZEhQYGBIaGhUcGBkcGBoaGR4ZGBgcIS4mHB4tIxgYJjgmKy8xNzU1GiQ7QD0zPy40NTEBDAwMEA8QGhISHj4kJCs3NDQ0NDQxNTQ9NDQ0NDE0PjQxNDQ0NDQ0MTQ0NDQxNDQ0NDQ0NDQ0PTQ0NDQ0NDQ0NP/AABEIALcBEwMBIgACEQEDEQH/xAAcAAEAAQUBAQAAAAAAAAAAAAAAAQIDBQYHBAj/xABCEAACAQIEAwYDBAYIBwEAAAABAgADEQQSITEFQVEGBxMiYXEygZEjQmKhFLHB0eHwJFJygpKiwvEWMzRDU2OTF//EABkBAQEBAQEBAAAAAAAAAAAAAAACAQMEBf/EACARAQEAAgICAwEBAAAAAAAAAAABAhEDIRIxE0FRIjL/2gAMAwEAAhEDEQA/AOuyZEmAERECYiICTEQEqlMqgIiICIiAiJaqVlX4mA9yBAuxOedrO8enhz4eFy1X5sb5BrbQj4vl9Zq2I718YUCrTpo3/kALD6E2mbV412yJx7B96ld6qZ6aJTLrm0Ytl52IO837s/2sw+MYpTzZlVWIIsBc2tfmY3C41scSkGVTUkRECmIiAkSZEBERAiIiAiIgRERAkRECAkyJMBESYCIiAlURAREQEREDyY/FrRptUchVVSzEmwAE+b+O8Yr4mq71qjXLnS5AA6BdgANJ1rvT4ktOh4BzXcXGW3Jh8V9hOJ4bCPVqCmtySx6+37JFq8YjEPsSbX1B5/P03lo1FU8267zoOD7Bo6DxHOa3LaYviXYSsjfZi4tpzvaTOTF0+LJqoqodiR1/2ntwWKqUXFSk7KwHlZWIPX9m08fFMBUoOFdShNz7y1Srkg62Omg0le50nuXVdd7H95BLJQxaMSSB4/qT95QNBrOqKwIuJ8qLUIN7kfz166Tq/d929zZMJiSfiVUq+5+F/wB/tebLpOWO/Tq8SmVSkEplUQKYiIERJkQEiTIgIiICIiAiIgSIkSYASYiAlUplUBERAREQE8+NxK06bO7BQoJLHYT0Tn/eN2iSmooKC7B0LoM2tvOKflB3AuegEy3TZN1rPePxGnXyMlTMy5jkykELe4Yk7A6TEdhsCGqNVIuQPpeanjuLGrWeowy52JsNhfkPQTcOzlOqmHrZajKpy5VRPtG8t9Gucq+wnLL1Y74e5XR8Ehta0yGS+hE5vw/FV6KeL/SCVqAFGYlWU63GYkH6D3Ey+K7UJiaYTCVHZ8pZiodCqg2Nyy33IFluSegBI4+Onby2xfejwRnVMSikhAwdbagNY5vWxH5zlquFN7fELe06lT4d4lREIxihiiGozqwzHXMAQxA1tqTsdppHbDha4TFHDqS1tS7WBa4BAstgCM3ITvh1048nfbFZ821x1Pra+vWe7h1YoysLXB2tuNb2+UxuHrFWIJuDfWek1AGFtByOnX/eXUR9H9kO0CY/DCqoyMpKPTvcqw9eYIsQfWZ+cg7sMeuHqGm+orlAHGbRtQEPIbmdfjG7iMsdUiIlJJTKpTASJMiAiIgRBiICIiAiIgTEQIExECBVERAREQEREDxcXxy4fD1cQwuKdJ3IG5yKTYfScK7Z43GPWz1qIoq/mOXewTwyt7n+qZ2PtRxejRptRqIarPTb7IW1UggliSABofpOIY+pVxJp0qh8Pw6BALEgsFGwJ3Y6ctd5GVdMZ9tUqL5iNdCd/n/CdL7H4xalIOinyqiVk53UWzr1HpvY+gvzbGU8jMt72ZlJ31BsSDNj7AY8U8U1MkgVF05eZTcD5gmTyTeO3Tjy1lpv/EsYgFqSEudM7qyIn4jnALfK8yBwIpUqL0ArtTp5Apa2dGsWFx966qwPW45mefH0agqI6OvhsDnYqWdTy52KzKYKjTRQVrAkgaKjc97Amwnmj2WfajB4lSwKUmV1IJptlUA76uCRb1W/znL+8xP6SmbzMUZmO1yW39B0HICdSp4aoWNSsy7nIFXKwW2gc31PO3L1nH+3GNNXGOq2IXKg9LdPXedOP/WnLm141rTkE3vvrb1nuvmysoBIUXvbU7TyItjZlv69Nf4T0YRxdgbm66DlfbX856K8mLN9nKhWvTBLKpqL8JIIYag3vysJ9F8IxHiUVcnMbFS2mpUlSdOtp884DC0zlqOPEUOLKC65iwGjaaC9gbEHU22nYu75stN6asTTFWoE1zAea+VSdSBqL85ON7VnP5blEROjiSmVRApiIgRERAiIiAiIgJMiTASZEmAiJVAREQEREBIJkzzY3VCl7ZgRf5QNX7UYhRV0YDPhqqO29l0K3Gmty1tR8RHS/IuLY2piKgqOmYLUTYDUrlSxJ9hces6V2jwYId3bKKbK3hopykrcgkjRRYczrY+lub8UqolIjMue4zILgjYllbMQ9yWFwNtfSccvbtj6a5xBWzsxAGZs1r3tfkTPL4TA5kJuCCpB1BB0t0NxPfxLHtVyXygrTRFyj7qjS/Uz19kcL4uMopfMBUV3H9ghrfUCXE1v3Znj4dVp4ghXyiznRX/cfSbvRemi5iQul76Wmr8b7OKjFQNL5kP4W2+m3ymKxlB0TKBfSeO3Vse2f1Ir7a9t1pqaWF87kEeJ91epHUzltEE+ZiSc2YsT63ufXf6zYu0HB6tFRUqrlLi6IdCR1t0mtJc+tvfWenjmpt5uW7qRUBcjcG+nqZdpUmDAAX632vKMKgY8lO535a6S/wA7LvzO8u1GMbnwThgYkVLEIUuVDKbvsQSctx5fK39a/LXpPYai4Ry3mTP5H0tcXz5QNAL2BtoSpM0LsPXpmoqVF/7gZ25Hf6A6fSdgwWFpob07BTrkFst78hy32kYzd2rO6mnuQ6SqInZwIiIFMRECIiICRJkQEREBJkSYCTIEmAlUpEqgIiICIiAmP4tUK0zlJBtfNZdBublvKNAdTMhOd973aBaOE/REb7WrYm1rqga5v0zFcvqM0ytjVOM9ssudaf2rMxtUbKFsFVCUK6kHL0GlxzJnPsXiy58wGttBfpbQy3Vq6DckW3t8/wBs8ijzZh129D/vJmP66XL8XVcgjKDcG9513ur7MXojH1PifOqD8KsFvb3VtehE5MF1n1BwvDrQw1KiiFVSkiBWIuAABrbczpI5W2rfEcIKtMD74BynTX8Jv1tLPCuColqlTK78hbyr9dzMyqaW9J4qpamxqL8NrunX8Q/F+uRcMbl5KmeUx8duT989UGvSRdWSi7MOgdlAPp8JnNgpC5V00vf+M3/vQq06tdcRSBa58JmJXK2QsbKt76EMDcC9poDVMtgLX689f1TL7XOouU1Cak7CX8ONQAL7aDS/8Z4XuBr89zeTh3OgO37uV403beOA4WpSxKKBvY+a1iNCR0bfady4blNNLEHyjUbbT564dxSoyqjsXRSbKb5lBtcK2/LbbQaTu/Z3DtSp+EVIC/CSVN1+X86yceq3k7xjNxETq4IMmIgUxEQIiTIgJEmRAREQJEQIgBJiICVSmVQEREBERACfM/bbi7YrHVqpGX7UoE6LTOVT72W59SZ9FcbxngYWtX5pQqOPdVJA+tp8rYpyWLHe+p6+8CiqdPoJaI/VLlTcD1/fJtNGa7MYPx8bhqQ+/Xp3/sqwdv8AKrT6W3a3ScM7n8J4nEPEI0pUnb5tZB+TN9J3SkNCes1ittNfylmolxaXHO0qcTBwnvUwq0MUADo4dwn3VJIuQOVzrNDAAKk6+nttebz3wVc/EsnJMPTHzLO37RNEDg8ue/X2k3Fcy37XGYXsbnTc2/KVIR8pQ7EjMTvp7bbQNdtIkblkymAYg9NOs+h+zfEv0mktQJlGRLWbMLMoa17CzC4BE+bKQ11M+guwGDC8Pwz5MpKFidybs1t/hFrGw3/Xnjq7ZctzTbYkCTKSREQEplUpgJEmQYCDEGBERECRECICTIEmAlUplUBERAREs4zEeHTeoRfIjPbrlUtb8oHO+97tBUo0lwSZftqbtUJBzBVZcoXXS5DX30E4dWa97zL8f41XxtY18Q+ZyTYD4UXkiDko1+pJ1MxLazRSDcj2MuSwh29jLwPX8oHVu5DD/wDVVPTDoD/9Cf1rOvLsBOYdxyj9FxDcziVB9gi2/WZ062s1ilj5xK2GsoZbm/rLoNoHzp3n1CeK4kH7ppqPbw0P+ozUCtrAep+k33vS4ZUbi7rTRnaslJ1VRvZch9rZNSdpR/wbhsIgrcQxIH/pTQn0B+In2A2kXKT2vHDK+mjWJPoPzl9VmR49xDC1nQYTDrhadNMo/rub3LOSSTyAuTz6zHgm1x5v55Som9V6sFTuwFwLkC5tYX5k8hPpzg9MJQSmoGRERUYbMqqAGHvPn3sdhaVfF0EcZkasqsmuuuxn0dTQKAqgAAAADQADQADkIoqiImBERASmIgJBkyDAQYgwIiIgSIkSYASZEmAEqlIlUBERATE9qMVTpYLEVKhsooVBvYkspUAepJAmWnLe+56vg4dFNqZqVS63tdlChb9QAz/P5QONVqgLdJbYybjbb6S2y8hpc29NZoqwmFqVXyUkaox2VQSf4D1mz/8AAXEQgfw0JtfIHXOPTXS/zm59iMDToUxlADMBd+be5m4ZtNDPPlzXfT048M121juaWrQGKw9am9Mh6LgOpF8yupt1+AajrOmDEqtyzAAA2vv/ABmseIRre3rFTEMwsWvabOefcTeC/VbQKtxm66y3WxiopJNgASZgBxKoNBl+n8ZarVWqDK2x3tNvNNdE4Mt9rWKAqVjXIAcoEBG4QEta521JJ+XSY4Yvh9OplqvTaqfuFc7fLczGdrePpg2XDlGctTz3VgOZAV+dtOU1Fu3eL/7VOjQsLWVNfckmx+k5zHLO7rteTDCeMb1xDtFhMGjvmFOuELU6TYdgWJ0XytlspI39+k5NiMU9eo9Soczu7Ox5FmNzaRxDG1sTUNas5qO1ru25toB6AdJ5VNvTqP2z0Y46mnl5M/K7bJ2HJXieGKg3NdAV6i/7P2T6RnLu6zswpCcTqMGJV1pILG2pVnb8WjKB6k9LdRlVBERMCIiBTERASIiAkSZEBERASYEQAkyJMAJVKZVAREQE5H35Y0/0fDCwAFSqzc9wiqPQ+b6CdcnH+/aj58G4G4rqzcjlNMqp/wATn69IHJFtOn9juzmFFBalemtV3AbzgEIDsqg+m56zmB2nZeBurYemw2NND/lE482Vkmnfgxlyu3uq8IolbUyadhoFOg/um4/KY1sXXwzWqjxE5VUB8v8AbXW3uNPaZlagEl6oPKeWV7Fmjiw4DKQwIuCDcH2lwVZiMRgfDY1KHk1u1P7jetuR9RLmHxyvowKn1le0soHl5GmOv63ktisguToBeYpzTtzi/Exz63yBEH90XP5sZrwbc9LH+fpLmJxBqVHqHd6jv/iYn9soQb/Ke/Gakj5uV3lauiVCkWNgpY20CgknlYAb7y5w7DNUdKaC7NUCLfQXYgC55fEJ9A9i+xlHhqs+Y1azgB6h0Cjcqg5LfXXU2HQAal5u6rhtfDcNRMQGVnqO6owIZVa1gwOxNi1vxTc4iY0iIgJTKpTAREQIiIgJEmRAREQEmRJgJMiIExECBVERATC9q+AU+IYVsO9g1i1Opa5RwCFcempBHMEzNRA+eK/dhxZSbUEex3WrTsfUBiD9QJksHTx3DqI/TcM9KktlFXyMovsDkYmd1nGe9/jnj1f0JG8lEXcjnUcbf3UP1c9JOWMymqrHK43cWV7Y4MDWsP8AC/7pcodssK7rTpZqrsbKio1yfmBOVuoLbeg9hpPbwfi7YOr4iIrMMupuLWNyBbkbAGR8OLp8+TtdLC4ioQPDVLi9ndQfoLkycbwuoq5UXxHO9rBB8zNEwPebkLFsAjhr3+0Oa/LzMhnv/wD1xreTABRz+15+lklTjxiby5VsmD4BXX/mVLX5aWEv4ngFRqbBaii6sPMCLXFtxNMrd67kf9GnzqMf9EwPEu8TGVtMlOmLWsFYke12t+U28eP4ycuX6wPE8C+FqGlUKlhzUkr8iQJZo1VPOU4/GPXbO9gbWsBYadB8zPPQ3loZnAYo06tN9gro9vVWvr9J9UKwIBGxAI+c+S3NiP7In0T3bcc/S8AmY3elam3UgDyt81sPdTFG2xETAiIgJSZVKTAREgwERECIiICIiAkiRECZMRAQIiBVERAREQMR2p4yMDhKuJIuUWyrrYsxyoD6ZiL+k+b8XWZyWZizMS7MdyznMSZETYPANLt0WeFdTeIgXEMqiIEmWXWIiith5V+en8+8qoJEQx6a249h+qdA7oeLmjjFon4K6shH4lBqK35OP70mJo7rERJaREQEpiICREQEGREBERAREQP/2Q==",
    "Machine_Num"       :36,
    "Device_ID"         :"D006",
    "GPS_Location"      :"Y",
    "Body_Temp"         :37.05,
    "Is_Abnormal"       :"Y",
    "Wear_Mask"         :"Y"
}
Response 200
Content-Type: application/json
[
    {
        "Status"            : "Success",
        "Message"           : "Record added successfully",
        "Transaction_ID"    : 85
    }
]

Edit Transaction

Transaction
PUT/EditTransaction

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"       :type: string,                                                                            
                                "Biometric_ID"      :type: integer,
                                "Transaction_ID"    :type: integer,
                                "Auth_DateTime"     :type: string,
                                "Auth_Status"       :type: string,
                                "Photo"             :type: Base64string,                                
                                "Machine_Num"       :type: integer,
                                "Device_ID"         :type: string,
                                "GPS_Location"      :type: string,
                                "Body_Temp"         :type: decimal,
                                "Is_Abnormal"       :type: string,
                                "Wear_Mask"         :type: string
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Client Code

Biometric_ID
integer (required) Example: 12

BiometricID

Transaction_ID
integer (required) Example: 85

Transaction ID

Auth_DateTime
string (required) Example: 2020-09-09T13:05:46+08:00

AuthDateTime with Timezone

Auth_Status
string (required) Example: Check-In

Auth_Status Should be 'Check-In' or 'Check-Out'

Photo
Base64string (optional) Example: /9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAoHCBISEhgREhIYEhgZEhQYGBIaGhUcGBkcGBoaGR4ZGBgcIS4mHB4tIxgYJjgmKy8xNzU1GiQ7QD0zPy40NTEBDAwMEA8QGhISHj4kJCs3NDQ0NDQxNTQ9NDQ0NDE0PjQxNDQ0NDQ0MTQ0NDQxNDQ0NDQ0NDQ0PTQ0NDQ0NDQ0NP/AABEIALcBEwMBIgACEQEDEQH/xAAcAAEAAQUBAQAAAAAAAAAAAAAAAQIDBQYHBAj/xABCEAACAQIEAwYDBAYIBwEAAAABAgADEQQSITEFQVEGBxMiYXEygZEjQmKhFLHB0eHwJFJygpKiwvEWMzRDU2OTF//EABkBAQEBAQEBAAAAAAAAAAAAAAACAQMEBf/EACARAQEAAgICAwEBAAAAAAAAAAABAhEDIRIxE0FRIjL/2gAMAwEAAhEDEQA/AOuyZEmAERECYiICTEQEqlMqgIiICIiAiJaqVlX4mA9yBAuxOedrO8enhz4eFy1X5sb5BrbQj4vl9Zq2I718YUCrTpo3/kALD6E2mbV412yJx7B96ld6qZ6aJTLrm0Ytl52IO837s/2sw+MYpTzZlVWIIsBc2tfmY3C41scSkGVTUkRECmIiAkSZEBERAiIiAiIgRERAkRECAkyJMBESYCIiAlURAREQEREDyY/FrRptUchVVSzEmwAE+b+O8Yr4mq71qjXLnS5AA6BdgANJ1rvT4ktOh4BzXcXGW3Jh8V9hOJ4bCPVqCmtySx6+37JFq8YjEPsSbX1B5/P03lo1FU8267zoOD7Bo6DxHOa3LaYviXYSsjfZi4tpzvaTOTF0+LJqoqodiR1/2ntwWKqUXFSk7KwHlZWIPX9m08fFMBUoOFdShNz7y1Srkg62Omg0le50nuXVdd7H95BLJQxaMSSB4/qT95QNBrOqKwIuJ8qLUIN7kfz166Tq/d929zZMJiSfiVUq+5+F/wB/tebLpOWO/Tq8SmVSkEplUQKYiIERJkQEiTIgIiICIiAiIgSIkSYASYiAlUplUBERAREQE8+NxK06bO7BQoJLHYT0Tn/eN2iSmooKC7B0LoM2tvOKflB3AuegEy3TZN1rPePxGnXyMlTMy5jkykELe4Yk7A6TEdhsCGqNVIuQPpeanjuLGrWeowy52JsNhfkPQTcOzlOqmHrZajKpy5VRPtG8t9Gucq+wnLL1Y74e5XR8Ehta0yGS+hE5vw/FV6KeL/SCVqAFGYlWU63GYkH6D3Ey+K7UJiaYTCVHZ8pZiodCqg2Nyy33IFluSegBI4+Onby2xfejwRnVMSikhAwdbagNY5vWxH5zlquFN7fELe06lT4d4lREIxihiiGozqwzHXMAQxA1tqTsdppHbDha4TFHDqS1tS7WBa4BAstgCM3ITvh1048nfbFZ821x1Pra+vWe7h1YoysLXB2tuNb2+UxuHrFWIJuDfWek1AGFtByOnX/eXUR9H9kO0CY/DCqoyMpKPTvcqw9eYIsQfWZ+cg7sMeuHqGm+orlAHGbRtQEPIbmdfjG7iMsdUiIlJJTKpTASJMiAiIgRBiICIiAiIgTEQIExECBVERAREQEREDxcXxy4fD1cQwuKdJ3IG5yKTYfScK7Z43GPWz1qIoq/mOXewTwyt7n+qZ2PtRxejRptRqIarPTb7IW1UggliSABofpOIY+pVxJp0qh8Pw6BALEgsFGwJ3Y6ctd5GVdMZ9tUqL5iNdCd/n/CdL7H4xalIOinyqiVk53UWzr1HpvY+gvzbGU8jMt72ZlJ31BsSDNj7AY8U8U1MkgVF05eZTcD5gmTyTeO3Tjy1lpv/EsYgFqSEudM7qyIn4jnALfK8yBwIpUqL0ArtTp5Apa2dGsWFx966qwPW45mefH0agqI6OvhsDnYqWdTy52KzKYKjTRQVrAkgaKjc97Amwnmj2WfajB4lSwKUmV1IJptlUA76uCRb1W/znL+8xP6SmbzMUZmO1yW39B0HICdSp4aoWNSsy7nIFXKwW2gc31PO3L1nH+3GNNXGOq2IXKg9LdPXedOP/WnLm141rTkE3vvrb1nuvmysoBIUXvbU7TyItjZlv69Nf4T0YRxdgbm66DlfbX856K8mLN9nKhWvTBLKpqL8JIIYag3vysJ9F8IxHiUVcnMbFS2mpUlSdOtp884DC0zlqOPEUOLKC65iwGjaaC9gbEHU22nYu75stN6asTTFWoE1zAea+VSdSBqL85ON7VnP5blEROjiSmVRApiIgRERAiIiAiIgJMiTASZEmAiJVAREQEREBIJkzzY3VCl7ZgRf5QNX7UYhRV0YDPhqqO29l0K3Gmty1tR8RHS/IuLY2piKgqOmYLUTYDUrlSxJ9hces6V2jwYId3bKKbK3hopykrcgkjRRYczrY+lub8UqolIjMue4zILgjYllbMQ9yWFwNtfSccvbtj6a5xBWzsxAGZs1r3tfkTPL4TA5kJuCCpB1BB0t0NxPfxLHtVyXygrTRFyj7qjS/Uz19kcL4uMopfMBUV3H9ghrfUCXE1v3Znj4dVp4ghXyiznRX/cfSbvRemi5iQul76Wmr8b7OKjFQNL5kP4W2+m3ymKxlB0TKBfSeO3Vse2f1Ir7a9t1pqaWF87kEeJ91epHUzltEE+ZiSc2YsT63ufXf6zYu0HB6tFRUqrlLi6IdCR1t0mtJc+tvfWenjmpt5uW7qRUBcjcG+nqZdpUmDAAX632vKMKgY8lO535a6S/wA7LvzO8u1GMbnwThgYkVLEIUuVDKbvsQSctx5fK39a/LXpPYai4Ry3mTP5H0tcXz5QNAL2BtoSpM0LsPXpmoqVF/7gZ25Hf6A6fSdgwWFpob07BTrkFst78hy32kYzd2rO6mnuQ6SqInZwIiIFMRECIiICRJkQEREBJkSYCTIEmAlUpEqgIiICIiAmP4tUK0zlJBtfNZdBublvKNAdTMhOd973aBaOE/REb7WrYm1rqga5v0zFcvqM0ytjVOM9ssudaf2rMxtUbKFsFVCUK6kHL0GlxzJnPsXiy58wGttBfpbQy3Vq6DckW3t8/wBs8ijzZh129D/vJmP66XL8XVcgjKDcG9513ur7MXojH1PifOqD8KsFvb3VtehE5MF1n1BwvDrQw1KiiFVSkiBWIuAABrbczpI5W2rfEcIKtMD74BynTX8Jv1tLPCuColqlTK78hbyr9dzMyqaW9J4qpamxqL8NrunX8Q/F+uRcMbl5KmeUx8duT989UGvSRdWSi7MOgdlAPp8JnNgpC5V00vf+M3/vQq06tdcRSBa58JmJXK2QsbKt76EMDcC9poDVMtgLX689f1TL7XOouU1Cak7CX8ONQAL7aDS/8Z4XuBr89zeTh3OgO37uV403beOA4WpSxKKBvY+a1iNCR0bfady4blNNLEHyjUbbT564dxSoyqjsXRSbKb5lBtcK2/LbbQaTu/Z3DtSp+EVIC/CSVN1+X86yceq3k7xjNxETq4IMmIgUxEQIiTIgJEmRAREQJEQIgBJiICVSmVQEREBERACfM/bbi7YrHVqpGX7UoE6LTOVT72W59SZ9FcbxngYWtX5pQqOPdVJA+tp8rYpyWLHe+p6+8CiqdPoJaI/VLlTcD1/fJtNGa7MYPx8bhqQ+/Xp3/sqwdv8AKrT6W3a3ScM7n8J4nEPEI0pUnb5tZB+TN9J3SkNCes1ittNfylmolxaXHO0qcTBwnvUwq0MUADo4dwn3VJIuQOVzrNDAAKk6+nttebz3wVc/EsnJMPTHzLO37RNEDg8ue/X2k3Fcy37XGYXsbnTc2/KVIR8pQ7EjMTvp7bbQNdtIkblkymAYg9NOs+h+zfEv0mktQJlGRLWbMLMoa17CzC4BE+bKQ11M+guwGDC8Pwz5MpKFidybs1t/hFrGw3/Xnjq7ZctzTbYkCTKSREQEplUpgJEmQYCDEGBERECRECICTIEmAlUplUBERAREs4zEeHTeoRfIjPbrlUtb8oHO+97tBUo0lwSZftqbtUJBzBVZcoXXS5DX30E4dWa97zL8f41XxtY18Q+ZyTYD4UXkiDko1+pJ1MxLazRSDcj2MuSwh29jLwPX8oHVu5DD/wDVVPTDoD/9Cf1rOvLsBOYdxyj9FxDcziVB9gi2/WZ062s1ilj5xK2GsoZbm/rLoNoHzp3n1CeK4kH7ppqPbw0P+ozUCtrAep+k33vS4ZUbi7rTRnaslJ1VRvZch9rZNSdpR/wbhsIgrcQxIH/pTQn0B+In2A2kXKT2vHDK+mjWJPoPzl9VmR49xDC1nQYTDrhadNMo/rub3LOSSTyAuTz6zHgm1x5v55Som9V6sFTuwFwLkC5tYX5k8hPpzg9MJQSmoGRERUYbMqqAGHvPn3sdhaVfF0EcZkasqsmuuuxn0dTQKAqgAAAADQADQADkIoqiImBERASmIgJBkyDAQYgwIiIgSIkSYASZEmAEqlIlUBERATE9qMVTpYLEVKhsooVBvYkspUAepJAmWnLe+56vg4dFNqZqVS63tdlChb9QAz/P5QONVqgLdJbYybjbb6S2y8hpc29NZoqwmFqVXyUkaox2VQSf4D1mz/8AAXEQgfw0JtfIHXOPTXS/zm59iMDToUxlADMBd+be5m4ZtNDPPlzXfT048M121juaWrQGKw9am9Mh6LgOpF8yupt1+AajrOmDEqtyzAAA2vv/ABmseIRre3rFTEMwsWvabOefcTeC/VbQKtxm66y3WxiopJNgASZgBxKoNBl+n8ZarVWqDK2x3tNvNNdE4Mt9rWKAqVjXIAcoEBG4QEta521JJ+XSY4Yvh9OplqvTaqfuFc7fLczGdrePpg2XDlGctTz3VgOZAV+dtOU1Fu3eL/7VOjQsLWVNfckmx+k5zHLO7rteTDCeMb1xDtFhMGjvmFOuELU6TYdgWJ0XytlspI39+k5NiMU9eo9Soczu7Ox5FmNzaRxDG1sTUNas5qO1ru25toB6AdJ5VNvTqP2z0Y46mnl5M/K7bJ2HJXieGKg3NdAV6i/7P2T6RnLu6zswpCcTqMGJV1pILG2pVnb8WjKB6k9LdRlVBERMCIiBTERASIiAkSZEBERASYEQAkyJMAJVKZVAREQE5H35Y0/0fDCwAFSqzc9wiqPQ+b6CdcnH+/aj58G4G4rqzcjlNMqp/wATn69IHJFtOn9juzmFFBalemtV3AbzgEIDsqg+m56zmB2nZeBurYemw2NND/lE482Vkmnfgxlyu3uq8IolbUyadhoFOg/um4/KY1sXXwzWqjxE5VUB8v8AbXW3uNPaZlagEl6oPKeWV7Fmjiw4DKQwIuCDcH2lwVZiMRgfDY1KHk1u1P7jetuR9RLmHxyvowKn1le0soHl5GmOv63ktisguToBeYpzTtzi/Exz63yBEH90XP5sZrwbc9LH+fpLmJxBqVHqHd6jv/iYn9soQb/Ke/Gakj5uV3lauiVCkWNgpY20CgknlYAb7y5w7DNUdKaC7NUCLfQXYgC55fEJ9A9i+xlHhqs+Y1azgB6h0Cjcqg5LfXXU2HQAal5u6rhtfDcNRMQGVnqO6owIZVa1gwOxNi1vxTc4iY0iIgJTKpTAREQIiIgJEmRAREQEmRJgJMiIExECBVERATC9q+AU+IYVsO9g1i1Opa5RwCFcempBHMEzNRA+eK/dhxZSbUEex3WrTsfUBiD9QJksHTx3DqI/TcM9KktlFXyMovsDkYmd1nGe9/jnj1f0JG8lEXcjnUcbf3UP1c9JOWMymqrHK43cWV7Y4MDWsP8AC/7pcodssK7rTpZqrsbKio1yfmBOVuoLbeg9hpPbwfi7YOr4iIrMMupuLWNyBbkbAGR8OLp8+TtdLC4ioQPDVLi9ndQfoLkycbwuoq5UXxHO9rBB8zNEwPebkLFsAjhr3+0Oa/LzMhnv/wD1xreTABRz+15+lklTjxiby5VsmD4BXX/mVLX5aWEv4ngFRqbBaii6sPMCLXFtxNMrd67kf9GnzqMf9EwPEu8TGVtMlOmLWsFYke12t+U28eP4ycuX6wPE8C+FqGlUKlhzUkr8iQJZo1VPOU4/GPXbO9gbWsBYadB8zPPQ3loZnAYo06tN9gro9vVWvr9J9UKwIBGxAI+c+S3NiP7In0T3bcc/S8AmY3elam3UgDyt81sPdTFG2xETAiIgJSZVKTAREgwERECIiICIiAkiRECZMRAQIiBVERAREQMR2p4yMDhKuJIuUWyrrYsxyoD6ZiL+k+b8XWZyWZizMS7MdyznMSZETYPANLt0WeFdTeIgXEMqiIEmWXWIiith5V+en8+8qoJEQx6a249h+qdA7oeLmjjFon4K6shH4lBqK35OP70mJo7rERJaREQEpiICREQEGREBERAREQP/2Q==

Base64String of Image

Machine_Num
string (optional) Example: 36

Machine Number

Device_ID
string (optional) Example: D006

Device ID

GPS_Location
string (optional) Example: Y

GPS Location

Body_Temp
decimal (optional) Example: 37.05

Body Temperature

Is_Abnormal
string (optional) Example: N

Is_Abnormal should be 'Y' or 'N'

Wear_Mask
string (optional) Example: Y

Wear_Mask should be 'Y' or 'N'

Response 200
Content-Type: application/json
[
    {
        "Status"            :type: string,                        
        "Message"           :type: string,
        "Transaction_ID"    :type: integer
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"       :"ICS",    
    "Biometric_ID"      :12,
    "Transaction_ID"    :85,
    "Auth_DateTime"     :"2020-09-09T13:05:46+08:00",
    "Auth_Status"       :"Check-In",
    "Photo"             :"/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAoHCBISEhgREhIYEhgZEhQYGBIaGhUcGBkcGBoaGR4ZGBgcIS4mHB4tIxgYJjgmKy8xNzU1GiQ7QD0zPy40NTEBDAwMEA8QGhISHj4kJCs3NDQ0NDQxNTQ9NDQ0NDE0PjQxNDQ0NDQ0MTQ0NDQxNDQ0NDQ0NDQ0PTQ0NDQ0NDQ0NP/AABEIALcBEwMBIgACEQEDEQH/xAAcAAEAAQUBAQAAAAAAAAAAAAAAAQIDBQYHBAj/xABCEAACAQIEAwYDBAYIBwEAAAABAgADEQQSITEFQVEGBxMiYXEygZEjQmKhFLHB0eHwJFJygpKiwvEWMzRDU2OTF//EABkBAQEBAQEBAAAAAAAAAAAAAAACAQMEBf/EACARAQEAAgICAwEBAAAAAAAAAAABAhEDIRIxE0FRIjL/2gAMAwEAAhEDEQA/AOuyZEmAERECYiICTEQEqlMqgIiICIiAiJaqVlX4mA9yBAuxOedrO8enhz4eFy1X5sb5BrbQj4vl9Zq2I718YUCrTpo3/kALD6E2mbV412yJx7B96ld6qZ6aJTLrm0Ytl52IO837s/2sw+MYpTzZlVWIIsBc2tfmY3C41scSkGVTUkRECmIiAkSZEBERAiIiAiIgRERAkRECAkyJMBESYCIiAlURAREQEREDyY/FrRptUchVVSzEmwAE+b+O8Yr4mq71qjXLnS5AA6BdgANJ1rvT4ktOh4BzXcXGW3Jh8V9hOJ4bCPVqCmtySx6+37JFq8YjEPsSbX1B5/P03lo1FU8267zoOD7Bo6DxHOa3LaYviXYSsjfZi4tpzvaTOTF0+LJqoqodiR1/2ntwWKqUXFSk7KwHlZWIPX9m08fFMBUoOFdShNz7y1Srkg62Omg0le50nuXVdd7H95BLJQxaMSSB4/qT95QNBrOqKwIuJ8qLUIN7kfz166Tq/d929zZMJiSfiVUq+5+F/wB/tebLpOWO/Tq8SmVSkEplUQKYiIERJkQEiTIgIiICIiAiIgSIkSYASYiAlUplUBERAREQE8+NxK06bO7BQoJLHYT0Tn/eN2iSmooKC7B0LoM2tvOKflB3AuegEy3TZN1rPePxGnXyMlTMy5jkykELe4Yk7A6TEdhsCGqNVIuQPpeanjuLGrWeowy52JsNhfkPQTcOzlOqmHrZajKpy5VRPtG8t9Gucq+wnLL1Y74e5XR8Ehta0yGS+hE5vw/FV6KeL/SCVqAFGYlWU63GYkH6D3Ey+K7UJiaYTCVHZ8pZiodCqg2Nyy33IFluSegBI4+Onby2xfejwRnVMSikhAwdbagNY5vWxH5zlquFN7fELe06lT4d4lREIxihiiGozqwzHXMAQxA1tqTsdppHbDha4TFHDqS1tS7WBa4BAstgCM3ITvh1048nfbFZ821x1Pra+vWe7h1YoysLXB2tuNb2+UxuHrFWIJuDfWek1AGFtByOnX/eXUR9H9kO0CY/DCqoyMpKPTvcqw9eYIsQfWZ+cg7sMeuHqGm+orlAHGbRtQEPIbmdfjG7iMsdUiIlJJTKpTASJMiAiIgRBiICIiAiIgTEQIExECBVERAREQEREDxcXxy4fD1cQwuKdJ3IG5yKTYfScK7Z43GPWz1qIoq/mOXewTwyt7n+qZ2PtRxejRptRqIarPTb7IW1UggliSABofpOIY+pVxJp0qh8Pw6BALEgsFGwJ3Y6ctd5GVdMZ9tUqL5iNdCd/n/CdL7H4xalIOinyqiVk53UWzr1HpvY+gvzbGU8jMt72ZlJ31BsSDNj7AY8U8U1MkgVF05eZTcD5gmTyTeO3Tjy1lpv/EsYgFqSEudM7qyIn4jnALfK8yBwIpUqL0ArtTp5Apa2dGsWFx966qwPW45mefH0agqI6OvhsDnYqWdTy52KzKYKjTRQVrAkgaKjc97Amwnmj2WfajB4lSwKUmV1IJptlUA76uCRb1W/znL+8xP6SmbzMUZmO1yW39B0HICdSp4aoWNSsy7nIFXKwW2gc31PO3L1nH+3GNNXGOq2IXKg9LdPXedOP/WnLm141rTkE3vvrb1nuvmysoBIUXvbU7TyItjZlv69Nf4T0YRxdgbm66DlfbX856K8mLN9nKhWvTBLKpqL8JIIYag3vysJ9F8IxHiUVcnMbFS2mpUlSdOtp884DC0zlqOPEUOLKC65iwGjaaC9gbEHU22nYu75stN6asTTFWoE1zAea+VSdSBqL85ON7VnP5blEROjiSmVRApiIgRERAiIiAiIgJMiTASZEmAiJVAREQEREBIJkzzY3VCl7ZgRf5QNX7UYhRV0YDPhqqO29l0K3Gmty1tR8RHS/IuLY2piKgqOmYLUTYDUrlSxJ9hces6V2jwYId3bKKbK3hopykrcgkjRRYczrY+lub8UqolIjMue4zILgjYllbMQ9yWFwNtfSccvbtj6a5xBWzsxAGZs1r3tfkTPL4TA5kJuCCpB1BB0t0NxPfxLHtVyXygrTRFyj7qjS/Uz19kcL4uMopfMBUV3H9ghrfUCXE1v3Znj4dVp4ghXyiznRX/cfSbvRemi5iQul76Wmr8b7OKjFQNL5kP4W2+m3ymKxlB0TKBfSeO3Vse2f1Ir7a9t1pqaWF87kEeJ91epHUzltEE+ZiSc2YsT63ufXf6zYu0HB6tFRUqrlLi6IdCR1t0mtJc+tvfWenjmpt5uW7qRUBcjcG+nqZdpUmDAAX632vKMKgY8lO535a6S/wA7LvzO8u1GMbnwThgYkVLEIUuVDKbvsQSctx5fK39a/LXpPYai4Ry3mTP5H0tcXz5QNAL2BtoSpM0LsPXpmoqVF/7gZ25Hf6A6fSdgwWFpob07BTrkFst78hy32kYzd2rO6mnuQ6SqInZwIiIFMRECIiICRJkQEREBJkSYCTIEmAlUpEqgIiICIiAmP4tUK0zlJBtfNZdBublvKNAdTMhOd973aBaOE/REb7WrYm1rqga5v0zFcvqM0ytjVOM9ssudaf2rMxtUbKFsFVCUK6kHL0GlxzJnPsXiy58wGttBfpbQy3Vq6DckW3t8/wBs8ijzZh129D/vJmP66XL8XVcgjKDcG9513ur7MXojH1PifOqD8KsFvb3VtehE5MF1n1BwvDrQw1KiiFVSkiBWIuAABrbczpI5W2rfEcIKtMD74BynTX8Jv1tLPCuColqlTK78hbyr9dzMyqaW9J4qpamxqL8NrunX8Q/F+uRcMbl5KmeUx8duT989UGvSRdWSi7MOgdlAPp8JnNgpC5V00vf+M3/vQq06tdcRSBa58JmJXK2QsbKt76EMDcC9poDVMtgLX689f1TL7XOouU1Cak7CX8ONQAL7aDS/8Z4XuBr89zeTh3OgO37uV403beOA4WpSxKKBvY+a1iNCR0bfady4blNNLEHyjUbbT564dxSoyqjsXRSbKb5lBtcK2/LbbQaTu/Z3DtSp+EVIC/CSVN1+X86yceq3k7xjNxETq4IMmIgUxEQIiTIgJEmRAREQJEQIgBJiICVSmVQEREBERACfM/bbi7YrHVqpGX7UoE6LTOVT72W59SZ9FcbxngYWtX5pQqOPdVJA+tp8rYpyWLHe+p6+8CiqdPoJaI/VLlTcD1/fJtNGa7MYPx8bhqQ+/Xp3/sqwdv8AKrT6W3a3ScM7n8J4nEPEI0pUnb5tZB+TN9J3SkNCes1ittNfylmolxaXHO0qcTBwnvUwq0MUADo4dwn3VJIuQOVzrNDAAKk6+nttebz3wVc/EsnJMPTHzLO37RNEDg8ue/X2k3Fcy37XGYXsbnTc2/KVIR8pQ7EjMTvp7bbQNdtIkblkymAYg9NOs+h+zfEv0mktQJlGRLWbMLMoa17CzC4BE+bKQ11M+guwGDC8Pwz5MpKFidybs1t/hFrGw3/Xnjq7ZctzTbYkCTKSREQEplUpgJEmQYCDEGBERECRECICTIEmAlUplUBERAREs4zEeHTeoRfIjPbrlUtb8oHO+97tBUo0lwSZftqbtUJBzBVZcoXXS5DX30E4dWa97zL8f41XxtY18Q+ZyTYD4UXkiDko1+pJ1MxLazRSDcj2MuSwh29jLwPX8oHVu5DD/wDVVPTDoD/9Cf1rOvLsBOYdxyj9FxDcziVB9gi2/WZ062s1ilj5xK2GsoZbm/rLoNoHzp3n1CeK4kH7ppqPbw0P+ozUCtrAep+k33vS4ZUbi7rTRnaslJ1VRvZch9rZNSdpR/wbhsIgrcQxIH/pTQn0B+In2A2kXKT2vHDK+mjWJPoPzl9VmR49xDC1nQYTDrhadNMo/rub3LOSSTyAuTz6zHgm1x5v55Som9V6sFTuwFwLkC5tYX5k8hPpzg9MJQSmoGRERUYbMqqAGHvPn3sdhaVfF0EcZkasqsmuuuxn0dTQKAqgAAAADQADQADkIoqiImBERASmIgJBkyDAQYgwIiIgSIkSYASZEmAEqlIlUBERATE9qMVTpYLEVKhsooVBvYkspUAepJAmWnLe+56vg4dFNqZqVS63tdlChb9QAz/P5QONVqgLdJbYybjbb6S2y8hpc29NZoqwmFqVXyUkaox2VQSf4D1mz/8AAXEQgfw0JtfIHXOPTXS/zm59iMDToUxlADMBd+be5m4ZtNDPPlzXfT048M121juaWrQGKw9am9Mh6LgOpF8yupt1+AajrOmDEqtyzAAA2vv/ABmseIRre3rFTEMwsWvabOefcTeC/VbQKtxm66y3WxiopJNgASZgBxKoNBl+n8ZarVWqDK2x3tNvNNdE4Mt9rWKAqVjXIAcoEBG4QEta521JJ+XSY4Yvh9OplqvTaqfuFc7fLczGdrePpg2XDlGctTz3VgOZAV+dtOU1Fu3eL/7VOjQsLWVNfckmx+k5zHLO7rteTDCeMb1xDtFhMGjvmFOuELU6TYdgWJ0XytlspI39+k5NiMU9eo9Soczu7Ox5FmNzaRxDG1sTUNas5qO1ru25toB6AdJ5VNvTqP2z0Y46mnl5M/K7bJ2HJXieGKg3NdAV6i/7P2T6RnLu6zswpCcTqMGJV1pILG2pVnb8WjKB6k9LdRlVBERMCIiBTERASIiAkSZEBERASYEQAkyJMAJVKZVAREQE5H35Y0/0fDCwAFSqzc9wiqPQ+b6CdcnH+/aj58G4G4rqzcjlNMqp/wATn69IHJFtOn9juzmFFBalemtV3AbzgEIDsqg+m56zmB2nZeBurYemw2NND/lE482Vkmnfgxlyu3uq8IolbUyadhoFOg/um4/KY1sXXwzWqjxE5VUB8v8AbXW3uNPaZlagEl6oPKeWV7Fmjiw4DKQwIuCDcH2lwVZiMRgfDY1KHk1u1P7jetuR9RLmHxyvowKn1le0soHl5GmOv63ktisguToBeYpzTtzi/Exz63yBEH90XP5sZrwbc9LH+fpLmJxBqVHqHd6jv/iYn9soQb/Ke/Gakj5uV3lauiVCkWNgpY20CgknlYAb7y5w7DNUdKaC7NUCLfQXYgC55fEJ9A9i+xlHhqs+Y1azgB6h0Cjcqg5LfXXU2HQAal5u6rhtfDcNRMQGVnqO6owIZVa1gwOxNi1vxTc4iY0iIgJTKpTAREQIiIgJEmRAREQEmRJgJMiIExECBVERATC9q+AU+IYVsO9g1i1Opa5RwCFcempBHMEzNRA+eK/dhxZSbUEex3WrTsfUBiD9QJksHTx3DqI/TcM9KktlFXyMovsDkYmd1nGe9/jnj1f0JG8lEXcjnUcbf3UP1c9JOWMymqrHK43cWV7Y4MDWsP8AC/7pcodssK7rTpZqrsbKio1yfmBOVuoLbeg9hpPbwfi7YOr4iIrMMupuLWNyBbkbAGR8OLp8+TtdLC4ioQPDVLi9ndQfoLkycbwuoq5UXxHO9rBB8zNEwPebkLFsAjhr3+0Oa/LzMhnv/wD1xreTABRz+15+lklTjxiby5VsmD4BXX/mVLX5aWEv4ngFRqbBaii6sPMCLXFtxNMrd67kf9GnzqMf9EwPEu8TGVtMlOmLWsFYke12t+U28eP4ycuX6wPE8C+FqGlUKlhzUkr8iQJZo1VPOU4/GPXbO9gbWsBYadB8zPPQ3loZnAYo06tN9gro9vVWvr9J9UKwIBGxAI+c+S3NiP7In0T3bcc/S8AmY3elam3UgDyt81sPdTFG2xETAiIgJSZVKTAREgwERECIiICIiAkiRECZMRAQIiBVERAREQMR2p4yMDhKuJIuUWyrrYsxyoD6ZiL+k+b8XWZyWZizMS7MdyznMSZETYPANLt0WeFdTeIgXEMqiIEmWXWIiith5V+en8+8qoJEQx6a249h+qdA7oeLmjjFon4K6shH4lBqK35OP70mJo7rERJaREQEpiICREQEGREBERAREQP/2Q==",
    "Machine_Num"       :36,
    "Device_ID"         :"D006",
    "GPS_Location"      :"Y",
    "Body_Temp"         :37.05,
    "Is_Abnormal"       :"Y",
    "Wear_Mask"         :"Y"
}
Response 200
Content-Type: application/json
[
    {
        "Status"            : "Success",
        "Message"           : "Record Updated successfully",
        "Transaction_ID"    : 85
    }
]

Search Transactions

Transaction
GET/SearchTransaction

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
    "start_index"    : type :integer,
    "max_count"      : type :integer,
    "client_code"    : type :string,
    "site_code"      : type :string,
    "location_code"  : type :string,
    "mode"           : type :string,
    "fromdate"       : type :string,
    "todate"         : type :string                                       
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
start_index
integer (required) Example: 1

Record Start index from the list

max_count
integer (required) Example: 200

Maximum Record to retrieve

client_code
string (required) Example: ICS

Client Code

site_code
string (required) Example: ALL

Indicate site code or “All”

location_code
string (required) Example: ALL

Provide specific location code or “All” to get all location code.

mode
string (required) Example: D

This parameter is to indicate whether data to be filtered based on Date of Transaction or Received Date. Provide 'D' for Date of Transaction and 'R' for Date of Received

fromdate
string (required) Example: 2022-01-01T19:20:30.45+01:00

This parameter is to get profile list based on create or modified date given on MODE.

todate
string (required) Example: 2022-01-31T19:20:30.45+01:00

This parameter is to get Profile list based on create or modified date given on MODE.

Response 200
Content-Type: application/json
[
    {
    "Transaction_ID"    :type: string,
    "site_code"         :type: string,
    "BiometricID"       :type: string,
    "ProfileID"         :type: string,
    "UniqueID"          :type: string,
    "ReferenceID"       :type: string,
    "Name"              :type: string,
    "division_code"     :type: string,
    "division_desc"     :type: string,
    "department_code"   :type: string,
    "department_desc"   :type: string,
    "location_code"     :type: string,
    "Machine_num"       :type: integer,
    "Auth_datetime"     :type: datetime,
    "Mode"              :type: string,
    "temperature"       :type: string,
    "is_abnormal"       :type: string,
    "weared_mask"       :type: string,
    "Receiveddatetime"  :type: datetime,
    "Role_Details"      :type: array,
    [
    {
    "RoleCategory"   :type: string,
    "RoleName"       :type: string,
    "RoleDescription":type: string,
    "Primaryrole"    :type: string

    }
    ]
    }
    ]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "start_index"   : 1,
    "max_count"     : 200,  
    "client_code"   : "ICS",
    "site_code"     : "ALL",
    "location_code" : "ALL",
    "mode"          : "R",
    "fromdate"      : "2022-01-01T19:20:30.45+01:00",
    "todate"        : "2022-01-31T19:20:30.45+01:00"
}
Response 200
Content-Type: application/json

    [
    {
    "Transaction_ID"    : "71099",
    "site_code"         : "ICS",
    "BiometricID"       : "1001",
    "ProfileID"         : "P001",
    "UniqueID"          : "",
    "ReferenceID"       : "NA",
    "Name"              : "Abraham Zygmont",
    "division_code"     : "ADMIN",
    "division_desc"     : "ADMIN",
    "department_code"   : "Sales_dept",
    "department_desc"   : "Sales_dept",
    "location_code"     : "RESTRICTED",
    "Machine_num"       : "2",
    "Auth_datetime"     : "2017-09-25T10:01:30+05:30",
    "Mode"              : "Check-In",
    "temperature"       : "",
    "is_abnormal"       : "N",
    "weared_mask"       : "Y",
    "Receiveddatetime"  : "2017-09-25T10:05:01+05:30"
    "Role_Details"      : [
    {
    "RoleCategory"   :"RoleCategoryNew07",
    "RoleName"       :"RoleNew07",
    "RoleDescription":"RoleNew07",
    "Primaryrole"    :"N"

    },
    {
    "RoleCategory"   :"RoleCategoryNew07",
    "RoleName"       :"RoleNew07",
    "RoleDescription":"RoleNew07",
    "Primaryrole"    :"N"

    }
    ]
    },

    {
    "Transaction_ID"    : "71100",
    "site_code"         : "ICS",
    "BiometricID"       : "1001",
    "ProfileID"         : "P001",
    "UniqueID"          : "",
    "ReferenceID"       : "NA",
    "Name"              : "Abraham Zygmont",
    "division_code"     : "ADMIN",
    "division_desc"     : "ADMIN",
    "department_code"   : "Sales_dept",
    "department_desc"   : "Sales_dept",
    "location_code"     : "MAIN_ACCESS",
    "Machine_num"       : "2",
    "Auth_datetime"     : "2017-09-25T11:48:03+05:30",
    "Mode"              : "Check-Out",
    "temperature"       : "",
    "is_abnormal"       : "N",
    "weared_mask"       : "Y",
    "Receiveddatetime"  : "2017-09-25T11:48:05+05:30"
    "Role_Details"      : [
    {
    "RoleCategory"   :"RoleCategoryNew07",
    "RoleName"       :"RoleNew07",
    "RoleDescription":"RoleNew07",
    "Primaryrole"    :"N"

    },
    {
    "RoleCategory"   :"RoleCategoryNew07",
    "RoleName"       :"RoleNew07",
    "RoleDescription":"RoleNew07",
    "Primaryrole"    :"N"

    }
    ]
    }
    ]

Search FILO Transaction

FILO Transaction
GET/SearchFILOTransaction

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json

    {
                                "start_index"    : type :integer,
                                "max_count"      : type :integer,
                                "client_code"    : type :string,
                                "site_code"      : type :string,
                                "location_code"  : type :string
                                "mode"           : type :string,
                                "fromdate"       : type :string,
                                "todate"         : type :string
    }
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
start_index
string (required) Example: 1

Record Start index from the list

max_count
integer (required) Example: 2

Maximum Record to retrieve

client_code
string (required) Example: ICS

Client Code

site_code
string (required) Example: ALL

Indicate site code or “All”

location_code
string (required) Example: ALL

Indicate Location code or “All”

mode
string (required) Example: C

Retrieve transaction based on day or shift. Use “Day” to get First in last out based on each day and “Shift” to retrieve first in last out based on individual shift.

fromdate
string (required) Example: 2022-01-01T19:20:30.45+01:00

This parameter is to get profile list based on create or modified date given on MODE.

todate
string (required) Example: 2022-01-31T19:20:30.45+01:00

This parameter is to get Profile list based on create or modified date given on MODE.

Response 200
Content-Type: application/json
[
    {
    "site_code"             :type: string,
    "BiometricID"           :type: string,
    "ProfileID"             :type: string,
    "UniqueID"              :type: string,
    "ReferenceID"           :type: string,
    "Name"                  :type: string,
    "division_code"         :type: string,
    "division_desc"         :type: string,
    "department_code"       :type: string,
    "department_desc"       :type: string,
    "location_code"         :type: string,
    "Machine_Num"           :type: integer,
    "Check_In_datetime"     :type: datetime,
    "Check_In_temperature"  :type: string,
    "Check_In_is_abnormal"  :type: string,
    "Check_In_weared_mask"  :type: string,
    "Check_Out_datetime"    :type: datetime,
    "Check_Out_temperature" :type: string,
    "Check_Out_is_abnormal" :type: string,
    "Check_Out_weared_mask" :type: string,
    "Role_Details"          :type: array,
    [
    {
    "RoleCategory"   :type: string,
    "RoleName"       :type: string,
    "RoleDescription":type: string,
    "Primaryrole"    :type: string

    }
    ]
    }
    ]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json

    {
    "start_index"   : 1,
    "max_count"      : 50,
    "client_code"   : "ICS",
    "site_code"     : "ALL",
    "location_code" : "ALL",
    "mode"          : "C",
    "fromdate"      : "2022-01-01T19:20:30.45+01:00",
    "todate"        : "2022-01-31T19:20:30.45+01:00"
    }
Response 200

    [
    {
    "site_code"             : "ICS",
    "BiometricID"           : "1001",
    "ProfileID"             : "P001",
    "UniqueID"              : "",
    "ReferenceID"           : "NA",
    "Name"                  : "Abraham Zygmont",
    "division_code"         : "ADMIN",
    "division_desc"         : "ADMIN",
    "department_code"       : "Sales_dept",
    "department_desc"       : "Sales_dept",
    "location_code"         : "RESTRICTED",
    "Machine_num"           : "2",
    "Check_In_datetime"     : "2017-09-25T10:01:30+05:30",
    "Check_In_temperature"  : "",
    "Check_In_is_abnormal"  : "N",
    "Check_In_weared_mask"  : "Y",
    "Check_Out_datetime"    : "2017-09-25T22:55:45+05:30",
    "Check_Out_temperature" : "",
    "Check_Out_is_abnormal" : "N",
    "Check_Out_weared_mask" : "Y",
    "Role_Details"      : [
    {
    "RoleCategory"   :"RoleCategoryNew07",
    "RoleName"       :"RoleNew07",
    "RoleDescription":"RoleNew07",
    "Primaryrole"    :"N"

    },
    {
    "RoleCategory"   :"RoleCategoryNew07",
    "RoleName"       :"RoleNew07",
    "RoleDescription":"RoleNew07",
    "Primaryrole"    :"N"

    }
    ]

    },
    {
    "site_code"             : "ICS",
    "BiometricID"           : "1002",
    "ProfileID"             : "P002",
    "UniqueID"              : "",
    "ReferenceID"           : "NA",
    "Name"                  : "Abraham Zygmont",
    "division_code"         : "ADMIN",
    "division_desc"         : "ADMIN",
    "department_code"       : "Sales_dept",
    "department_desc"       : "Sales_dept",
    "location_code"         : "RESTRICTED",
    "Machine_num"           : "2",
    "Check_In_datetime"     : "2017-09-25T10:01:30+05:30",
    "Check_In_temperature"  : "",
    "Check_In_is_abnormal"  : "N",
    "Check_In_weared_mask"  : "Y",
    "Check_Out_datetime"    : "2017-09-25T22:55:45+05:30",
    "Check_Out_temperature" : "",
    "Check_Out_is_abnormal" : "N",
    "Check_Out_weared_mask" : "Y",
    "Role_Details"      : [
    {
    "RoleCategory"   :"RoleCategoryNew07",
    "RoleName"       :"RoleNew07",
    "RoleDescription":"RoleNew07",
    "Primaryrole"    :"N"

    },
    {
    "RoleCategory"   :"RoleCategoryNew07",
    "RoleName"       :"RoleNew07",
    "RoleDescription":"RoleNew07",
    "Primaryrole"    :"N"

    }
    ]
    }
    ]

Search Shift Transaction

Shift Transaction
GET/SearchShiftTransaction

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json

    {
        "start_index"    : type :integer,
        "max_count"      : type :integer,
        "client_code"    : type :string,
        "site_code"      : type :string,
        "location_code"  : type :string,
        "fromdate"       : type :string,
        "todate"         : type :string
    }
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
start_index
string (required) Example: 1

Record Start index from the list

max_count
integer (required) Example: 2

Maximum Record to retrieve

client_code
string (required) Example: ICS

Client Code

site_code
string (required) Example: ALL

Indicate site code or “All”

location_code
string (required) Example: ALL

Indicate Location code or “All”

fromdate
string (required) Example: 2022-01-01T19:20:30.45+01:00

This parameter is to get profile list based on create or modified date given on MODE.

todate
string (required) Example: 2022-01-31T19:20:30.45+01:00

This parameter is to get Profile list based on create or modified date given on MODE.

Response 200
Content-Type: application/json
[
    {
    "site_code"             :type: string,
    "BiometricID"           :type: string,
    "ProfileID"             :type: string,
    "UniqueID"              :type: string,
    "ReferenceID"           :type: string,
    "Name"                  :type: string,
    "division_code"         :type: string,
    "division_desc"         :type: string,
    "department_code"       :type: string,
    "department_desc"       :type: string,
    "location_code"         :type: string,
    "Machine_num"           :type: integer,
    "shift_code"         	:type: string,
    "Check_In_datetime"     :type: datetime,
    "Check_In_temperature"  :type: string,
    "Check_In_is_abnormal"  :type: string,
    "Check_In_weared_mask"  :type: string,
    "Check_Out_datetime"    :type: datetime,
    "Check_Out_temperature" :type: string,
    "Check_Out_is_abnormal" :type: string,
    "Check_Out_weared_mask" :type: string,
    "Role_Details"          :type: array,
    [
    {
    "RoleCategory"   :type: string,
    "RoleName"       :type: string,
    "RoleDescription":type: string,
    "Primaryrole"    :type: string

    }
    ]
    }
    ]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json

    {
        "start_index"   : 1,
        "max_count"      : 50,
        "client_code"   : "ICS",
        "site_code"     : "ALL",
        "location_code" : "ALL",
        "fromdate"      : "2022-01-01T19:20:30.45+01:00",
        "todate"        : "2022-01-31T19:20:30.45+01:00"
    }
Response 200

    [
    {
    "site_code"             : "ICS",
    "BiometricID"           : "1001",
    "ProfileID"             : "P001",
    "UniqueID"              : "",
    "ReferenceID"           : "NA",
    "Name"                  : "Abraham Zygmont",
    "division_code"         : "ADMIN",
    "division_desc"         : "ADMIN",
    "department_code"       : "Sales_dept",
    "department_desc"       : "Sales_dept",
    "location_code"         : "RESTRICTED",
    "Machine_num"           : "2",
    "shift_code"         	: "SH_0900_1800",
    "Check_In_datetime"     : "2017-09-25T10:01:30+05:30",
    "Check_In_temperature"  : "",
    "Check_In_is_abnormal"  : "N",
    "Check_In_weared_mask"  : "Y",
    "Check_Out_datetime"    : "2017-09-25T22:55:45+05:30",
    "Check_Out_temperature" : "",
    "Check_Out_is_abnormal" : "N",
    "Check_Out_weared_mask" : "Y",
    "Role_Details"          : [
    {
    "RoleCategory"   :"RoleCategoryNew07",
    "RoleName"       :"RoleNew07",
    "RoleDescription":"RoleNew07",
    "Primaryrole"    :"N"

    },
    {
    "RoleCategory"   :"RoleCategoryNew07",
    "RoleName"       :"RoleNew07",
    "RoleDescription":"RoleNew07",
    "Primaryrole"    :"N"

    }
    ]
    },
    {
    "site_code"             : "ICS",
    "BiometricID"           : "1002",
    "ProfileID"             : "P002",
    "UniqueID"              : "",
    "ReferenceID"           : "NA",
    "Name"                  : "Abraham Zygmont",
    "division_code"         : "ADMIN",
    "division_desc"         : "ADMIN",
    "department_code"       : "Sales_dept",
    "department_desc"       : "Sales_dept",
    "location_code"         : "RESTRICTED",
    "Machine_num"           : "2",
    "shift_code"         	: "SH_0900_1800",
    "Check_In_datetime"     : "2017-09-25T10:01:30+05:30",
    "Check_In_temperature"  : "",
    "Check_In_is_abnormal"  : "N",
    "Check_In_weared_mask"  : "Y",
    "Check_Out_datetime"    : "2017-09-25T22:55:45+05:30",
    "Check_Out_temperature" : "",
    "Check_Out_is_abnormal" : "N",
    "Check_Out_weared_mask" : "Y",
    "Role_Details"          : [
    {
    "RoleCategory"   :"RoleCategoryNew07",
    "RoleName"       :"RoleNew07",
    "RoleDescription":"RoleNew07",
    "Primaryrole"    :"N"

    },
    {
    "RoleCategory"   :"RoleCategoryNew07",
    "RoleName"       :"RoleNew07",
    "RoleDescription":"RoleNew07",
    "Primaryrole"    :"N"

    }
    ]

    }
    ]

Delete Transaction

Transaction
DELETE/DeleteTransaction

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"              : type :string,
                                "Transaction_Detail"       : [            
        {
                                "Transaction_ID"   : type :integer
        }
    ]  
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Client Code

Transaction_Detail
Transaction_ID
integer (required) Example: 85

Respective Transaction ID

Response 200
Content-Type: application/json
[
    {
        "Transaction_ID"    :type: integer,
        "Message"           :type: string,
        "Status"            :type: string                        
        
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"               :"ICS",
    "Transaction_Detail"        : [            
        {
            "Transaction_ID"    :85
        }
    ]
}
Response 200
Content-Type: application/json
[
    {
        "Transaction_ID"    : 85,
        "Message"           : "Record deleted successfully",
        "Status"            : "Success"
        
    }
]

Reader

        You can able to add the Reader data.

Add Reader

Reader
POST/AddReader

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"               : type :string,                                            
                                "Level_Detail_ID"           : type :integer,
                                "Reader_Type_ID"            : type :integer,
                                "Reader_Model_ID"           : type :integer,                                            
                                "Authentication_Method"     : type :integer,
                                "Authentication_Mode"       : type :integer,
                                "DYDNS_Name"                : type :string,                                            
                                "User_Name"                 : type :string,
                                "Password"                  : type :string,
                                "IP_Address"                : type :string,
                                "Port"                      : type :string,                                            
                                "Listener_Port"             : type :string,
                                "Location_ID"               : type :integer,
                                "DoPolling"                 : type :string,                                            
                                "Job_Code_Enabled"          : type :string,
                                "Is_Registration_Reader"    : type :string,
                                "Is_Modification_Reader"    : type :string,                                            
                                "Upload_Template"           : type :string,
                                "Delete_Template"           : type :string,
                                "Active"                    : type :string,
                                "Reader_Alias"              : type :string,                                            
                                "Reader_Group_ID"           : type :integer,
                                "Is_Productivity_Reader"    : type :string,
                                "Serialnum"                 : type :string,                                            
                                "Mac_Address"               : type :string,
                                "Device_ID"                 : type :string,
                                "Is_People_Counting"        : type :string,                                            
                                "Classification"            : type :integer,
                                "Door_ID"                   : type :integer,
                                "Door_List_ID"              : type :integer,
                                "Is_Attendance_Reader"      : type :string,                                            
                                "Is_Safe_Entry"             : type :string,
                                "Is_Visitor_Reader"         : type :string,
                                "Connection_Method"         : type :string,                                            
                                "Tracking"                  : type :string,
                                "Other_HW_Classification_ID": type :integer,
                                "Other_Reader_Type_ID"      : type :integer,                                            
                                "Other_Reader_ID"           : type :integer,
                                "In_Built_Door_Access"      : type :string,
                                "Activate_By_HW"            : type :string,
                                "Activate_By_SW"            : type :string,
                                "Activate_Door_On_Other_HW" : type :string,                                            
                                "TimeZone_Access"           : type :string,
                                "PCM_Attendance"            : type :string,
                                "FRWIth_Mask"               : type :string
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Client Code

Level_Detail_ID
integer (required) Example: 5

Indicate LevelDetailID

Reader_Type_ID
integer (required) Example: 1

Indicate ReadersType

Reader_Model_ID
integer (required) Example: 1

Indicate ReaderModel

Authentication_Method
integer (optional) Example: 4

Indicate AuthenticationMethod

Authentication_Mode
integer (optional) Example: 1

Client AuthenticationMode

DYDNS_Name
string (optional) Example: 192.02.08.10

DYDNS Name

User_Name
string (optional) Example: User Name

Password
string (optional) Example: test pwd

Password

IP_Address
string (optional) Example: 192.06.00.05

IP_Address

Port
string (optional) Example: 584

Port

Listener_Port
string (required) Example: 584

Listener_Port

Location_ID
integer (optional) Example: 10008

Indicate Location

DoPolling
string (optional) Example: Y

Indicate DoPolling

Job_Code_Enabled
string (optional) Example: Y

Job_Code_Enabled

Is_Registration_Reader
string (optional) Example: Y

Is_Registration_Reader

Is_Modification_Reader
string (optional) Example: Y

Is_Modification_Reader

Upload_Template
string (optional) Example: Y

Upload Template

Delete_Template
string (optional) Example: N

Delete Template

Active
string (optional) Example: Y

Record is Active

Reader_Alias
string (required) Example: TestReader

Reader Name

Reader_Group_ID
integer (required) Example: 1

Indicate Reader Group

Is_Productivity_Reader
string (required) Example: Y

Is_Productivity_Reader

Serialnum
string (optional) Example: 1

Indicate Serialnum

Mac_Address
string (optional) Example: 1343

Device_ID
string (optional) Example: 13

Device ID

Is_People_Counting
string (optional) Example: N

Is_People_Counting

Classification
integer (optional) Example: 2

Classification

Door_ID
integer (optional) Example: 1

Unique Id of Door Details

Door_List_ID
integer (optional) Example: 14

Unique Id of Door List Details

Is_Attendance_Reader
string (optional) Example: Y

Is_Attendance_Reader

Is_Safe_Entry
string (optional) Example: Y

Is_Safe_Entry

Is_Visitor_Reader
string (optional) Example: N

Is_Visitor_Reader

Connection_Method
string (optional) Example: L

Connection Method

Tracking
string (optional) Example: Y

Is Tracking

Other_HW_Classification_ID
integer (optional) Example: 0

Other HW Classification ID

Other_Reader_Type_ID
integer (optional) Example: 0

Other Reader Type ID

Other_Reader_ID
integer (optional) Example: 1

Other Reader ID

In_Built_Door_Access
string (optional) Example: Y

Activate_By_HW
string (optional) Example: N

Activate_By_SW
string (optional) Example: Y

Activate_Door_On_Other_HW
string (optional) Example: Y

TimeZone_Access
string (optional) Example: Y

PCM_Attendance
string (optional) Example: Y

FRWIth_Mask
string (optional) Example: Y

Response 200
Content-Type: application/json
[
    {
        "Message"            :type: string,
        "Status"             :type: string,                                
        "Reader_Detail"      : [            
            {
                "Reader_ID"  : type: integer,
                "Reader_Name": type: string
            }
        ]  
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json

    {
    "client_code"                : "ABCTEST",
    "Level_Detail_ID"            : 5,
    "Reader_Type_ID"             : 1,
    "Reader_Model_ID"            : 1,
    "Authentication_Method"      : 4,
    "Authentication_Mode"        : 1,
    "DYDNS_Name"                 : "192.02.08.10",
    "User_Name"                  : "test UName",
    "Password"                   : "test pwd",
    "IP_Address"                 : "192.06.00.05",
    "Port"                       : "584",
    "Listener_Port"              : "584",
    "Location_ID"                : 10008,
    "DoPolling"                  : "Y",
    "Job_Code_Enabled"           : "Y",
    "Is_Registration_Reader"     : "Y",
    "Is_Modification_Reader"     : "Y",
    "Upload_Template"            : "Y",
    "Delete_Template"            : "Y",
    "Active"                     : "Y",
    "Reader_Alias"               : "TestReader",
    "Reader_Group_ID"            : 1,
    "Is_Productivity_Reader"     : "Y",
    "Serialnum"                  : "1",
    "Mac_Address"                : "1343",
    "Device_ID"                  : "13",
    "Is_People_Counting"         : "N",
    "Classification"             : 2,
    "Door_ID"                    : 1,
    "Door_List_ID"               : 14,
    "Is_Attendance_Reader"       : "Y",
    "Is_Safe_Entry"              : "Y",
    "Is_Visitor_Reader"          : "N",
    "Connection_Method"          : "L",
    "Tracking"                   : "Y",
    "Other_HW_Classification_ID" : 0,
    "Other_Reader_Type_ID"       : 0,
    "Other_Reader_ID"            : 0,
    "In_Built_Door_Access"       : "Y",
    "Activate_By_HW"             : "N",
    "Activate_By_SW"             : "Y",
    "Activate_Door_On_Other_HW"  : "Y",
    "TimeZone_Access"            : "Y",
    "PCM_Attendance"             : "Y",
    "FRWIth_Mask"                : "Y"
    }
Response 200
Content-Type: application/json
[
    {
        "Status"             : "Success",
        "Message"            : "Record added successfully",
        "Reader_Detail"      : [            
            {
                "Reader_ID"  : 88,
                "Reader_Name": "TestReader"
            }
        ]   
    }
]

Edit Reader

Reader
PUT/EditReader

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"               : type :string,                                            
                                "Level_Detail_ID"           : type :integer,
                                "Reader_ID"                 : type :integer,
                                "Reader_Type_ID"            : type :integer,
                                "Reader_Model_ID"           : type :integer,                                            
                                "Authentication_Method"     : type :integer,
                                "Authentication_Mode"       : type :integer,
                                "DYDNS_Name"                : type :string,                                            
                                "User_Name"                 : type :string,
                                "Password"                  : type :string,
                                "IP_Address"                : type :string,
                                "Port"                      : type :string,                                            
                                "Listener_Port"             : type :string,
                                "Location_ID"               : type :integer,
                                "DoPolling"                 : type :string,                                            
                                "Job_Code_Enabled"          : type :string,
                                "Is_Registration_Reader"    : type :string,
                                "Is_Modification_Reader"    : type :string,                                            
                                "Upload_Template"           : type :string,
                                "Delete_Template"           : type :string,
                                "Active"                    : type :string,
                                "Reader_Alias"              : type :string,                                            
                                "Reader_Group_ID"           : type :integer,
                                "Is_Productivity_Reader"    : type :string,
                                "Serialnum"                 : type :string,                                            
                                "Mac_Address"               : type :string,
                                "Device_ID"                 : type :string,
                                "Is_People_Counting"        : type :string,                                            
                                "Classification"            : type :integer,
                                "Door_ID"                   : type :integer,
                                "Door_List_ID"              : type :integer,
                                "Is_Attendance_Reader"      : type :string,                                            
                                "Is_Safe_Entry"             : type :string,
                                "Is_Visitor_Reader"         : type :string,
                                "Connection_Method"         : type :string,                                            
                                "Tracking"                  : type :string,
                                "Other_HW_Classification_ID": type :integer,
                                "Other_Reader_Type_ID"      : type :integer,                                            
                                "Other_Reader_ID"           : type :integer,
                                "In_Built_Door_Access"      : type :string,
                                "Activate_By_HW"            : type :string,
                                "Activate_By_SW"            : type :string,
                                "Activate_Door_On_Other_HW" : type :string,                                            
                                "TimeZone_Access"           : type :string,
                                "PCM_Attendance"            : type :string,
                                "FRWIth_Mask"               : type :string
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Client Code

Level_Detail_ID
integer (required) Example: 5

Indicate LevelDetailID

Reader_ID
integer (required) Example: 1

Unique Id of Reader

Reader_Type_ID
integer (required) Example: 1

Indicate ReadersType

Reader_Model_ID
integer (required) Example: 1

Indicate ReaderModel

Authentication_Method
integer (optional) Example: 4

Indicate AuthenticationMethod

Authentication_Mode
integer (optional) Example: 1

Client AuthenticationMode

DYDNS_Name
string (optional) Example: 192.02.08.10

DYDNS Name

User_Name
string (optional) Example: User Name

Password
string (optional) Example: test pwd

Password

IP_Address
string (optional) Example: 192.06.00.05

IP_Address

Port
string (optional) Example: 584

Port

Listener_Port
string (required) Example: 584

Listener_Port

Location_ID
integer (optional) Example: 10008

Indicate Location

DoPolling
string (optional) Example: Y

Indicate DoPolling

Job_Code_Enabled
string (optional) Example: Y

Job_Code_Enabled

Is_Registration_Reader
string (optional) Example: Y

Is_Registration_Reader

Is_Modification_Reader
string (optional) Example: Y

Is_Modification_Reader

Upload_Template
string (optional) Example: Y

Upload Template

Delete_Template
string (optional) Example: N

Delete Template

Active
string (optional) Example: Y

Record is Active

Reader_Alias
string (required) Example: TestReader

Reader Name

Reader_Group_ID
integer (required) Example: 1

Indicate Reader Group

Is_Productivity_Reader
string (required) Example: Y

Is_Productivity_Reader

Serialnum
string (optional) Example: 1

Indicate Serialnum

Mac_Address
string (optional) Example: 1343

Device_ID
string (optional) Example: 13

Device ID

Is_People_Counting
string (optional) Example: N

Is_People_Counting

Classification
integer (optional) Example: 2

Classification

Door_ID
integer (optional) Example: 1

Unique Id of Door Details

Door_List_ID
integer (optional) Example: 14

Unique Id of Door List Details

Is_Attendance_Reader
string (optional) Example: Y

Is_Attendance_Reader

Is_Safe_Entry
string (optional) Example: Y

Is_Safe_Entry

Is_Visitor_Reader
string (optional) Example: N

Is_Visitor_Reader

Connection_Method
string (optional) Example: L

Connection Method

Tracking
string (optional) Example: Y

Is Tracking

Other_HW_Classification_ID
integer (optional) Example: 0

Other HW Classification ID

Other_Reader_Type_ID
integer (optional) Example: 0

Other Reader Type ID

Other_Reader_ID
integer (optional) Example: 1

Other Reader ID

In_Built_Door_Access
string (optional) Example: Y

Activate_By_HW
string (optional) Example: N

Activate_By_SW
string (optional) Example: Y

Activate_Door_On_Other_HW
string (optional) Example: Y

TimeZone_Access
string (optional) Example: Y

PCM_Attendance
string (optional) Example: Y

FRWIth_Mask
string (optional) Example: Y

Response 200
Content-Type: application/json
[
    {
        "Status"               :type: string,                        
        "Message"              :type: string,
        "Reader_Detail"        : [            
            {
                "Reader_ID"    : type: integer,
                "Reader_Name"  : type: string
            }
        ] 
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"                : "ABCTEST",
    "Level_Detail_ID"            : 5,
    "Reader_ID"                  : 88,
    "Reader_Type_ID"             : 1,
    "Reader_Model_ID"            : 1,
    "Authentication_Method"      : 4,
    "Authentication_Mode"        : 1,
    "DYDNS_Name"                 : "192.02.08.10",
    "User_Name"                  : "test UName",
    "Password"                   : "test pwd",
    "IP_Address"                 : "192.06.00.05",
    "Port"                       : "584",
    "Listener_Port"              : "584",
    "Location_ID"                : 10008,
    "DoPolling"                  : "Y",
    "Job_Code_Enabled"           : "Y",
    "Is_Registration_Reader"     : "Y",
    "Is_Modification_Reader"     : "Y",
    "Upload_Template"            : "Y",
    "Delete_Template"            : "Y",
    "Active"                     : "Y",
    "Reader_Alias"               : "TestReader",
    "Reader_Group_ID"            : 1,
    "Is_Productivity_Reader"     : "Y",
    "Serialnum"                  : "1",
    "Mac_Address"                : "1343",
    "Device_ID"                  : "13",
    "Is_People_Counting"         : "N",
    "Classification"             : 2,
    "Door_ID"                    : 1,
    "Door_List_ID"               : 14,
    "Is_Attendance_Reader"       : "Y",
    "Is_Safe_Entry"              : "Y",
    "Is_Visitor_Reader"          : "N",
    "Connection_Method"          : "L",
    "Tracking"                   : "Y",
    "Other_HW_Classification_ID" : 0,
    "Other_Reader_Type_ID"       : 0,
    "Other_Reader_ID"            : 0,
    "In_Built_Door_Access"       : "Y",
    "Activate_By_HW"             : "N",
    "Activate_By_SW"             : "Y",
    "Activate_Door_On_Other_HW"  : "Y",
    "TimeZone_Access"            : "Y",
    "PCM_Attendance"             : "Y",
    "FRWIth_Mask"                : "Y"
}
Response 200
Content-Type: application/json
[
    {
        "Status"             : "Success",
        "Message"            : "Record updated successfully",
        "Reader_Detail"      : [            
            {
                "Reader_ID"  : 88,
                "Reader_Name": "TestReader"
            }
        ]   
    }
]

Search Reader

Reader
GET/SearchReader

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"              : type :string,
                                "start_index"              : type :integer,
                                "max_count"                : type :integer,
                                "Level_Detail_ID"          : type :integer,
                                "Reader_ID"                : type :integer,
                                "Reader_Alias"             : type :string,
                                "Location_ID"              : type :integer,
                                "Machinenum"               : type :integer,
                                "Serialnum"                : type :string,  
                                "Mac_Address"              : type :string,
                                "Lan_Ip_Address"           : type :string,
                                "Authentication_Method"    : type :integer,
                                "Authentication_Mode"      : type :integer,
                                "Polling_Required"         : type :string,  
                                "Is_Registration_Reader"   : type :string,
                                "Active"                   : type :char,
                                "mode"                     : type :char,
                                "fromdate"                 : type :string,
                                "todate"                   : type :string
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
start_index
integer (required) Example: 1

Record Start index from the list

max_count
integer (required) Example: 20

Maximum Record to retrieve

client_code
string (required) Example: ICS

Client Code

Level_Detail_ID
integer (optional) Example: 5

Indicate LevelDetailID

ReaderID
integer (optional) Example: 85

Respective ReaderID

Reader_Code
string (optional) Example: CONSTRUCTION

Indicate ReaderCode

Active
string (optional) Example: Y

Active/InActive

mode
string (optional) Example: C

This parameter is to indicate whether data to be filtered based on created or modified date. Provide 'C' for CREATE and 'M' for MODIFY

fromdate
string (optional) Example: YYYY-MM-DDThh:mm:ss.sTZD (eg 2021-07-16T19:20:30+01:00)

This parameter is to get profile list based on create or modified date given on MODE.

todate
string (optional) Example: YYYY-MM-DDThh:mm:ss.sTZD (eg 2021-07-16T19:20:30+01:00)

This parameter is to get Profile list based on create or modified date given on MODE.

Response 200
Content-Type: application/json
[
    {
        "Reader_ID"                     :type: integer,
        "Reader_Alias"                  :type: string,
        "location_desc"                 :type: string,
        "MachineNum"                    :type: string,
        "SerialNum"                     :type: integer,
        "Mac_Address"                   :type: string,
        "Lan_Ip_Address"                :type: string,
        "Authentication_Method"         :type: string,
        "Authentication_Mode"           :type: string,
        "Polling_Required"              :type: string,
        "Is_Registration_Reader"        :type: string,    
        "Activation_Grid"               : [            
            {
                "Reader_ID"             : type: integer,
                "Activation_Key"        : type: string,
                "Activation_DateTime"   : type: integer,
                "Active"                : type: string
            }
        ], 
        "Controller_Reader_Grid"        : [            
            {
                "Card_ID"               : type: integer,
                "Reader"                : type: string,
                "Mode"                  : type: integer,
                "Door"                  : type: string,
                "DoorList"              : type: integer,
                "Active"                : type: string
            }
        ], 

        "Active"                        :type: string,
        "CreatedDateTime"               :type: datetime,
        "ModifiedDateTime"              :type: datetime
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "start_index"               : 1,
    "max_count"                 : 50,
    "client_code"               : "ICS",
    "Level_Detail_ID"           : 1,
    "Reader_ID"                 : 88,
    "Reader_Alias"              : "TestReader",
    "Location_ID"               : 10008,
    "Machinenum"                : 12432,
    "Serialnum"                 : "1",  
    "Mac_Address"               : "1343",
    "Lan_Ip_Address"            : "192.02.08.10",
    "Authentication_Method"     : 4,
    "Authentication_Mode"       : 1,
    "Polling_Required"          : "Y",  
    "Is_Registration_Reader"    : "Y",
    "Active"                    : "Y",
    "mode"                      : "C",
    "fromdate"                  : "2019-04-20T10:00:00+05:30",
    "todate"                    : "2020-11-20T10:00:00+05:30"
}
Response 200
Content-Type: application/json
[
    {
        "Reader_ID"                     :1,
        "Reader_Alias"                  :"GATE1_IN",
        "location_desc"                 :"Test ~ Test",
        "MachineNum"                    :"1",
        "SerialNum"                     :"6715515120000639",
        "Mac_Address"                   :"",
        "Lan_Ip_Address"                :"10.10.2.11",
        "Authentication_Method"         :"3",
        "Authentication_Mode"           :"3",
        "Polling_Required"              :"Y",
        "Is_Registration_Reader"        :"Y",    
        "Activation_Grid"               : [            
            {
                "Reader_ID"             : 88,
                "Activation_Key"        : "wew354sd345",
                "Activation_DateTime"   : "2019-04-20T10:00:00+05:30",
                "Active"                : "Y"
            }
        ], 
        "Controller_Reader_Grid"        : [            
            {
                "Card_ID"               : "1",
                "Reader"                : "DoorList6",
                "Mode"                  : "LO",
                "Door"                  : "Door1~Door1",
                "DoorList"              : "DL6",
                "Active"                : "Y"
            }
        ], 

        "Active"                        :"Y",
        "CreatedDateTime"               :"2021-11-18T23:11:22+05:30",
        "ModifiedDateTime"              :"2021-11-18T23:00:50+05:30"
    }
]

Delete Reader

Reader
DELETE/DeleteReader

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"         : type :string,
                                "Reader_Details"      : [            
        {
                                "Reader_ID"           : type :integer
        }
    ]  
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ABCTEST

Client Code

Reader_Details
Reader_ID
integer (required) Example: 25

Respective ReaderID

Response 200
Content-Type: application/json
[
    {
        "Sno"      :type: integer,
        "Status"   :type: string,                        
        "Message"  :type: string
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"       :"ICS",
    "Reader_Details"    : [            
        {
            "Reader_ID" :85
        }
    ]
}
Response 200
Content-Type: application/json
[
    {
        "Sno"        : 1,
        "Status"     : "Success",
        "Message"    : "Record(s) deleted successfully"
    }
]

Add Reader Controller

Reader
POST/AddReaderController

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"              : type :string,                                            
                                "Level_Detail_ID"          : type :integer,
                                "Controller_Reader_ID"     : type :string,
                                "Card_ID"                  : type :string,
                                "Reader_ID"                : type :string,                                            
                                "Controller_Reader_Mode"   : type :string,
                                "Door_ID"                  : type :integer,
                                "Door_List_ID"             : type :integer
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Client Code

Level_Detail_ID
integer (required) Example: 5

Indicate LevelDetailID

Controller_Reader_ID
string (required) Example: 129

Indicate Controller Reader ID

Card_ID
string (required) Example: 1

Card ID

Reader_ID
string (required) Example: 103

Indicate Reader

Controller_Reader_Mode
string (required) Example: LI

Indicate Mode

Door_ID
integer (required) Example: 1

Indicate Door ID

Door_List_ID
integer (required) Example: 17

Indicate Door List ID

Response 200
Content-Type: application/json
[
    {
        "Status"             :type: string,                        
        "Message"            :type: string,
        "Controller_Detail"  : [            
            {
                "ID"         : type: integer
            }
        ]  
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"              :"ABCTEST",
    "Level_Detail_ID"          : 5,
    "Controller_Reader_ID"     : "129",
    "Card_ID"                  : "1",
    "Reader_ID"                : "103",                                            
    "Controller_Reader_Mode"   : "LI",
    "Door_ID"                  : 1,
    "Door_List_ID"             : 17
}
Response 200
Content-Type: application/json
[
    {
        "Status"            : "Success",
        "Message"           : "Record added successfully",
        "Controller_Detail" : [            
            {
                "ID"        : 85
            }
        ]   
    }
]

Edit Reader Controller

Reader
PUT/EditReaderController

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"              : type :string,                                            
                                "Level_Detail_ID"          : type :integer,
                                "ID"                       : type :integer,
                                "Controller_Reader_ID"     : type :string,
                                "Card_ID"                  : type :string,
                                "Reader_ID"                : type :string,                                            
                                "Controller_Reader_Mode"   : type :string,
                                "Door_ID"                  : type :integer,
                                "Door_List_ID"             : type :integer
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Client Code

Level_Detail_ID
integer (required) Example: 5

Indicate LevelDetailID

ID
integer (required) Example: 1

Indicate ID

Controller_Reader_ID
string (required) Example: 129

Indicate Controller Reader ID

Card_ID
string (required) Example: 1

Card ID

Reader_ID
string (required) Example: 103

Indicate Reader

Controller_Reader_Mode
string (required) Example: LI

Indicate Mode

Door_ID
integer (required) Example: 1

Indicate Door ID

Door_List_ID
integer (required) Example: 17

Indicate Door List ID

Response 200
Content-Type: application/json
[
    {
        "Status"               :type: string,                        
        "Message"              :type: string,
        "Controller_Detail"    : [            
            {
                "ID"           : type: integer
            }
        ] 
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"              :"ABCTEST",
    "Level_Detail_ID"          : 5,
    "ID"                       : 1,
    "Controller_Reader_ID"     : "129",
    "Card_ID"                  : "1",
    "Reader_ID"                : "103",                                            
    "Controller_Reader_Mode"   : "LI",
    "Door_ID"                  : 1,
    "Door_List_ID"             : 17
}
Response 200
Content-Type: application/json
[
    {
        "Status"             : "Success",
        "Message"            : "Record updated successfully",
        "Controller_Detail"  : [            
            {
                "Reader_ID"  : 1
            }
        ]   
    }
]

Search Reader Controller

Reader
GET/SearchReaderController

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"              : type :string,
                                "start_index"              : type :integer,
                                "max_count"                : type :integer,
                                "ID"                       : type :integer,
                                "Controller_Reader_ID"     : type :string,
                                "Card_ID"                  : type :string,
                                "Reader_ID"                : type :string,                                            
                                "Controller_Reader_Mode"   : type :string,
                                "Door_ID"                  : type :integer,
                                "Door_List_ID"             : type :integer                                               
                                "Active"                   : type :char,
                                "mode"                     : type :char,
                                "fromdate"                 : type :string,
                                "todate"                   : type :string
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
start_index
integer (required) Example: 1

Record Start index from the list

max_count
integer (required) Example: 20

Maximum Record to retrieve

client_code
string (required) Example: ICS

Client Code

ID
integer (required) Example: 1

Indicate ID

Controller_Reader_ID
string (required) Example: 129

Indicate Controller Reader ID

Card_ID
string (required) Example: 1

Card ID

Reader_ID
string (required) Example: 103

Indicate Reader

Controller_Reader_Mode
string (required) Example: LI

Indicate Mode

Door_ID
integer (required) Example: 1

Indicate Door ID

Door_List_ID
integer (required) Example: 17

Indicate Door List ID

Active
string (optional) Example: Y

Active/InActive

mode
string (optional) Example: C

This parameter is to indicate whether data to be filtered based on created or modified date. Provide 'C' for CREATE and 'M' for MODIFY

fromdate
string (optional) Example: YYYY-MM-DDThh:mm:ss.sTZD (eg 2021-07-16T19:20:30+01:00)

This parameter is to get profile list based on create or modified date given on MODE.

todate
string (optional) Example: YYYY-MM-DDThh:mm:ss.sTZD (eg 2021-07-16T19:20:30+01:00)

This parameter is to get Profile list based on create or modified date given on MODE.

Response 200
Content-Type: application/json
[
    {
        "Card_ID"                   :type: string,
        "Reader_Name"               :type: string,
        "location_desc"             :type: string,
        "Mode"                      :type: string,
        "Door"                      :type: string,
        "Door_List"                 :type: string,        
        "Active"                    :type: string,
        "CreatedDateTime"           :type: datetime,
        "ModifiedDateTime"          :type: datetime
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "start_index"              : 1,
    "max_count"                : 50,
    "client_code"              : "ICS",
    "ID"                       : 1,
    "Controller_Reader_ID"     : "129",
    "Card_ID"                  : "1",
    "Reader_ID"                : "103",                                            
    "Controller_Reader_Mode"   : "LI",
    "Door_ID"                  : 1,
    "Door_List_ID"             : 17,
    "Active"                   : "Y",
    "mode"                     : "C",
    "fromdate"                 : "2019-04-20T10:00:00+05:30",
    "todate"                   : "2020-11-20T10:00:00+05:30"
}
Response 200
Content-Type: application/json
[
    {
        "Card_ID"           : 7845651,
        "Reader_Name"       : "DoorListTest1",
        "Mode"              : "LO",
        "Door"              : "Door1 ~ Door1",
        "Door_List"         : "",
        "Active"            : "Y",
        "CreatedDateTime"   : "2019-04-24T08:16:42+05:30",
        "ModifiedDateTime"  : "2021-02-06T14:50:31+05:30"
    }
]

Delete Reader Controller

Reader
DELETE/DeleteReaderController

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"      : type :string,
                                "Reader_Details"   : [            
        {
                                "ID"               : type :integer
        }
    ]  
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Client Code

Reader_Details
ID
integer (required) Example: 25

Respective ReaderID

Response 200
Content-Type: application/json
[
    {
        "Sno"      :type: integer,
        "Status"   :type: string,                        
        "Message"  :type: string
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"       :"ICS",
    "Reader_Details"    : [            
        {
            "ID"        :1
        }
    ]
}
Response 200
Content-Type: application/json
[
    {
        "Sno"        : 1,
        "Status"     : "Success",
        "Message"    : "Record(s) deleted successfully"
    }
]

Search ActiveUser

Reader
GET/SearchActiveUser

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
    "client_code"    : type :string,
    "MachineNumber"  : type :integer,
    "Level_Detail_ID": type :integer

}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (Required) Example: ICS

Client Code

MachineNumber
integer (optional) Example: 5

Respective Machinenumber

Level_Detail_ID
integer (Required) Example: 5

Respective Level_Detail_ID

Response 200
Content-Type: application/json
[
    {
        "SNo"          :type: integer,
        "ProfileID"    :type: integer,
        "BiometricID"  :type: integer,
        "Name"         :type: string,
        "Gender"       :type: string,
        "DateofBirth"  :type: datetime,
        "Nationality"  :type: string,
        "Division"     :type: string,
        "Department"   :type: string,
        "Category"     :type: string,
        "Section"      :type: string
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{

    "client_code"     : "ICS",
    "MachineNumber"   : 5,
    "Level_Detail_ID" : 5
   
}
Response 200
Content-Type: application/json
[
    {
        "SNo"          :1,
        "ProfileID"    :128,
        "BiometricID"  :65,
        "Name"         :"Pedro Pecor",
        "Gender"       :"MALE",
        "DateofBirth"  :"01-03-2000 12.00.00 AM",
        "Nationality"  :"SINGAPOREAN",
        "Division"     :"OPERATIONS",
        "Department"   :"NA",
        "Category"     :"NA",
        "Section"      :"NA"
    },
    {
        "SNo"          :2,
        "ProfileID"    :718,
        "BiometricID"  :655,
        "Name"         :"Granville Puett",
        "Gender"       :"MALE",
        "DateofBirth"  :"01-03-2000 12.00.00 AM",
        "Nationality"  :"SINGAPOREAN",
        "Division"     :"OPERATIONS",
        "Department"   :"NA",
        "Category"     :"NA",
        "Section"      :"NA"
    }
]

PayRoll

    You can able to fetch PayRoll.

PayRoll

SearchPayRoll
GET/SearchPayRoll

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
        "client_code"      : type :string,
        "Year"             : type :integer,
        "Month"            : type :integer,
        "ProfileID_From"   : type :string,
        "ProfileID_To"     : type :string,
        "BiometricID_From" : type :string,
        "BiometricID_To"   : type :string,
        "Name"             : type :string,
        "Nationality_ID"   : type :string,
        "Division_ID"      : type :string,
        "Department_ID"    : type :string,
        "Category_ID"      : type :string,
        "EmploymentType_ID": type :string,
        "Level_Detail_ID"  : type :integer
        "ExportFields"     : [
                {
                  "DisplayName"   : type :string
                },
                {
                    "DisplayName" : type :string
                },
                {
                    "DisplayName" : type :string
                }
        ]
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Client Code

Year
integer (required) Example: 2020

Record to fetch year based

Month
integer (required) Example: 5

Record to fetch month based

ProfileID_From
string (optional) Example: 1

Record to fetch profile id between from and to

ProfileID_To
string (Optional) Example: 15

Record to fetch profile id between from and to

BiometricID_From
string (optional) Example: 1

Record to fetch biometric id between from and to

BiometricID_To
string (Optional) Example: 15

Record to fetch biometric id between from and to

Name
string (Optional) Example: DL4

Indicate staff Name

Nationality_ID
string (Optional) Example: 10

Indicate Nationality

Division_ID
string (Optional) Example: 2

Indicate Division

Department_ID
string (Optional) Example: Y

Indicate Department

Category_ID
string (Optional) Example: 10

Indicate Category

EmploymentType_ID
string (Optional) Example: 2

Indicate Employement Type

Level_Detail_ID
integer (Optional) Example: 5

Indicate LevelDetails

ExportFields
Array (Required) Example: India

User wants the fields

Response 200
Note: ExportFields these any one of the follwing fields are mandatory 
Profile ID, Biometric ID
 
Note: Response content/values will differ depending on demanding fields 
from request parameter - "ExportFields"
Content-Type: application/json
{

    "SNo"          :type: string,
    "Biometric_ID" :type: string,
    "Profile_ID"   :type: string,
    "Name"         :type: string,
    "Nationality"  :type: string,
    "Division"     :type: string,
    "Department"   :type: string,
    "Category"     :type: string,
    "Section"      :type: string,
    "Period"       :type: string,
    "Cycle"        :type: string,
    "Date"         :type: string
    

}
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"       : "ICS",
    "Year"              : 2020,
    "Month"             : 5,
    "ProfileID_From"    : "1",
    "ProfileID_To"      : "15",
    "BiometricID_From"  : "1",
    "BiometricID_To"    : "15",
    "Name"              : "Android",
    "Nationality_ID"    : "10",
    "Division_ID"       : "12",
    "Department_ID"     : "15",
    "Category_ID"       : "18",
    "EmploymentType_ID" : "20",
    "Level_Detail_ID"   : "5",
    "ExportFields"      : [
            {
                "DisplayName"  : "Profile ID"
                
            },
            {
                "DisplayName"  : "Biometric ID"
            },
            {
                "DisplayName"  : "Name"
            }
    ]
}
Response 200
Content-Type: application/json
[
    {
        "SNo"          :"1",
        "Biometric_ID" :"5",
        "Profile_ID"   :"5",
        "Name"         :"Jack",
        "Nationality"  :"NA",
        "Division"     :"NA",
        "Department"   :"NA"
        "Category"     :"NA",
        "Section"      :"NA",
        "Period"       :"202103",
        "Cycle"        :"E",
        "Date"         :"01-03-2021"
    }
]

UserTemplate

        You can able to add the UserTemplate data.

Add UserTemplate

UserTemplate
POST/AddUserTemplate

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
    "client_code"                          : type :string,                                            
    "Level_Detail_ID"                      : type :integer,
    "Reader_ID"                            : type :integer,
    "UserTemplate_Detail"                  :  [            
        {
            "BiometricId"           :type :integer,
            "Template"              :type :string,
            "CardNumber"            :type :string,
            "Name"                  :type :string,
            "FingerId"              :type :string,
            "CardType"              :type :string,
            "UserPassword"          :type :string,
            "DownloadedMachineNum"  :type :integer
        }
    ]
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Client Code

Level_Detail_ID
integer (required) Example: 5

Indicate LevelDetailID

Reader_ID
integer (required) Example: 6

UserTemplate_Detail
array (required) Example: []

Contain Template Details

BiometricId
integer (required) Example: 1

biometric id

Template
string (required) Example: /9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCAKAAncDASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/

CardNumber
string (required) Example: 0Xffffffff

CardNumber

Name
string (required) Example: Kelvin Koh

Name

FingerId
string (required) Example: 25

FingerId

CardType
string (required) Example: FACE

CardType

UserPassword
string (required) Example: Password

UserPassword

DownloadedMachineNum
integer (required) Example: 5

DownloadedMachineNum

Response 200
Content-Type: application/json
[
    {
        "Status"                    :type: string,                        
        "Message"                   :type: string,         
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"                   :"ICS",
    "Level_Detail_ID"               :1,
    "Reader_ID"                     :6,
    "UserTemplate_Detail"           : [            
        {
            "BiometricId"           : 5,
            "Template"              : "/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCAKAAncDASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/",
            "CardNumber"            : "0Xffffffff",
            "Name"                  : "Kelvin Koh",
            "FingerId"              : "25",
            "CardType"              : "FACE",
            "UserPassword"          : "Password",
            "DownloadedMachineNum"  : 5
        }
    ] 
}
Response 200
Content-Type: application/json
[
    {
        "Status"                : "Success",
        "Message"               : "Record added successfully",          
    }
]

Edit UserTemplate

UserTemplate
PUT/EditUserTemplate

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
    "client_code"                          : type :string,                                            
    "Level_Detail_ID"                      : type :integer,
    "Reader_ID"                            : type :integer,
    "UserTemplate_Detail"                  :  [            
        {
            "BiometricId"           :type :integer,
            "Template"              :type :string,
            "CardNumber"            :type :string,
            "Name"                  :type :string,
            "FingerId"              :type :string,
            "CardType"              :type :string,
            "UserPassword"          :type :string,
            "DownloadedMachineNum"  :type :integer
        }
    ]
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Client Code

Level_Detail_ID
integer (required) Example: 5

Indicate LevelDetailID

Reader_ID
integer (required) Example: 6

UserTemplate_Detail
array (required) Example: []

Contain Template Details

BiometricId
integer (required) Example: 1

biometric id

Template
string (required) Example: /9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCAKAAncDASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/

CardNumber
string (required) Example: 0Xffffffff

CardNumber

Name
string (required) Example: Kelvin Koh

Name

FingerId
string (required) Example: 25

FingerId

CardType
string (required) Example: FACE

CardType

UserPassword
string (required) Example: Password

UserPassword

DownloadedMachineNum
integer (required) Example: 5

DownloadedMachineNum

Response 200
Content-Type: application/json
[
    {
        "Status"                    :type: string,                        
        "Message"                   :type: string,        
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"                   :"ICS",
    "Level_Detail_ID"               :1,
    "Reader_ID"                     :6,
    "UserTemplate_Detail"           : [            
        {
            "BiometricId"           : 5,
            "Template"              : "/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCAKAAncDASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/",
            "CardNumber"            : "0Xffffffff",
            "Name"                  : "Kelvin",
            "FingerId"              : "25",
            "CardType"              : "FACE",
            "UserPassword"          : "",
            "DownloadedMachineNum"  : 5
        }
    ] 
}
Response 200
Content-Type: application/json
[
    {
        "Status"             : "Success",
        "Message"            : "Record updated successfully",           
    }
]

Search UserTemplate

UserTemplate
GET/SearchUserTemplate

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
    "client_code"      : type :string,
    "start_index"      : type :integer,
    "max_count"        : type :integer,
    "mode"             : type :char,
    "Level_Detail_ID"  : type :integer,
    "User_ID"          : type :integer,
    "User_Name"        : type :string,                                               
    "Card_Number"      : type :string,
    "Card_Type"        : type :string,
    "User_Type"        : type :string,
    "Reader_Id"        : type :integer,
    "Verify_Type"      : type :string,
    "fromdate"         : type :string,
    "todate"           : type :string
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
start_index
integer (required) Example: 1

Record Start index from the list

max_count
integer (required) Example: 20

Maximum Record to retrieve

client_code
string (required) Example: ICS

Client Code

mode
string (optional) Example: C

This parameter is to indicate whether data to be filtered based on created or modified date. Provide 'C' for CREATE and 'M' for MODIFY

Level_Detail_ID
integer (optional) Example: 5

Indicate LevelDetailID

User_ID
integer (optional) Example: 51

Indicate User ID

User_Name
string (optional) Example: Ram

User Name

Card_Number
string (optional) Example: 0XffffffffCard Number

normal

Card_Type
string (optional) Example: FACE

CardType

User_Type
string (optional) Example: YUserType

normal

Reader_ID
string (optional) Example: 76

Indicate Reader

Verify_Type
string (optional) Example: normal

fromdate
string (optional) Example: YYYY-MM-DDThh:mm:ss.sTZD (eg 2021-07-16T19:20:30+01:00)

This parameter is to get profile list based on create or modified date given on MODE.

todate
string (optional) Example: YYYY-MM-DDThh:mm:ss.sTZD (eg 2021-07-16T19:20:30+01:00)

This parameter is to get Profile list based on create or modified date given on MODE.

Response 200
Content-Type: application/json
[
    {
        "User_ID"           :type: integer,
        "User_Name"         :type: string,
        "Template"          :type: string,
        "Card_Number"       :type: string,
        "Card_Type"         :type: string,
        "Password"          :type: string,
        "User_Type"         :type: string,
        "Verify_Type"       :type: string,
        "CreatedDateTime"   :type: datetime,
        "ModifiedDateTime"  :type: datetime
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"       : "ICS",
    "start_index"       : 1,
    "max_count"         : 50,
    "mode"              : "C",
    "Level_Detail_ID"   : 5,
    "User_ID"           : 51,
    "User_Name"         : "Ram",
    "Card_Number"       : "0Xffffffff",
    "Card_Type"         : "FACE",
    "User_Type"         : "normal",
    "Reader_Id"         : 76,
    "Verify_Type"       : "",
    "fromdate"          : "2021-04-20T10:00:00+05:30",
    "todate"            : "2021-11-20T10:00:00+05:30"
}
Response 200
Content-Type: application/json
[
    {
        "User_ID"           : 51,
        "User_Name"         : "Ram",
        "Template"          : "/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCAKAAncDASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/",
        "Card_Number"       : "0Xffffffff",
        "Card_Type"         : "FACE",
        "Password"          : "Password",
        "User_Type"         : "normal",
        "Verify_Type"       : "",
        "CreatedDateTime"   : "2019-04-24T08:16:42+05:30",
        "ModifiedDateTime"  : "2021-02-06T14:50:31+05:30"
    }
]

Delete UserTemplate

UserTemplate
DELETE/DeleteUserTemplate

Schema
HideShow

Request Header

Authorization  : type : Bearer <space> string

Request Body

Content-Type:  application/json
{
                                "client_code"          : type :string,
                                "Level_Detail_ID"      : type :integer,
                                "Reader_Id"            : type :string,
                                "UserTemplate_Detail"  : [            
        {
                                "BiometricId"          : type :integer
        }
    ]  
}
Request Header Parameters
HideShow
Authorization
string (required) Example: Bearer

VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw

Request Body Parameters
HideShow
client_code
string (required) Example: ICS

Client Code

Level_Detail_ID
integer (required) Example: 5

Indicate LevelDetailID

Reader_ID
integer (required) Example: 6

UserTemplate_Detail
array (required) Example: []

Contain Template Details

BiometricId
integer (required) Example: 25

BiometricId

Response 200
Content-Type: application/json
[
    {                                
        "Message"  :type: string,
        "Status"   :type: string
    }
]
Example
HideShow
Request Header
Authorization: Bearer VXJvdm86RUVGNDdEOUEtREJBOS00RDAyLUI3QjAtMDRGNDI3OUE2RDIw
Request Body
Content-Type: application/json
{
    "client_code"           :"ICS",
    "Level_Detail_ID"       :1,
    "Reader_Id"             :6,
    "UserTemplate_Detail"   : [            
        {
            "BiometricId"   :5
        }
    ]
}
Response 200
Content-Type: application/json
[
    {
        "Status"     : "Success",
        "Message"    : "Record(s) deleted successfully"
    }
]

Generated by Intercorp Solutions Version 2.00.0.0