API Dashboard

Taffy 3.8.0

Resources:

telemappertimeShifts DELETE PATCH PUT POST GET /timeShifts

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Inputs
required string token
required string date (default: "")

Passing a date is no longer necessary. Internally, the time passed will be today offset by the user's timezone.

optional numeric internal (default: 0)

Used if function is called internally. Ignore for external use.

required numeric officeId (default: 0)

telemapperroadshowEvents DELETE PATCH PUT POST GET /telemapper/roadshowEvents

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Roadshow Events
Inputs
required string token (default: "")
required string date1 (default: "")
required string date2 (default: "")
optional string ownerName (default: "")
optional string retailerName (default: "")
optional string eventIds (default: "")
optional string programIds (default: "")
optional boolean roadShowOnly (default: false)
optional numeric limit (default: -1)
optional string dateFormat (default: MM/dd/yyyy)
optional string timeFormat (default: hh:mm:ss tt)
optional numeric filterBy (default: 0)
optional numeric officeId (default: 0)

telemapperroadshowEventsLog DELETE PATCH PUT POST GET /telemapper/roadshowEvenetsLog

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Roadshow Event Logs
Inputs
required string token (default: "")
required string asOfDate (default: "")
optional string dateFormat (default: MM/dd/yyyy)
optional string timeFormat (default: hh:mm:ss tt)
optional boolean roadShowOnly (default: 1)
optional string eventIds (default: "")
optional string endDate (default: "")
optional numeric officeId (default: 0)

telemappermadeMedia_locations DELETE PATCH PUT POST GET /telemapper/madeMedia_locations

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

GET
Event Schedule and Locations
Inputs
required string token
required string repId
required float latitude
required float longitude
optional string programId (default: 1529,1546)
optional numeric officeId (default: 0)

telemapperemployeeSchedule DELETE PATCH PUT POST GET /telemapper/employeeSchedule

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
TeleMapper Employee Schedule
Inputs
required string token
optional boolean includeDDTotals (default: true)
required string workDate (default: "")
required numeric officeId (default: 0)

telemapperemployee_timecard DELETE PATCH PUT POST GET /telemapper/employee_timecard

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
TeleMapper Clock In hours
Inputs
required string token
required string startDate (default: "")
required string endDate (default: "")
required numeric officeId (default: 0)
optional boolean includeFullweek (default: false)
optional string pIds (default: "")
optional boolean ignoreCKE (default: false)

swagger DELETE PATCH PUT POST GET /swagger

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Inputs

payrolltimecard DELETE PATCH PUT POST GET /payroll/timecard/{token}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Inputs
required string token (default: "")
optional string date (default: "")
optional string date2 (default: "")
optional boolean noBreaks (default: false)

Don't include breaks as part of the timecard data. (Internal Usage)

optional numeric object_type (default: 1)

1 - timetable API object. 2 - timecard API object

optional boolean sandwich (default: true)

return data as sandwich mode. if not, just returns the raw clock/check in data (where the check in and clock in ids are unique per record

optional boolean send_to_denorm (default: false)

Write the returned timecard data to the denorm table. Automatically sets sandwich mode to true.

optional numeric telemapperEntryId (default: 0)

Required if send_to_denorm argument is true.

optional struct _auth (default: [runtime expression])

Internal usage using auth object to authenticate API rather than token.

post
Inputs
required string token (default: "")
optional string data (default: "")

serialized JSON array

payrollapex_weeklyDataRoadshow DELETE PATCH PUT POST GET /payroll/apex_weeklyDataRoadshow

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

post
Apex TeleMapper Weekly Submission Data for Roadshow
Inputs
required string token (default: "")
required numeric telemapperEntryId (default: 0)
optional string officeId (default: "")

Office ID to fetch data for

payrollapex_weeklyData DELETE PATCH PUT POST GET /payroll/apex_weeklyData

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

post
Apex TeleMapper Weekly Submission Data
Inputs
required string token (default: "")
required numeric telemapperEntryId (default: 0)

payrollapex_weekly DELETE PATCH PUT POST GET /payroll/apex_weekly

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Apex TeleMapper Weekly Submission
Inputs
required string token (default: "")
optional string telemapperEntryId (default: "")
optional string date (default: "")
optional string officeid (default: "")

payrollapex_send DELETE PATCH PUT POST GET /payroll/apex_send

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

post
Apex Send Payroll Request
Inputs
required string token (default: "")
required numeric telemapperEntryId (default: 0)
optional boolean isResubmit (default: false)
optional boolean isRoadshows (default: false)
optional numeric officeId (default: 0)

payrollapex_receive DELETE PATCH PUT POST GET /payroll/apex_receive

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

post
Apex Receive Payroll Request
Inputs
required string token (default: "")
required numeric telemapperEntryId (default: 0)
optional numeric officeId (default: 0)
optional boolean isUnsubmit (default: false)
optional boolean isLockedWeek (default: false)

orderssaraPlus_verification DELETE PATCH PUT POST GET /orders/saraplus_verification

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

POST
SaraPlus Verification
Inputs
required string token
optional string personId (default: "")
optional string orderNum (default: "")
optional string asOf (default: "")
optional string latitude (default: "")
optional string longitude (default: "")
optional boolean test (default: false)
optional numeric officeId (default: 0)

orderssaraplus_notificationVerify DELETE PATCH PUT POST GET /orders/saraplus_notificationVerify

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

POST
SaraPlus Notification Verify
Inputs
required string token
required string personId
optional string orderNum (default: "")
optional string latitude (default: "")
optional string longitude (default: "")
optional string connId (default: "")
optional string retailerName (default: "")
optional string retailerClubNumber (default: "")
optional string campaign (default: "")
optional numeric officeId (default: 0)

onboardingarc_onboard DELETE PATCH PUT POST GET /onboarding/arc_onboard/{token}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

POST
ARC Onboard / Offboard Employees
Inputs
required string token
required string action
required string data
optional numeric officeId

notificationCenter DELETE PATCH PUT POST GET /notificationCenter/{token}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Inputs
required string token (default: "")
required repId (default: 0)
required getTotalNotViewedOnly (default: 0)
required markAsRead (default: 0)
optional authType (default: 1)
post
Inputs
required string token (default: "")
optional isPush (default: 0)

send push notification to ios and android native notification centers

optional isInApp (default: 1)

send to notification center of TM3 app (inside the app: tab4)

optional title (default: "")
optional message (default: "")
optional pushMessage (default: "")
optional repId (default: 0)
optional iconColor (default: gray)

icon is automatic and is based on categoryId, but icon color can be assigned for each message

required categoryId (default: 1)
required clientId (default: 1)
optional authType (default: 1)

employeeemployees DELETE PATCH PUT POST GET /employees/all

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

post
Get All Employees
Inputs
required string token (default: "")
required string officeid (default: "")
optional string lastDate (default: "")
optional string hasTeleMapperAcct (default: 1)

contactUs DELETE PATCH PUT POST GET /contactus

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

post
Add a contact us request
Inputs
required string name

Full name of the person contacting

required string email

Email address of the person contacting

required string message

Message from the person contacting

required string businessName

Business name of the person contacting

required string phone

Phone number of the person contacting

authuserEndPointsAccess DELETE PATCH PUT POST GET /business/userEndPointsAccess

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Get all user end points access
Inputs
required string token
optional numeric officeId (default: 0)

businessrequest_business DELETE PATCH PUT POST GET /business/request_business_access

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

post
Request business access
Inputs
required string token
required numeric officeId (default: 0)

businessremove_business DELETE PATCH PUT POST GET /business/remove_business_access

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

post
Remove business access
Inputs
required string token
required numeric officeId

businessbusiness DELETE PATCH PUT POST GET /business/all

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Get all business
Inputs
required string token
required numeric officeId (default: 0)

authlogin DELETE PATCH PUT POST GET /auth/token

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Create token
Inputs
required string username (default: "")
required string password (default: "")

Warning: Your reload key and password are using the framework default settings. It's advised that you change these in production.
Resources are listed in matching order. From top to bottom, the first URI to match the request is used.