all data is live and searchable
|
Main Web API Documentation Information
|
|
|
Actual Page/Function Name:
|
clockInOut |
|
Human Readable Name or Caption:
|
Clock In Out |
|
Page/Function Description:
|
This method will either do a clock in or a clock in or a clock out depending on what is passed in. |
|
Page/Function Output Type:
|
API - JSON or WDDX |
|
Categories:
|
user,payroll |
|
Extra Page/Function Notes:
|
|
|
Parameters
|
|||||||
| Scope | Name | Type | Default | Description | Required | Alternates | Known Values |
| Arguments | ADJUSTED_DATE_TIME | String | Pass in the adjusted date/time value. | Yes | |||
| Arguments | CORP_ID | Numeric | 0 | Pass in the corp id number. | Yes | ||
| Arguments | DEPARTMENT_ID | Numeric | 0 | Pass in the department id number. | Yes | ||
| Arguments | NOTES | String | Pass in any notes for the clock in/out. | Yes | |||
| Arguments | PAYEE_ID | Numeric | 0 | Pass in the payee id number. | Yes | ||
| Arguments | REASON_ID | Numeric | 0 | Pass in the reason id number. - '1', 'Dummy' '2', 'Start Work' '3', 'Going Home' '4', 'Lunch' '5', 'Health' '6', 'Family' '7', 'School' '8', 'Other' '9', 'Sick Pay' '10', 'Vacation Pay' '11', 'Holiday Pay' | Yes | ||
| Arguments | TIME_CARD_ID | String | Pass in the timecard id as a string. This might be the value new or an actual number. | Yes | |||
| Arguments | USE_IP_ADDRESS | String | Pass in the IP address. | Yes | |||
|
Results
|
||||
| RET_STATUS | RET_MAIN_MESSAGE | RET_SECOND_MESSAGE | Redirect Link | Description |
| ok | Successfully clocked in at [SUCCESS_MESSAGE_TIME] on [SUCCESS_MESSAGE_DATE]. | Thank You! Where can we take you? [interactive map] [classic homepage] [my hours] | This assumes that everything went well. | |
| ok | Successfully clocked out at #successMessageTime# on #successMessageDate#. | Thank You! Where can we take you? [interactive map] [classic homepage] [my hours] | This assumes that everything went well. | |
| dataIn | Unable to clock in/out. Missing some data. | Use your back button and try again. | This is returned if missing one or more of the following arguments: CORP_ID, PAYEE_ID, DEPARTMENT_ID, REASON_ID. | |
| dataIn2 | Unable to clock in/out. Missing clock in/out date and time. | Use your back button and try again. | This is returned if argument ADJUSTED_DATE_TIME is not a date. | |
| db | Unable to connect to the database. Clock in was unsuccessful. | Use your back button and try again. | This is a catch for any errors that occur while accessing the database. | |
| timeCardId | Unable to clock you out of the system. Missing the timecard id number. | Use your back button and try again. | This is returned if TIME_CARD_ID is not numeric. | |
| db2 | Unable to connect to the database. Clock out was unsuccessful. | Use your back button and try again. | This is a catch for any errors that occur while accessing the database. | |
| db2 | Unable to connect to the database. Clock out was unsuccessful. | Use your back button and try again. | This is a catch for any errors that occur while accessing the database. | |
|
Samples
|
|
| Caption | Text |
| JSON |
{
"API_CALL_FUNCTION_NAME": "clockInOut",
"ADJUSTED_DATE_TIME": "",
"CORP_ID": 53,
"DEPARTMENT_ID": 138,
"NOTES": "",
"PAYEE_ID": 3191,
"REASON_ID": 0,
"TIME_CARD_ID": "",
"USE_IP_ADDRESS": "",
"API_CORP_KEY_ID": "PLA-0053",
"API_USER_NAME": "demo",
"API_USER_PASSWORD": "1234",
"API_INPUT_OUTPUT_TYPE": "JSON",
"API_CURRENT_PAYEE_ID": "3191",
"API_URL_ENCODING": "AUTO"
}
|