Touch CEPM

Content

  • Overview
  • Method
  • Authorization
  • Add Employee
  • Update Employee Details
  • Delete Employee
  • Validate Card
  • Retrieve Card Info
  • Response Codes

Overview

Dialog Touch - CEPM API allows an application to add, update, delete employee and validate card, retrieve card info. These services are accessible via RESTful web services.

Methods

The following REST methods are available:

  • Send an employee from your Web Application
  • Update an employee from your Web Application
  • Delete an employee from your Web Application
  • Validate card to your Web Application
  • Retrieve card info to your Web Application

Authorization API calls

All API call request to ideabiz.lk required Authorization headers. Please refer ( http://docs.ideabiz.lk/Getting_Started/Token_Manegment) for the Authorization.

Request header

Content-Type: application/json

Authorization: Bearer [access token]

Accept: application/json

Add Employee

This allows you to send an employee from your Web application to Touch � CEPM

Request

Following is a sample request of the service (Add Employee).

URL

https://ideabiz.lk/apicall/CEPM/1.0/employee

Method

PUT

Username: <Username>

Password: <Password>

UnitCode: <UnitCode>

Body

  {

   "title":"Mr",

   "firstName":"Shashika",

   "lastName";:"Chathumadusha",

   "mobile":"07xxxxxxx",

   "DOB":"17/06/1992",

   "Address1":"No.475",

   "Address2":"Union Place",

   "Address3":"Colombo 02",

   "employeeNo":"07806",

   "IDType":"NIC",

   "IDNo":"999999999V",

   "EPFNo":"07799",

   "key":"EMP001",

   "SBU":"SBU1",

   "addedBy":"user1",

   "status":"1",

   "Branch":"B4"

  }

Following are the Request parameters of the service (Add Employee).

Name Type Description Data Type Availability Comment
Username Header Username to login to API String Required
Password Header Password to login to API String Required
UnitCode Header Unit Code to identify corporate String Required
title Body Title of employee <String> Required
firstName Body First name <String> Required
lastName Body Last Name <String> Optional
mobile Body Mobile number <String> Optional
DOB Body Date of birth <String> Optional Format: dd/MM/yyyy
Address1 Body Address line1 <String> Optional
Address2 Body Address line2 <String> Optional
Address3 Body Address line3 <String> Optional
employeeNo Body Employee Number <String> Required
IDType Body Type of ID number <String> Required NIC,PP
IDNo Body ID number <String> Required
EPFNo Body EPF number <String> Optional
key Body Unique key to identify the employee <String> Required
SBU Body SBU <String> Required
addedBy Body User who calls this API <String> Required
status Body Active/inactive status of employee <int> Required 1-Active0-Inactive

Response

Following is a sample response of the service (Add Employee).

{

   "state" : 1,

   "msg" : "Success",

   "key" : "EMP001"

}

Following are the Request parameters of the service (Add Employee).

Name Type Description Data Type Availability Comment
state Body Status of the Transaction <int> Required See status codes table
msg Body Response message <String> Optional
key Body Unique key to identify the employee <String> Required The key sent when calling API

Update Employee Details

This allows you to update an employee details from your Web application to Touch � CEPM

Request

Following is a sample request of the service (Update Employee Details).

URL

https://ideabiz.lk/apicall/CEPM/1.0/employee/{employeeKey}

Method

POST

Username: <Username>

Password: <Password>

UnitCode: <UnitCode>

Body

    {

     "title":"Mr",

     "firstName":"Shashika",

     "lastName";:"Chathumadusha",

     "mobile":"07xxxxxxx",

     "DOB":"17/06/1992",

     "Address1":"No.475",

     "Address2":"Union Place",

     "Address3":"Colombo 02",

     "employeeNo":"07806",

     "IDType":"NIC",

     "IDNo":"999999999V",

     "EPFNo":"07799",

     "key":"EMP001",

     "SBU":"SBU1",

     "modifiedBy":"user1",

     "status":"1",

     "Branch":"B4"

    }

Following are the Request parameters of The service (Update Employee Details).

Name Type Description Data Type Availability Comment
Username Header Username to login to API String Required
Password Header Password to login to API String Required
UnitCode Header Unit Code to identify corporate String Required
title Body Title of employee <String> Required
firstName Body First name <String> Required
lastName Body Last Name <String> Optional
mobile Body Mobile number <String> Optional
DOB Body Date of birth <String> Optional
Address1 Body Address line1 <String> Optional
Address2 Body Address line2 <String> Optional
Address3 Body Address line3 <String> Optional
employeeNo Body Employee number <String> Required
IDType Body Type of ID number <String> Required NIC,PP
IDNo Body ID number <String> Required
EPFNo Body EPF number <String> Optional
key Body Unique key to identify the employee <String> Required
SBU Body SBU <String> Required
modifiedBy Body User who calls this API <String> Required
status Body Active/inactive status of employee <int> Required 1-Active0-Inactive

Response

Following is a sample response of the service (Update Employee Details).

  {

     "state" : 1,

     "msg" : "Success",

     "key" : "EMP001"

  }

Following are the Request parameters of the service

Name Type Description Data Type Availability Comment
state Body Status of the Transaction <int> Required See status codes table
msg Body Response message <String> Optional
key Body Unique key to identify the employee <String> Required The key sent when calling API

Delete Employee

This allows you to delete an employee from your Web application in Touch � CEPM.

Request

Following is a sample request of the service (Delete Employee).

URL

https://ideabiz.lk/apicall/CEPM/1.0/employee/{employeeKey}?un={modifiedByUsername}

Method

DELETE

  Username: <Username>

  Password: <Password>

  UnitCode: <UnitCode>

Validate Card

This allows you to validate card information from Touch � CEPM to your Web application.

Request

Following is a sample request of the service (Validate Card).

URL

https://ideabiz.lk/apicall/CEPM/1.0/card/validate

Method

POST

Username: <Username>

Password: <Password>

UnitCode: <UnitCode>

Body

{

 "cardUID":"777000000006",

 "cardDID":"777000000086",

 "unitCode":"UT00421",

 "serviceCode":"Service001"

}

Following are the Request parameters of the service (Validate Card).

Name Type Description Data Type Availability
Username Header Username to login to API String Required
Password Header Password to login to API String Required
cardUID Body Card UID <String> Required
cardDID Body Card DID <String> Required
unitCode Body Unit Code <String> Required
serviceCode Body Service Code <String> Required

Response

Following is a sample response of the service (Validate Card**).**

{

  "status": "OK",

  "statusCode": "200",

  "statusMsg": [

    "Success"

  ],

  "cardUID": 1,

  "cardDID": 1,

  "unitCode": 1,

  "serviceCode": 1

}

Following are the response parameters of the service (Validate Card**).**

Name Type Description Data Type Availability Comment
status Body Status of the transaction <String> Required
statusCode Body Status Code of the transaction <String> Required
statusMsg Body Status Messages of the transaction List<String> Required
cardUID Body Valid Card UID or not <int> Required Valid - 1Invalid - 0
cardDID Body Valid Card DID or not <int> Required Valid - 1Invalid - 0
unitCode Body Valid Unit code or not <int> Required Valid - 1Invalid - 0
serviceCode Body Valid Service code or not <int> Required Valid - 1Invalid - 0

Retrieve Card Info

This allows you to retrieve card information from Touch � CEPM to your Web application.

Request

Following is a sample request of the service (Retrieve Card Info).

URL

https://ideabiz.lk/apicall/CEPM/1.0/card/retrieve/did

Method

POST

Username: <Username>

Password: <Password>

UnitCode: <UnitCode>

Body

{

 "unitCode":"UT02182",

 "cardUID":"77404929478000",

 "serviceCode":"service11";

}

Following are the Request parameters of the service (Retrieve Card Info).

Name Type Description Data Type Availability
Username Header Username to login to API String Required
Password Header Password to login to API String Required
unitCode Body Unit Code <String> Required
cardUID Body Card UID <String> Required
serviceCode Body Service Code <String> Required

Response

Following is a sample response of send service (Retrieve Card Info).

{

  "status": "OK",

  "statusCode": "200",

  "statusMsg": [

    "Success"

  ],

  "uid": "77404929478000",

  "did": "77404929478",

  "unitCode": 1,

  "cardUID": 1,

  "serviceCode": 1

}

Following are the response parameters of the service (Retrieve Card Info).

Name Type Description Data Type Availability Comment
status Body Status of the transaction <String> Required
statusCode Body Status Code of the transaction <String> Required
statusMsg Body Status Messages of the transaction List<String> Required
uid Body Card UID <String> Required
did Body Card DID <Sting> Required
cardUID Body Valid Card UID or not <int> Required Valid - 1Invalid - 0
unitCode Body Valid Unit code or not <int> Required Valid - 1Invalid - 0
serviceCode Body Valid Service code or not <int> Required Valid - 1Invalid - 0

Response Codes

Employee API

Code Msg
0 Success
1 Unauthorized
2 Validation Failed
3 Unknown error

Card API

statusCode status
200 Ok
401 Unauthorized Request
400 Validation Failure
500 Unknown error
Last updated on 4th Apr 2017