YTIME_CREATE_PUNCH

Self-service web service that allows the user to clock in and out.

More information: https://it.byu.edu
Contact Info: api@byu.edu

Base URL: /domains/erp/hr/ytime_create_punch

Version: v1

Default request content-types: application/json
Default response content-types: application/json
Schemes: https

Summary

Path Operation Description
/* POST

Paths

POST /*

Uses default content-types: application/json

Punch Information

Uses default content-types: application/json

200 OK

The default response type is JSON. Add an Accept header with value=application/xml to return an XML response.

Example for application/json
{
"time": {
"byu_id": "999999999",
"international": "N",
"job_collection": {
"employee_record": "0",
"job_code_description": "Library Aide",
"mobile_access": "Y",
"period_subtotal": "12:27",
"phone_access": "Y",
"physical_facilities": "N",
"portlet_access": "N",
"punch_status": "O",
"weekly_subtotal": "02:24"
}
,
"period_total": "12:27",
"weekly_total": "02:24"
}
}

Schema definitions

byu_id: string , must match ^[0-9]{9}$

employee_record: integer (up to 3 chars)

international: string , x ∈ { Y , N }

job_code_description: string (up to 30 chars)

job_collection: object

weekly_subtotal: weekly_subtotal
period_subtotal: period_subtotal
employee_record: employee_record
job_code_description: job_code_description
punch_status: punch_status
phone_access: phone_access
mobile_access: mobile_access
portlet_access: portlet_access
physical_facilities: physical_facilities

mobile_access: string , x ∈ { Y , N }

period_subtotal: string

period_total: string

phone_access: string , x ∈ { Y , N }

physical_facilities: string , x ∈ { Y , N }

portlet_access: string , x ∈ { Y , N }

punch: object

punch_date: string (date)

Date of Punch in format YYYY-MM-DD

punch_time: string , must match ^(?:2[0-3]|[01][0-9]):[0-5][0-9]:[0-5][0-9]$

Time of Punch in format HH:MM:SS

internet_address: string , must match ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$

IP Address

latitude: string , must match ^-?(\d\.\d{1,7}|[1-8]\d\.\d{1,7}|90\.0{1,7})$

Latitude

longitude: string , must match ^-?((([1]?[0-7][0-9]|[1-9]?[0-9])\.{1}\d{1,7}$)|[1]?[1-8][0]\.{1}0{1,7})$

Longitude

time_collection_source: string , x ∈ { MBL , WEB , IOT }

Punch Source

employee_record: integer (up to 3 chars)

Employee Record Number

punch_type: string , x ∈ { I , O }

O for Out, I for In

punch_status: string , x ∈ { I , O }

time: object

weekly_total: weekly_total
period_total: period_total
byu_id: byu_id
international: international
job_collection: job_collection

weekly_subtotal: string

weekly_total: string

ytime_create_punch_request: object

timesheet: object
punch: punch

ytime_create_punch_response: object

time: time
Service Path: 
/domains/erp/hr/ytime_create_punch
Domain or University API: 
/domains/erp/hr/ytime_create_punch

Community

 

Don't see your question listed here? Ask!