all data is live and searchable
|
Main Web API Documentation Information
|
|
|
Actual Page/Function Name:
|
checkLastTimeCard |
|
Human Readable Name or Caption:
|
Check Last Time Card |
|
Page/Function Description:
|
This method checks for the last timecard for a specific user. |
|
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 | CORP_ID | Numeric | 0 | Pass in the corp id number. | Yes | ||
| Arguments | PAYEE_ID | Numeric | 0 | Pass in the payee id number. | Yes | ||
|
Results
|
||||
| RET_STATUS | RET_MAIN_MESSAGE | RET_SECOND_MESSAGE | Redirect Link | Description |
| ok | success | This assumes that everything went well. | ||
| ok | success | This assumes that everything went well. | ||
| dataIn | Unable to get data from last timecard. 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. | |
| corpSettings | Missing the correct corp-wide settings. Unable to proceed. | Use your back button and try again. | This is returned if no corp settings could be found associated with the CORP_ID. | |
| outstandingTimecard | According to the system, there is an open timecard from a different [QRY_GET_CORP_RETURN_SETTINGS]. | An error occurred while trying to get the data for the outstanding (still open) timecard. No data was returned. Unable to proceed. Use your back button and try again. If this error continues, you may need to contact support. | This is returned if no time card info could be found associated with the LAST_TIME_CARD. | |
| corp | According to the system, you still have an open timecard from a different [QRY_GET_CORP_RETURN_SETTINGS]. | You must clock out from inside the other [QRY_GET_CORP_RETURN_SETTINGS]. Once you do that, you will be able to clock in again. Please switch to that [QRY_GET_CORP_RETURN_SETTINGS] and try again. The [QRY_GET_CORP_RETURN_SETTINGS] where the open timecard is: [CORP_NAME]. | This is returned if the timecard is in the wrong corporation. | |
| db | Unable to connect to the database. Missing last timecard data. | Use your back button and try again. | This is a catch for any errors that occur while accessing the database. | |
| zero | Unable to retrieve the last timecard info. | Use your back button and try again. | This is returned if no time card info could be found associated with the LAST_TIME_CARD and CORP_ID. | |
|
Samples
|
|
| Caption | Text |
| JSON |
{
"API_CALL_FUNCTION_NAME": "checkLastTimeCard",
"CORP_ID": 53,
"PAYEE_ID": 3191,
"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"
}
|