Api doc


SDK's


Api Modules

timeclock.location

Clockin location management.



Supported Methods:

CREATE
Params
  • token (Required): valid token
  • name (Required): varchar
  • type: enum (1, 2)
  • ip: varchar
  • description: varchar


DELETE
Params
  • token (Required): valid token
  • id (Required): integer
  • type: integer


GET
Params
  • token (Required): valid token


Documentation

CREATE
Create clock in/out location.
Level 3 is required.

--

Parameters:

  1. "name": required //Location name (varchar)
  2. "type": required //Location type (enum[1,2])
  3. /* 1: Computer
  4.   * 2: IP address */
  5. "ip": required //IP address (varchar)
  6. "description": accepted //Description (varchar)
  7. "token": "xxxxxxx" //Valid token is required

Example Request:

  1. {
  2. "module":"timeclock.location",
  3. "method":"CREATE",
  4. "request":{
  5. "name":"Testing",
  6. "ip":"xxx.xxx.xx.x",
  7. "type":"2",
  8. "description":"Testing locations"
  9. }
  10. }

Example Response:

  1. {
  2. "status":1,
  3. "data":"Location added",
  4. "token":"xxxxxxx"
  5. }

---

DELETE
Delete clock in/out location.
Level 3 is required.

--

Parameters:

  1. "id": required //Location id (integer)
  2. "token": "xxxxxxx" //Valid token is required

Example Request:

  1. {
  2. "module":"timeclock.location",
  3. "method":"DELETE",
  4. "request":{
  5. "id":123456
  6. }
  7. }

Example Response:

  1. {
  2. "status":1,
  3. "data":"Location removed",
  4. "token":"xxxxxxx"
  5. }

GET STARTED NOW

Free Trial. No Credit Card Required.

close
(e.g.+14158675309 or +1415-8675-309)

By clicking "Create my ShiftPlanning Account" you agree to the Terms of Service and Privacy Policy.

Have a promotional code?Click Here


LIVE CHAT DEMO REQUEST!

Please provide information below.

close
INSTANT DEMOSCHEDULED DEMO
Connect with a ShiftPlanning Team Member for a live demo right now!
 

RESELLER REQUEST!

Please provide information below.

close