Actions
The ballerinax/sap.successfactors.ectimeoff package exposes the following clients:
Available clients:
| Client | Purpose |
|---|---|
Client | Manages ectimeoff objects: TimeAccountPostingRule, WorkScheduleDayModelVariantAssignment, HolidayAssignment, TimeAccountPurchaseProfile, TimeTypeCAN, WorkScheduleDayModelVariantIdentifier, TimeManagementTerminationEndHandlingExcludedEventReason, TimeAccountPurchaseProfilePayComponentAssignment…, over the SAP SuccessFactors OData v2 API. |
Client
API to manage absences such as vacation, sick leave, and paid time off
Configuration
ConnectionConfig
Provides a set of configurations for controlling the behaviours when communicating with the SAP SuccessFactors OData endpoint. Passed as the argument to the client initializer.
| Field | Type | Default | Description |
|---|---|---|---|
auth | http:CredentialsConfig | Required | Configurations related to client authentication |
httpVersion | http:HttpVersion | See default | The HTTP version understood by the client |
http1Settings | http:ClientHttp1Settings | See default | Configurations related to HTTP/1.x protocol |
http2Settings | http:ClientHttp2Settings | See default | Configurations related to HTTP/2 protocol |
timeout | decimal | See default | The maximum time to wait (in seconds) for a response before closing the connection |
forwarded | string | See default | The choice of setting forwarded/x-forwarded header |
followRedirects | http:FollowRedirects | Optional | Configurations associated with Redirection |
poolConfig | http:PoolConfiguration | Optional | Configurations associated with request pooling |
cache | http:CacheConfig | See default | HTTP caching related configurations |
compression | http:Compression | See default | Specifies the way of handling compression (accept-encoding) header |
circuitBreaker | http:CircuitBreakerConfig | Optional | Configurations associated with the behaviour of the Circuit Breaker |
retryConfig | http:RetryConfig | Optional | Configurations associated with retrying |
cookieConfig | http:CookieConfig | Optional | Configurations associated with cookies |
responseLimits | http:ResponseLimitConfigs | See default | Configurations associated with inbound response size limits |
secureSocket | http:ClientSecureSocket | Optional | SSL/TLS-related options |
proxy | http:ProxyConfig | Optional | Proxy server related options |
socketConfig | http:ClientSocketConfig | See default | Provides settings related to client socket configuration |
validation | boolean | See default | Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default |
laxDataBinding | boolean | See default | Enables relaxed data binding on the client side. When enabled, nil values are treated as optional, and absent fields are handled as nilable types. Enabled by default. |
The client also accepts a hostname string parameter (the SAP SuccessFactors API server host) and an optional port (defaults to 443).
Initializing the client
import ballerinax/sap.successfactors.ectimeoff;
configurable string hostname = ?;
configurable string username = ?;
configurable string password = ?;
ectimeoff:Client client = check new (
{
auth: { username, password }
},
hostname
);
Operations
TimeAccountPostingRule
listTimeAccountPostingRules
Queries the TimeAccountPostingRule collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListTimeAccountPostingRulesQueries | No | Queries to be sent with the request |
Returns: Wrapper|error
Sample code:
Wrapper result = check client->listTimeAccountPostingRules();
Sample response:
{
"d": {}
}
getTimeAccountPostingRule
Retrieves a single TimeAccountPostingRule entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
TimeType_externalCode | string | Yes | key: TimeType_externalCode |
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetTimeAccountPostingRuleQueries | No | Queries to be sent with the request |
Returns: Time\ Account\ Posting\ Rule|error
Sample code:
Time\ Account\ Posting\ Rule result = check client->getTimeAccountPostingRule(TimeType_externalCode, externalCode);
WorkScheduleDayModelVariantAssignment
listWorkScheduleDayModelVariantAssignments
Queries the WorkScheduleDayModelVariantAssignment collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListWorkScheduleDayModelVariantAssignmentsQueries | No | Queries to be sent with the request |
Returns: Wrapper_1|error
Sample code:
Wrapper_1 result = check client->listWorkScheduleDayModelVariantAssignments();
Sample response:
{
"d": {}
}
getWorkScheduleDayModelVariantAssignment
Retrieves a single WorkScheduleDayModelVariantAssignment entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
WorkScheduleDayModel_externalCode | string | Yes | key: WorkScheduleDayModel_externalCode |
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetWorkScheduleDayModelVariantAssignmentQueries | No | Queries to be sent with the request |
Returns: Work\ Schedule\ Day\ Model\ Variant\ Assignment|error
Sample code:
Work\ Schedule\ Day\ Model\ Variant\ Assignment result = check client->getWorkScheduleDayModelVariantAssignment(WorkScheduleDayModel_externalCode, externalCode);
HolidayAssignment
listHolidayAssignments
Queries the HolidayAssignment collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListHolidayAssignmentsQueries | No | Queries to be sent with the request |
Returns: Wrapper_2|error
Sample code:
Wrapper_2 result = check client->listHolidayAssignments();
Sample response:
{
"d": {}
}
getHolidayAssignment
Retrieves a single HolidayAssignment entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
HolidayCalendar_externalCode | string | Yes | key: HolidayCalendar_externalCode |
date | string | Yes | key: date |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetHolidayAssignmentQueries | No | Queries to be sent with the request |
Returns: Holiday\ Assignment|error
Sample code:
Holiday\ Assignment result = check client->getHolidayAssignment(HolidayCalendar_externalCode, date);
TimeAccountPurchaseProfile
listTimeAccountPurchaseProfiles
Queries the TimeAccountPurchaseProfile collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListTimeAccountPurchaseProfilesQueries | No | Queries to be sent with the request |
Returns: Wrapper_3|error
Sample code:
Wrapper_3 result = check client->listTimeAccountPurchaseProfiles();
Sample response:
{
"d": {}
}
getTimeAccountPurchaseProfile
Retrieves a single TimeAccountPurchaseProfile entity identified by its key property.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetTimeAccountPurchaseProfileQueries | No | Queries to be sent with the request |
Returns: Time\ Account\ Purchase\ Profile|error
Sample code:
Time\ Account\ Purchase\ Profile result = check client->getTimeAccountPurchaseProfile(externalCode);
TimeTypeCAN
listTimeTypeCANs
Queries the TimeTypeCAN collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListTimeTypeCANsQueries | No | Queries to be sent with the request |
Returns: Wrapper_4|error
Sample code:
Wrapper_4 result = check client->listTimeTypeCANs();
Sample response:
{
"d": {}
}
getTimeTypeCAN
Retrieves a single TimeTypeCAN entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
TimeType_externalCode | string | Yes | key: TimeType_externalCode |
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetTimeTypeCANQueries | No | Queries to be sent with the request |
Returns: Time\ Type\ CAN|error
Sample code:
Time\ Type\ CAN result = check client->getTimeTypeCAN(TimeType_externalCode, externalCode);
WorkScheduleDayModelVariantIdentifier
listWorkScheduleDayModelVariantIdentifiers
Queries the WorkScheduleDayModelVariantIdentifier collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListWorkScheduleDayModelVariantIdentifiersQueries | No | Queries to be sent with the request |
Returns: Wrapper_5|error
Sample code:
Wrapper_5 result = check client->listWorkScheduleDayModelVariantIdentifiers();
Sample response:
{
"d": {}
}
getWorkScheduleDayModelVariantIdentifier
Retrieves a single WorkScheduleDayModelVariantIdentifier entity identified by its key property.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetWorkScheduleDayModelVariantIdentifierQueries | No | Queries to be sent with the request |
Returns: Work\ Schedule\ Day\ Model\ Variant\ Identifier|error
Sample code:
Work\ Schedule\ Day\ Model\ Variant\ Identifier result = check client->getWorkScheduleDayModelVariantIdentifier(externalCode);
TimeManagementTerminationEndHandlingExcludedEventReason
listTimeManagementTerminationEndHandlingExcludedEventReasons
Queries the TimeManagementTerminationEndHandlingExcludedEventReason collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListTimeManagementTerminationEndHandlingExcludedEventReasonsQueries | No | Queries to be sent with the request |
Returns: Wrapper_6|error
Sample code:
Wrapper_6 result = check client->listTimeManagementTerminationEndHandlingExcludedEventReasons();
Sample response:
{
"d": {}
}
getTimeManagementTerminationEndHandlingExcludedEventReason
Retrieves a single TimeManagementTerminationEndHandlingExcludedEventReason entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
TimeManagementTerminationEndHandlingExclusion_externalCode | string | Yes | key: TimeManagementTerminationEndHandlingExclusion_externalCode |
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetTimeManagementTerminationEndHandlingExcludedEventReasonQueries | No | Queries to be sent with the request |
Returns: Time\ Management\ Termination\ End\ Handling\ Excluded\ Event\ Reason|error
Sample code:
Time\ Management\ Termination\ End\ Handling\ Excluded\ Event\ Reason result = check client->getTimeManagementTerminationEndHandlingExcludedEventReason(TimeManagementTerminationEndHandlingExclusion_externalCode, externalCode);
TimeAccountPurchaseProfilePayComponentAssignment
listTimeAccountPurchaseProfilePayComponentAssignments
Queries the TimeAccountPurchaseProfilePayComponentAssignment collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListTimeAccountPurchaseProfilePayComponentAssignmentsQueries | No | Queries to be sent with the request |
Returns: Wrapper_7|error
Sample code:
Wrapper_7 result = check client->listTimeAccountPurchaseProfilePayComponentAssignments();
Sample response:
{
"d": {}
}
getTimeAccountPurchaseProfilePayComponentAssignment
Retrieves a single TimeAccountPurchaseProfilePayComponentAssignment entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
TimeAccountPurchaseProfile_externalCode | string | Yes | key: TimeAccountPurchaseProfile_externalCode |
payComponent | string | Yes | key: payComponent |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetTimeAccountPurchaseProfilePayComponentAssignmentQueries | No | Queries to be sent with the request |
Returns: Time\ Account\ Purchase\ Profile\ Pay\ Component\ Assignment|error
Sample code:
Time\ Account\ Purchase\ Profile\ Pay\ Component\ Assignment result = check client->getTimeAccountPurchaseProfilePayComponentAssignment(TimeAccountPurchaseProfile_externalCode, payComponent);
EmployeeTimeGroupItem
listEmployeeTimeGroupItems
Queries the EmployeeTimeGroupItem collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListEmployeeTimeGroupItemsQueries | No | Queries to be sent with the request |
Returns: json|error
Sample code:
json result = check client->listEmployeeTimeGroupItems();
getEmployeeTimeGroupItem
Retrieves a single EmployeeTimeGroupItem entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
EmployeeTimeGroup_externalCode | string | Yes | key: EmployeeTimeGroup_externalCode |
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetEmployeeTimeGroupItemQueries | No | Queries to be sent with the request |
Returns: json|error
Sample code:
json result = check client->getEmployeeTimeGroupItem(EmployeeTimeGroup_externalCode, externalCode);
WorkScheduleDayModelAssignment
listWorkScheduleDayModelAssignments
Queries the WorkScheduleDayModelAssignment collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListWorkScheduleDayModelAssignmentsQueries | No | Queries to be sent with the request |
Returns: Wrapper_9|error
Sample code:
Wrapper_9 result = check client->listWorkScheduleDayModelAssignments();
Sample response:
{
"d": {}
}
createWorkScheduleDayModelAssignment
Creates a new WorkScheduleDayModelAssignment entity from the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | WorkScheduleDayModelAssignment | Yes | New entity |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: CreatedWork\ Schedule\ Day\ Model\ Assignment|error
Sample code:
CreatedWork\ Schedule\ Day\ Model\ Assignment result = check client->createWorkScheduleDayModelAssignment(payload);
getWorkScheduleDayModelAssignment
Retrieves a single WorkScheduleDayModelAssignment entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
WorkSchedule_externalCode | string | Yes | key: WorkSchedule_externalCode |
day | int | Yes | key: day |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetWorkScheduleDayModelAssignmentQueries | No | Queries to be sent with the request |
Returns: Work\ Schedule\ Day\ Model\ Assignment|error
Sample code:
Work\ Schedule\ Day\ Model\ Assignment result = check client->getWorkScheduleDayModelAssignment(WorkSchedule_externalCode, day);
updateWorkScheduleDayModelAssignment
Updates the WorkScheduleDayModelAssignment identified by its key properties with the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
WorkSchedule_externalCode | string | Yes | key: WorkSchedule_externalCode |
day | int | Yes | key: day |
payload | ModifiedWork\ Schedule\ Day\ Model\ Assignment | Yes | New property values |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateWorkScheduleDayModelAssignment(WorkSchedule_externalCode, day, payload);
deleteWorkScheduleDayModelAssignment
Deletes the WorkScheduleDayModelAssignment identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
WorkSchedule_externalCode | string | Yes | key: WorkSchedule_externalCode |
day | int | Yes | key: day |
headers | DeleteWorkScheduleDayModelAssignmentHeaders | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteWorkScheduleDayModelAssignment(WorkSchedule_externalCode, day);
TimeAccountDetail
listTimeAccountDetails
Queries the TimeAccountDetail collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListTimeAccountDetailsQueries | No | Queries to be sent with the request |
Returns: json|error
Sample code:
json result = check client->listTimeAccountDetails();
getTimeAccountDetail
Retrieves a single TimeAccountDetail entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
TimeAccount_externalCode | string | Yes | key: TimeAccount_externalCode |
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetTimeAccountDetailQueries | No | Queries to be sent with the request |
Returns: json|error
Sample code:
json result = check client->getTimeAccountDetail(TimeAccount_externalCode, externalCode);
deleteTimeAccountDetail
Deletes the TimeAccountDetail identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
TimeAccount_externalCode | string | Yes | key: TimeAccount_externalCode |
externalCode | string | Yes | key: externalCode |
headers | DeleteTimeAccountDetailHeaders | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteTimeAccountDetail(TimeAccount_externalCode, externalCode);
TimeTypeNLD
listTimeTypeNLDs
Queries the TimeTypeNLD collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListTimeTypeNLDsQueries | No | Queries to be sent with the request |
Returns: Wrapper_11|error
Sample code:
Wrapper_11 result = check client->listTimeTypeNLDs();
Sample response:
{
"d": {}
}
getTimeTypeNLD
Retrieves a single TimeTypeNLD entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
TimeType_externalCode | string | Yes | key: TimeType_externalCode |
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetTimeTypeNLDQueries | No | Queries to be sent with the request |
Returns: Time\ Type\ NLD|error
Sample code:
Time\ Type\ NLD result = check client->getTimeTypeNLD(TimeType_externalCode, externalCode);
TimeTypeSWE
listTimeTypeSWEs
Queries the TimeTypeSWE collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListTimeTypeSWEsQueries | No | Queries to be sent with the request |
Returns: Wrapper_12|error
Sample code:
Wrapper_12 result = check client->listTimeTypeSWEs();
Sample response:
{
"d": {}
}
getTimeTypeSWE
Retrieves a single TimeTypeSWE entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
TimeType_externalCode | string | Yes | key: TimeType_externalCode |
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetTimeTypeSWEQueries | No | Queries to be sent with the request |
Returns: Time\ Type\ SWE|error
Sample code:
Time\ Type\ SWE result = check client->getTimeTypeSWE(TimeType_externalCode, externalCode);
TimeTypeNOR
listTimeTypeNORs
Queries the TimeTypeNOR collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListTimeTypeNORsQueries | No | Queries to be sent with the request |
Returns: Wrapper_13|error
Sample code:
Wrapper_13 result = check client->listTimeTypeNORs();
Sample response:
{
"d": {}
}
getTimeTypeNOR
Retrieves a single TimeTypeNOR entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
TimeType_externalCode | string | Yes | key: TimeType_externalCode |
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetTimeTypeNORQueries | No | Queries to be sent with the request |
Returns: Time\ Type\ NOR|error
Sample code:
Time\ Type\ NOR result = check client->getTimeTypeNOR(TimeType_externalCode, externalCode);
TimeTypeITA
listTimeTypeITAs
Queries the TimeTypeITA collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListTimeTypeITAsQueries | No | Queries to be sent with the request |
Returns: Wrapper_14|error
Sample code:
Wrapper_14 result = check client->listTimeTypeITAs();
Sample response:
{
"d": {}
}
getTimeTypeITA
Retrieves a single TimeTypeITA entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
TimeType_externalCode | string | Yes | key: TimeType_externalCode |
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetTimeTypeITAQueries | No | Queries to be sent with the request |
Returns: Time\ Type\ ITA|error
Sample code:
Time\ Type\ ITA result = check client->getTimeTypeITA(TimeType_externalCode, externalCode);
AbsenceCountingMethod
listAbsenceCountingMethods
Queries the AbsenceCountingMethod collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListAbsenceCountingMethodsQueries | No | Queries to be sent with the request |
Returns: Wrapper_15|error
Sample code:
Wrapper_15 result = check client->listAbsenceCountingMethods();
Sample response:
{
"d": {}
}
getAbsenceCountingMethod
Retrieves a single AbsenceCountingMethod entity identified by its key property.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetAbsenceCountingMethodQueries | No | Queries to be sent with the request |
Returns: Absence\ Counting\ Method|error
Sample code:
Absence\ Counting\ Method result = check client->getAbsenceCountingMethod(externalCode);
ShiftClassification
listShiftClassifications
Queries the ShiftClassification collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListShiftClassificationsQueries | No | Queries to be sent with the request |
Returns: Wrapper_16|error
Sample code:
Wrapper_16 result = check client->listShiftClassifications();
Sample response:
{
"d": {}
}
getShiftClassification
Retrieves a single ShiftClassification entity identified by its key property.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetShiftClassificationQueries | No | Queries to be sent with the request |
Returns: Shift\ Classification|error
Sample code:
Shift\ Classification result = check client->getShiftClassification(externalCode);
WorkScheduleDay
listWorkScheduleDays
Queries the WorkScheduleDay collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListWorkScheduleDaysQueries | No | Queries to be sent with the request |
Returns: Wrapper_17|error
Sample code:
Wrapper_17 result = check client->listWorkScheduleDays();
Sample response:
{
"d": {}
}
createWorkScheduleDay
Creates a new WorkScheduleDay entity from the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | WorkScheduleDay | Yes | New entity |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: CreatedWork\ Schedule\ Day|error
Sample code:
CreatedWork\ Schedule\ Day result = check client->createWorkScheduleDay(payload);
getWorkScheduleDay
Retrieves a single WorkScheduleDay entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
WorkSchedule_externalCode | string | Yes | key: WorkSchedule_externalCode |
day | int | Yes | key: day |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetWorkScheduleDayQueries | No | Queries to be sent with the request |
Returns: Work\ Schedule\ Day|error
Sample code:
Work\ Schedule\ Day result = check client->getWorkScheduleDay(WorkSchedule_externalCode, day);
updateWorkScheduleDay
Updates the WorkScheduleDay identified by its key properties with the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
WorkSchedule_externalCode | string | Yes | key: WorkSchedule_externalCode |
day | int | Yes | key: day |
payload | ModifiedWork\ Schedule\ Day | Yes | New property values |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateWorkScheduleDay(WorkSchedule_externalCode, day, payload);
deleteWorkScheduleDay
Deletes the WorkScheduleDay identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
WorkSchedule_externalCode | string | Yes | key: WorkSchedule_externalCode |
day | int | Yes | key: day |
headers | DeleteWorkScheduleDayHeaders | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteWorkScheduleDay(WorkSchedule_externalCode, day);
HolidayCalendar
listHolidayCalendars
Queries the HolidayCalendar collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListHolidayCalendarsQueries | No | Queries to be sent with the request |
Returns: Wrapper_18|error
Sample code:
Wrapper_18 result = check client->listHolidayCalendars();
Sample response:
{
"d": {}
}
getHolidayCalendar
Retrieves a single HolidayCalendar entity identified by its key property.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetHolidayCalendarQueries | No | Queries to be sent with the request |
Returns: Holiday\ Calendar|error
Sample code:
Holiday\ Calendar result = check client->getHolidayCalendar(externalCode);
TimeManagementTerminationEndHandlingExcludedTimeAccountType
listTimeManagementTerminationEndHandlingExcludedTimeAccountTypes
Queries the TimeManagementTerminationEndHandlingExcludedTimeAccountType collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListTimeManagementTerminationEndHandlingExcludedTimeAccountTypesQueries | No | Queries to be sent with the request |
Returns: Wrapper_19|error
Sample code:
Wrapper_19 result = check client->listTimeManagementTerminationEndHandlingExcludedTimeAccountTypes();
Sample response:
{
"d": {}
}
getTimeManagementTerminationEndHandlingExcludedTimeAccountType
Retrieves a single TimeManagementTerminationEndHandlingExcludedTimeAccountType entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
TimeManagementTerminationEndHandlingExclusion_externalCode | string | Yes | key: TimeManagementTerminationEndHandlingExclusion_externalCode |
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetTimeManagementTerminationEndHandlingExcludedTimeAccountTypeQueries | No | Queries to be sent with the request |
Returns: Time\ Management\ Termination\ End\ Handling\ Excluded\ Time\ Account\ Type|error
Sample code:
Time\ Management\ Termination\ End\ Handling\ Excluded\ Time\ Account\ Type result = check client->getTimeManagementTerminationEndHandlingExcludedTimeAccountType(TimeManagementTerminationEndHandlingExclusion_externalCode, externalCode);
EmployeeTimeDEU
listEmployeeTimeDEUs
Queries the EmployeeTimeDEU collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListEmployeeTimeDEUsQueries | No | Queries to be sent with the request |
Returns: json|error
Sample code:
json result = check client->listEmployeeTimeDEUs();
getEmployeeTimeDEU
Retrieves a single EmployeeTimeDEU entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
EmployeeTime_externalCode | string | Yes | key: EmployeeTime_externalCode |
externalCode | int | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetEmployeeTimeDEUQueries | No | Queries to be sent with the request |
Returns: json|error
Sample code:
json result = check client->getEmployeeTimeDEU(EmployeeTime_externalCode, externalCode);
deleteEmployeeTimeDEU
Deletes the EmployeeTimeDEU identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
EmployeeTime_externalCode | string | Yes | key: EmployeeTime_externalCode |
externalCode | int | Yes | key: externalCode |
headers | DeleteEmployeeTimeDEUHeaders | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteEmployeeTimeDEU(EmployeeTime_externalCode, externalCode);
TimeAccount
listTimeAccounts
Queries the TimeAccount collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListTimeAccountsQueries | No | Queries to be sent with the request |
Returns: json|error
Sample code:
json result = check client->listTimeAccounts();
getTimeAccount
Retrieves a single TimeAccount entity identified by its key property.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetTimeAccountQueries | No | Queries to be sent with the request |
Returns: json|error
Sample code:
json result = check client->getTimeAccount(externalCode);
deleteTimeAccount
Deletes the TimeAccount identified by its key property.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
headers | DeleteTimeAccountHeaders | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteTimeAccount(externalCode);
WorkScheduleDayModelAssignmentSegment
listWorkScheduleDayModelAssignmentSegments
Queries the WorkScheduleDayModelAssignmentSegment collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListWorkScheduleDayModelAssignmentSegmentsQueries | No | Queries to be sent with the request |
Returns: Wrapper_22|error
Sample code:
Wrapper_22 result = check client->listWorkScheduleDayModelAssignmentSegments();
Sample response:
{
"d": {}
}
createWorkScheduleDayModelAssignmentSegment
Creates a new WorkScheduleDayModelAssignmentSegment entity from the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | WorkScheduleDayModelAssignmentSegment | Yes | New entity |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: CreatedWork\ Schedule\ Day\ Model\ Assignment\ Segment|error
Sample code:
CreatedWork\ Schedule\ Day\ Model\ Assignment\ Segment result = check client->createWorkScheduleDayModelAssignmentSegment(payload);
getWorkScheduleDayModelAssignmentSegment
Retrieves a single WorkScheduleDayModelAssignmentSegment entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
WorkScheduleDayModelAssignment_day | int | Yes | key: WorkScheduleDayModelAssignment_day |
WorkSchedule_externalCode | string | Yes | key: WorkSchedule_externalCode |
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetWorkScheduleDayModelAssignmentSegmentQueries | No | Queries to be sent with the request |
Returns: Work\ Schedule\ Day\ Model\ Assignment\ Segment|error
Sample code:
Work\ Schedule\ Day\ Model\ Assignment\ Segment result = check client->getWorkScheduleDayModelAssignmentSegment(WorkScheduleDayModelAssignment_day, WorkSchedule_externalCode, externalCode);
updateWorkScheduleDayModelAssignmentSegment
Updates the WorkScheduleDayModelAssignmentSegment identified by its key properties with the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
WorkScheduleDayModelAssignment_day | int | Yes | key: WorkScheduleDayModelAssignment_day |
WorkSchedule_externalCode | string | Yes | key: WorkSchedule_externalCode |
externalCode | string | Yes | key: externalCode |
payload | ModifiedWork\ Schedule\ Day\ Model\ Assignment\ Segment | Yes | New property values |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateWorkScheduleDayModelAssignmentSegment(WorkScheduleDayModelAssignment_day, WorkSchedule_externalCode, externalCode, payload);
deleteWorkScheduleDayModelAssignmentSegment
Deletes the WorkScheduleDayModelAssignmentSegment identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
WorkScheduleDayModelAssignment_day | int | Yes | key: WorkScheduleDayModelAssignment_day |
WorkSchedule_externalCode | string | Yes | key: WorkSchedule_externalCode |
externalCode | string | Yes | key: externalCode |
headers | DeleteWorkScheduleDayModelAssignmentSegmentHeaders | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteWorkScheduleDayModelAssignmentSegment(WorkScheduleDayModelAssignment_day, WorkSchedule_externalCode, externalCode);
EmployeeTimeCOL
listEmployeeTimeCOLs
Queries the EmployeeTimeCOL collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListEmployeeTimeCOLsQueries | No | Queries to be sent with the request |
Returns: json|error
Sample code:
json result = check client->listEmployeeTimeCOLs();
getEmployeeTimeCOL
Retrieves a single EmployeeTimeCOL entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
EmployeeTime_externalCode | string | Yes | key: EmployeeTime_externalCode |
externalCode | int | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetEmployeeTimeCOLQueries | No | Queries to be sent with the request |
Returns: json|error
Sample code:
json result = check client->getEmployeeTimeCOL(EmployeeTime_externalCode, externalCode);
deleteEmployeeTimeCOL
Deletes the EmployeeTimeCOL identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
EmployeeTime_externalCode | string | Yes | key: EmployeeTime_externalCode |
externalCode | int | Yes | key: externalCode |
headers | DeleteEmployeeTimeCOLHeaders | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteEmployeeTimeCOL(EmployeeTime_externalCode, externalCode);
EmployeeTimeESP
listEmployeeTimeESPs
Queries the EmployeeTimeESP collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListEmployeeTimeESPsQueries | No | Queries to be sent with the request |
Returns: json|error
Sample code:
json result = check client->listEmployeeTimeESPs();
getEmployeeTimeESP
Retrieves a single EmployeeTimeESP entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
EmployeeTime_externalCode | string | Yes | key: EmployeeTime_externalCode |
externalCode | int | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetEmployeeTimeESPQueries | No | Queries to be sent with the request |
Returns: json|error
Sample code:
json result = check client->getEmployeeTimeESP(EmployeeTime_externalCode, externalCode);
deleteEmployeeTimeESP
Deletes the EmployeeTimeESP identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
EmployeeTime_externalCode | string | Yes | key: EmployeeTime_externalCode |
externalCode | int | Yes | key: externalCode |
headers | DeleteEmployeeTimeESPHeaders | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteEmployeeTimeESP(EmployeeTime_externalCode, externalCode);
TimeManagementTerminationEndHandlingConfiguration
listTimeManagementTerminationEndHandlingConfigurations
Queries the TimeManagementTerminationEndHandlingConfiguration collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListTimeManagementTerminationEndHandlingConfigurationsQueries | No | Queries to be sent with the request |
Returns: Wrapper_25|error
Sample code:
Wrapper_25 result = check client->listTimeManagementTerminationEndHandlingConfigurations();
Sample response:
{
"d": {}
}
getTimeManagementTerminationEndHandlingConfiguration
Retrieves a single TimeManagementTerminationEndHandlingConfiguration entity identified by its key property.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetTimeManagementTerminationEndHandlingConfigurationQueries | No | Queries to be sent with the request |
Returns: Time\ Management\ Termination\ End\ Handling\ Configuration|error
Sample code:
Time\ Management\ Termination\ End\ Handling\ Configuration result = check client->getTimeManagementTerminationEndHandlingConfiguration(externalCode);
HolidayCategory
listHolidayCategorys
Queries the HolidayCategory collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListHolidayCategorysQueries | No | Queries to be sent with the request |
Returns: Wrapper_26|error
Sample code:
Wrapper_26 result = check client->listHolidayCategorys();
Sample response:
{
"d": {
"results": [
{
"externalCode": "1000"
}
]
}
}
getHolidayCategory
Retrieves a single HolidayCategory entity identified by its key property.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetHolidayCategoryQueries | No | Queries to be sent with the request |
Returns: Holiday\ Category|error
Sample code:
Holiday\ Category result = check client->getHolidayCategory(externalCode);
ElectronicSicknessCertificateExclusionReasonDEU
listElectronicSicknessCertificateExclusionReasonDEUs
Queries the ElectronicSicknessCertificateExclusionReasonDEU collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListElectronicSicknessCertificateExclusionReasonDEUsQueries | No | Queries to be sent with the request |
Returns: Wrapper_27|error
Sample code:
Wrapper_27 result = check client->listElectronicSicknessCertificateExclusionReasonDEUs();
Sample response:
{
"d": {}
}
getElectronicSicknessCertificateExclusionReasonDEU
Retrieves a single ElectronicSicknessCertificateExclusionReasonDEU entity identified by its key property.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetElectronicSicknessCertificateExclusionReasonDEUQueries | No | Queries to be sent with the request |
Returns: Electronic\ Sickness\ Certificate\ Exclusion\ Reason\ DEU|error
Sample code:
Electronic\ Sickness\ Certificate\ Exclusion\ Reason\ DEU result = check client->getElectronicSicknessCertificateExclusionReasonDEU(externalCode);
EmployeeTimeGroup
listEmployeeTimeGroups
Queries the EmployeeTimeGroup collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListEmployeeTimeGroupsQueries | No | Queries to be sent with the request |
Returns: json|error
Sample code:
json result = check client->listEmployeeTimeGroups();
getEmployeeTimeGroup
Retrieves a single EmployeeTimeGroup entity identified by its key property.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetEmployeeTimeGroupQueries | No | Queries to be sent with the request |
Returns: json|error
Sample code:
json result = check client->getEmployeeTimeGroup(externalCode);
TimeAccountType
listTimeAccountTypes
Queries the TimeAccountType collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListTimeAccountTypesQueries | No | Queries to be sent with the request |
Returns: Wrapper_29|error
Sample code:
Wrapper_29 result = check client->listTimeAccountTypes();
Sample response:
{
"d": {}
}
getTimeAccountType
Retrieves a single TimeAccountType entity identified by its key property.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetTimeAccountTypeQueries | No | Queries to be sent with the request |
Returns: Time\ Account\ Type|error
Sample code:
Time\ Account\ Type result = check client->getTimeAccountType(externalCode);
AccrualCalculationBase
listAccrualCalculationBases
Queries the AccrualCalculationBase collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListAccrualCalculationBasesQueries | No | Queries to be sent with the request |
Returns: Wrapper_30|error
Sample code:
Wrapper_30 result = check client->listAccrualCalculationBases();
Sample response:
{
"d": {}
}
createAccrualCalculationBase
Creates a new AccrualCalculationBase entity from the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | AccrualCalculationBase | Yes | New entity |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: CreatedAccrual\ Calculation\ Base|error
Sample code:
CreatedAccrual\ Calculation\ Base result = check client->createAccrualCalculationBase(payload);
getAccrualCalculationBase
Retrieves a single AccrualCalculationBase entity identified by its key property.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetAccrualCalculationBaseQueries | No | Queries to be sent with the request |
Returns: Accrual\ Calculation\ Base|error
Sample code:
Accrual\ Calculation\ Base result = check client->getAccrualCalculationBase(externalCode);
updateAccrualCalculationBase
Updates the AccrualCalculationBase identified by its key property with the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
payload | ModifiedAccrual\ Calculation\ Base | Yes | New property values |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateAccrualCalculationBase(externalCode, payload);
deleteAccrualCalculationBase
Deletes the AccrualCalculationBase identified by its key property.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
headers | DeleteAccrualCalculationBaseHeaders | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteAccrualCalculationBase(externalCode);
EmployeeTimeUSA
listEmployeeTimeUSAs
Queries the EmployeeTimeUSA collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListEmployeeTimeUSAsQueries | No | Queries to be sent with the request |
Returns: Wrapper_31|error
Sample code:
Wrapper_31 result = check client->listEmployeeTimeUSAs();
Sample response:
{
"d": {}
}
createEmployeeTimeUSA
Creates a new EmployeeTimeUSA entity from the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | EmployeeTimeUSA | Yes | New entity |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: CreatedEmployee\ Time\ USA|error
Sample code:
CreatedEmployee\ Time\ USA result = check client->createEmployeeTimeUSA(payload);
getEmployeeTimeUSA
Retrieves a single EmployeeTimeUSA entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
EmployeeTime_externalCode | string | Yes | key: EmployeeTime_externalCode |
externalCode | int | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetEmployeeTimeUSAQueries | No | Queries to be sent with the request |
Returns: Employee\ Time\ USA|error
Sample code:
Employee\ Time\ USA result = check client->getEmployeeTimeUSA(EmployeeTime_externalCode, externalCode);
updateEmployeeTimeUSA
Updates the EmployeeTimeUSA identified by its key properties with the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
EmployeeTime_externalCode | string | Yes | key: EmployeeTime_externalCode |
externalCode | int | Yes | key: externalCode |
payload | ModifiedEmployee\ Time\ USA | Yes | New property values |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateEmployeeTimeUSA(EmployeeTime_externalCode, externalCode, payload);
deleteEmployeeTimeUSA
Deletes the EmployeeTimeUSA identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
EmployeeTime_externalCode | string | Yes | key: EmployeeTime_externalCode |
externalCode | int | Yes | key: externalCode |
headers | DeleteEmployeeTimeUSAHeaders | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteEmployeeTimeUSA(EmployeeTime_externalCode, externalCode);
TimeTypeUSA
listTimeTypeUSAs
Queries the TimeTypeUSA collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListTimeTypeUSAsQueries | No | Queries to be sent with the request |
Returns: Wrapper_32|error
Sample code:
Wrapper_32 result = check client->listTimeTypeUSAs();
Sample response:
{
"d": {}
}
getTimeTypeUSA
Retrieves a single TimeTypeUSA entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
TimeType_externalCode | string | Yes | key: TimeType_externalCode |
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetTimeTypeUSAQueries | No | Queries to be sent with the request |
Returns: Time\ Type\ USA|error
Sample code:
Time\ Type\ USA result = check client->getTimeTypeUSA(TimeType_externalCode, externalCode);
TemporaryTimeInformation
listTemporaryTimeInformations
Queries the TemporaryTimeInformation collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListTemporaryTimeInformationsQueries | No | Queries to be sent with the request |
Returns: Wrapper_33|error
Sample code:
Wrapper_33 result = check client->listTemporaryTimeInformations();
Sample response:
{
"d": {}
}
createTemporaryTimeInformation
Creates a new TemporaryTimeInformation entity from the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | TemporaryTimeInformation | Yes | New entity |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: CreatedTemporary\ Time\ Information|error
Sample code:
CreatedTemporary\ Time\ Information result = check client->createTemporaryTimeInformation(payload);
getTemporaryTimeInformation
Retrieves a single TemporaryTimeInformation entity identified by its key property.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetTemporaryTimeInformationQueries | No | Queries to be sent with the request |
Returns: Temporary\ Time\ Information|error
Sample code:
Temporary\ Time\ Information result = check client->getTemporaryTimeInformation(externalCode);
updateTemporaryTimeInformation
Updates the TemporaryTimeInformation identified by its key property with the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
payload | ModifiedTemporary\ Time\ Information | Yes | New property values |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateTemporaryTimeInformation(externalCode, payload);
deleteTemporaryTimeInformation
Deletes the TemporaryTimeInformation identified by its key property.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
headers | DeleteTemporaryTimeInformationHeaders | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteTemporaryTimeInformation(externalCode);
TimeTypeProfile
listTimeTypeProfiles
Queries the TimeTypeProfile collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListTimeTypeProfilesQueries | No | Queries to be sent with the request |
Returns: Wrapper_34|error
Sample code:
Wrapper_34 result = check client->listTimeTypeProfiles();
Sample response:
{
"d": {}
}
getTimeTypeProfile
Retrieves a single TimeTypeProfile entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
mdfSystemEffectiveStartDate | string | Yes | key: mdfSystemEffectiveStartDate |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetTimeTypeProfileQueries | No | Queries to be sent with the request |
Returns: Time\ Type\ Profile|error
Sample code:
Time\ Type\ Profile result = check client->getTimeTypeProfile(externalCode, mdfSystemEffectiveStartDate);
TimeManagementAlert
listTimeManagementAlerts
Queries the TimeManagementAlert collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListTimeManagementAlertsQueries | No | Queries to be sent with the request |
Returns: json|error
Sample code:
json result = check client->listTimeManagementAlerts();
getTimeManagementAlert
Retrieves a single TimeManagementAlert entity identified by its key property.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetTimeManagementAlertQueries | No | Queries to be sent with the request |
Returns: json|error
Sample code:
json result = check client->getTimeManagementAlert(externalCode);
TimeTypeDEU
listTimeTypeDEUs
Queries the TimeTypeDEU collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListTimeTypeDEUsQueries | No | Queries to be sent with the request |
Returns: Wrapper_36|error
Sample code:
Wrapper_36 result = check client->listTimeTypeDEUs();
Sample response:
{
"d": {}
}
getTimeTypeDEU
Retrieves a single TimeTypeDEU entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
TimeType_externalCode | string | Yes | key: TimeType_externalCode |
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetTimeTypeDEUQueries | No | Queries to be sent with the request |
Returns: Time\ Type\ DEU|error
Sample code:
Time\ Type\ DEU result = check client->getTimeTypeDEU(TimeType_externalCode, externalCode);
TimeType
listTimeTypes
Queries the TimeType collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListTimeTypesQueries | No | Queries to be sent with the request |
Returns: Wrapper_37|error
Sample code:
Wrapper_37 result = check client->listTimeTypes();
Sample response:
{
"d": {}
}
getTimeType
Retrieves a single TimeType entity identified by its key property.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetTimeTypeQueries | No | Queries to be sent with the request |
Returns: Time\ Type|error
Sample code:
Time\ Type result = check client->getTimeType(externalCode);
TimeManagementTerminationEndHandlingExclusion
listTimeManagementTerminationEndHandlingExclusions
Queries the TimeManagementTerminationEndHandlingExclusion collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListTimeManagementTerminationEndHandlingExclusionsQueries | No | Queries to be sent with the request |
Returns: Wrapper_38|error
Sample code:
Wrapper_38 result = check client->listTimeManagementTerminationEndHandlingExclusions();
Sample response:
{
"d": {}
}
getTimeManagementTerminationEndHandlingExclusion
Retrieves a single TimeManagementTerminationEndHandlingExclusion entity identified by its key property.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetTimeManagementTerminationEndHandlingExclusionQueries | No | Queries to be sent with the request |
Returns: Time\ Management\ Termination\ End\ Handling\ Exclusion|error
Sample code:
Time\ Management\ Termination\ End\ Handling\ Exclusion result = check client->getTimeManagementTerminationEndHandlingExclusion(externalCode);
EmployeeTimeMEX
listEmployeeTimeMEXs
Queries the EmployeeTimeMEX collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListEmployeeTimeMEXsQueries | No | Queries to be sent with the request |
Returns: json|error
Sample code:
json result = check client->listEmployeeTimeMEXs();
getEmployeeTimeMEX
Retrieves a single EmployeeTimeMEX entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
EmployeeTime_externalCode | string | Yes | key: EmployeeTime_externalCode |
externalCode | int | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetEmployeeTimeMEXQueries | No | Queries to be sent with the request |
Returns: json|error
Sample code:
json result = check client->getEmployeeTimeMEX(EmployeeTime_externalCode, externalCode);
deleteEmployeeTimeMEX
Deletes the EmployeeTimeMEX identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
EmployeeTime_externalCode | string | Yes | key: EmployeeTime_externalCode |
externalCode | int | Yes | key: externalCode |
headers | DeleteEmployeeTimeMEXHeaders | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteEmployeeTimeMEX(EmployeeTime_externalCode, externalCode);
WorkScheduleDayModel
listWorkScheduleDayModels
Queries the WorkScheduleDayModel collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListWorkScheduleDayModelsQueries | No | Queries to be sent with the request |
Returns: Wrapper_40|error
Sample code:
Wrapper_40 result = check client->listWorkScheduleDayModels();
Sample response:
{
"d": {}
}
createWorkScheduleDayModel
Creates a new WorkScheduleDayModel entity from the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | WorkScheduleDayModel | Yes | New entity |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: CreatedWork\ Schedule\ Day\ Model|error
Sample code:
CreatedWork\ Schedule\ Day\ Model result = check client->createWorkScheduleDayModel(payload);
getWorkScheduleDayModel
Retrieves a single WorkScheduleDayModel entity identified by its key property.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetWorkScheduleDayModelQueries | No | Queries to be sent with the request |
Returns: Work\ Schedule\ Day\ Model|error
Sample code:
Work\ Schedule\ Day\ Model result = check client->getWorkScheduleDayModel(externalCode);
updateWorkScheduleDayModel
Updates the WorkScheduleDayModel identified by its key property with the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
payload | ModifiedWork\ Schedule\ Day\ Model | Yes | New property values |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateWorkScheduleDayModel(externalCode, payload);
deleteWorkScheduleDayModel
Deletes the WorkScheduleDayModel identified by its key property.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
headers | DeleteWorkScheduleDayModelHeaders | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteWorkScheduleDayModel(externalCode);
TimeAccountSnapshot
listTimeAccountSnapshots
Queries the TimeAccountSnapshot collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListTimeAccountSnapshotsQueries | No | Queries to be sent with the request |
Returns: Wrapper_41|error
Sample code:
Wrapper_41 result = check client->listTimeAccountSnapshots();
Sample response:
{
"d": {}
}
getTimeAccountSnapshot
Retrieves a single TimeAccountSnapshot entity identified by its key property.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetTimeAccountSnapshotQueries | No | Queries to be sent with the request |
Returns: Time\ Account\ Snapshot|error
Sample code:
Time\ Account\ Snapshot result = check client->getTimeAccountSnapshot(externalCode);
EmpTimeAccountBalance
listEmpTimeAccountBalances
Queries the EmpTimeAccountBalance collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListEmpTimeAccountBalancesQueries | No | Queries to be sent with the request |
Returns: Wrapper_42|error
Sample code:
Wrapper_42 result = check client->listEmpTimeAccountBalances();
Sample response:
{
"d": {}
}
getEmpTimeAccountBalance
Retrieves a single EmpTimeAccountBalance entity identified by its key property.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
timeAccount | string | Yes | key: timeAccount |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetEmpTimeAccountBalanceQueries | No | Queries to be sent with the request |
Returns: Employee\ Time\ Account\ Balance|error
Sample code:
Employee\ Time\ Account\ Balance result = check client->getEmpTimeAccountBalance(timeAccount);
TimeManagementAlertMessage
listTimeManagementAlertMessages
Queries the TimeManagementAlertMessage collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListTimeManagementAlertMessagesQueries | No | Queries to be sent with the request |
Returns: json|error
Sample code:
json result = check client->listTimeManagementAlertMessages();
getTimeManagementAlertMessage
Retrieves a single TimeManagementAlertMessage entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
TimeManagementAlert_externalCode | string | Yes | key: TimeManagementAlert_externalCode |
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetTimeManagementAlertMessageQueries | No | Queries to be sent with the request |
Returns: json|error
Sample code:
json result = check client->getTimeManagementAlertMessage(TimeManagementAlert_externalCode, externalCode);
EmployeeTimeNLD
listEmployeeTimeNLDs
Queries the EmployeeTimeNLD collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListEmployeeTimeNLDsQueries | No | Queries to be sent with the request |
Returns: Wrapper_44|error
Sample code:
Wrapper_44 result = check client->listEmployeeTimeNLDs();
Sample response:
{
"d": {}
}
createEmployeeTimeNLD
Creates a new EmployeeTimeNLD entity from the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | EmployeeTimeNLD | Yes | New entity |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: CreatedEmployee\ Time\ NLD|error
Sample code:
CreatedEmployee\ Time\ NLD result = check client->createEmployeeTimeNLD(payload);
getEmployeeTimeNLD
Retrieves a single EmployeeTimeNLD entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
EmployeeTime_externalCode | string | Yes | key: EmployeeTime_externalCode |
externalCode | int | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetEmployeeTimeNLDQueries | No | Queries to be sent with the request |
Returns: Employee\ Time\ NLD|error
Sample code:
Employee\ Time\ NLD result = check client->getEmployeeTimeNLD(EmployeeTime_externalCode, externalCode);
updateEmployeeTimeNLD
Updates the EmployeeTimeNLD identified by its key properties with the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
EmployeeTime_externalCode | string | Yes | key: EmployeeTime_externalCode |
externalCode | int | Yes | key: externalCode |
payload | ModifiedEmployee\ Time\ NLD | Yes | New property values |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateEmployeeTimeNLD(EmployeeTime_externalCode, externalCode, payload);
deleteEmployeeTimeNLD
Deletes the EmployeeTimeNLD identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
EmployeeTime_externalCode | string | Yes | key: EmployeeTime_externalCode |
externalCode | int | Yes | key: externalCode |
headers | DeleteEmployeeTimeNLDHeaders | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteEmployeeTimeNLD(EmployeeTime_externalCode, externalCode);
EmployeeTimeSWE
listEmployeeTimeSWEs
Queries the EmployeeTimeSWE collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListEmployeeTimeSWEsQueries | No | Queries to be sent with the request |
Returns: Wrapper_45|error
Sample code:
Wrapper_45 result = check client->listEmployeeTimeSWEs();
Sample response:
{
"d": {}
}
createEmployeeTimeSWE
Creates a new EmployeeTimeSWE entity from the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | EmployeeTimeSWE | Yes | New entity |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: CreatedEmployee\ Time\ SWE|error
Sample code:
CreatedEmployee\ Time\ SWE result = check client->createEmployeeTimeSWE(payload);
getEmployeeTimeSWE
Retrieves a single EmployeeTimeSWE entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
EmployeeTime_externalCode | string | Yes | key: EmployeeTime_externalCode |
externalCode | int | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetEmployeeTimeSWEQueries | No | Queries to be sent with the request |
Returns: Employee\ Time\ SWE|error
Sample code:
Employee\ Time\ SWE result = check client->getEmployeeTimeSWE(EmployeeTime_externalCode, externalCode);
updateEmployeeTimeSWE
Updates the EmployeeTimeSWE identified by its key properties with the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
EmployeeTime_externalCode | string | Yes | key: EmployeeTime_externalCode |
externalCode | int | Yes | key: externalCode |
payload | ModifiedEmployee\ Time\ SWE | Yes | New property values |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateEmployeeTimeSWE(EmployeeTime_externalCode, externalCode, payload);
deleteEmployeeTimeSWE
Deletes the EmployeeTimeSWE identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
EmployeeTime_externalCode | string | Yes | key: EmployeeTime_externalCode |
externalCode | int | Yes | key: externalCode |
headers | DeleteEmployeeTimeSWEHeaders | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteEmployeeTimeSWE(EmployeeTime_externalCode, externalCode);
EmployeeTimeNOR
listEmployeeTimeNORs
Queries the EmployeeTimeNOR collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListEmployeeTimeNORsQueries | No | Queries to be sent with the request |
Returns: Wrapper_46|error
Sample code:
Wrapper_46 result = check client->listEmployeeTimeNORs();
Sample response:
{
"d": {}
}
createEmployeeTimeNOR
Creates a new EmployeeTimeNOR entity from the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | EmployeeTimeNOR | Yes | New entity |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: CreatedEmployee\ Time\ NOR|error
Sample code:
CreatedEmployee\ Time\ NOR result = check client->createEmployeeTimeNOR(payload);
getEmployeeTimeNOR
Retrieves a single EmployeeTimeNOR entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
EmployeeTime_externalCode | string | Yes | key: EmployeeTime_externalCode |
externalCode | int | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetEmployeeTimeNORQueries | No | Queries to be sent with the request |
Returns: Employee\ Time\ NOR|error
Sample code:
Employee\ Time\ NOR result = check client->getEmployeeTimeNOR(EmployeeTime_externalCode, externalCode);
updateEmployeeTimeNOR
Updates the EmployeeTimeNOR identified by its key properties with the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
EmployeeTime_externalCode | string | Yes | key: EmployeeTime_externalCode |
externalCode | int | Yes | key: externalCode |
payload | ModifiedEmployee\ Time\ NOR | Yes | New property values |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateEmployeeTimeNOR(EmployeeTime_externalCode, externalCode, payload);
deleteEmployeeTimeNOR
Deletes the EmployeeTimeNOR identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
EmployeeTime_externalCode | string | Yes | key: EmployeeTime_externalCode |
externalCode | int | Yes | key: externalCode |
headers | DeleteEmployeeTimeNORHeaders | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteEmployeeTimeNOR(EmployeeTime_externalCode, externalCode);
EmployeeTimeITA
listEmployeeTimeITAs
Queries the EmployeeTimeITA collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListEmployeeTimeITAsQueries | No | Queries to be sent with the request |
Returns: Wrapper_47|error
Sample code:
Wrapper_47 result = check client->listEmployeeTimeITAs();
Sample response:
{
"d": {}
}
createEmployeeTimeITA
Creates a new EmployeeTimeITA entity from the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | EmployeeTimeITA | Yes | New entity |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: CreatedEmployee\ Time\ ITA|error
Sample code:
CreatedEmployee\ Time\ ITA result = check client->createEmployeeTimeITA(payload);
getEmployeeTimeITA
Retrieves a single EmployeeTimeITA entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
EmployeeTime_externalCode | string | Yes | key: EmployeeTime_externalCode |
externalCode | int | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetEmployeeTimeITAQueries | No | Queries to be sent with the request |
Returns: Employee\ Time\ ITA|error
Sample code:
Employee\ Time\ ITA result = check client->getEmployeeTimeITA(EmployeeTime_externalCode, externalCode);
updateEmployeeTimeITA
Updates the EmployeeTimeITA identified by its key properties with the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
EmployeeTime_externalCode | string | Yes | key: EmployeeTime_externalCode |
externalCode | int | Yes | key: externalCode |
payload | ModifiedEmployee\ Time\ ITA | Yes | New property values |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateEmployeeTimeITA(EmployeeTime_externalCode, externalCode, payload);
deleteEmployeeTimeITA
Deletes the EmployeeTimeITA identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
EmployeeTime_externalCode | string | Yes | key: EmployeeTime_externalCode |
externalCode | int | Yes | key: externalCode |
headers | DeleteEmployeeTimeITAHeaders | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteEmployeeTimeITA(EmployeeTime_externalCode, externalCode);
EmployeeTimeCAN
listEmployeeTimeCANs
Queries the EmployeeTimeCAN collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListEmployeeTimeCANsQueries | No | Queries to be sent with the request |
Returns: Wrapper_48|error
Sample code:
Wrapper_48 result = check client->listEmployeeTimeCANs();
Sample response:
{
"d": {}
}
createEmployeeTimeCAN
Creates a new EmployeeTimeCAN entity from the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | EmployeeTimeCAN | Yes | New entity |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: CreatedEmployee\ Time\ CAN|error
Sample code:
CreatedEmployee\ Time\ CAN result = check client->createEmployeeTimeCAN(payload);
getEmployeeTimeCAN
Retrieves a single EmployeeTimeCAN entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
EmployeeTime_externalCode | string | Yes | key: EmployeeTime_externalCode |
externalCode | int | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetEmployeeTimeCANQueries | No | Queries to be sent with the request |
Returns: Employee\ Time\ CAN|error
Sample code:
Employee\ Time\ CAN result = check client->getEmployeeTimeCAN(EmployeeTime_externalCode, externalCode);
updateEmployeeTimeCAN
Updates the EmployeeTimeCAN identified by its key properties with the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
EmployeeTime_externalCode | string | Yes | key: EmployeeTime_externalCode |
externalCode | int | Yes | key: externalCode |
payload | ModifiedEmployee\ Time\ CAN | Yes | New property values |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateEmployeeTimeCAN(EmployeeTime_externalCode, externalCode, payload);
deleteEmployeeTimeCAN
Deletes the EmployeeTimeCAN identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
EmployeeTime_externalCode | string | Yes | key: EmployeeTime_externalCode |
externalCode | int | Yes | key: externalCode |
headers | DeleteEmployeeTimeCANHeaders | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteEmployeeTimeCAN(EmployeeTime_externalCode, externalCode);
TimeManagementTerminationEndHandlingLegalEntityConfiguration
listTimeManagementTerminationEndHandlingLegalEntityConfigurations
Queries the TimeManagementTerminationEndHandlingLegalEntityConfiguration collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListTimeManagementTerminationEndHandlingLegalEntityConfigurationsQueries | No | Queries to be sent with the request |
Returns: Wrapper_49|error
Sample code:
Wrapper_49 result = check client->listTimeManagementTerminationEndHandlingLegalEntityConfigurations();
Sample response:
{
"d": {}
}
getTimeManagementTerminationEndHandlingLegalEntityConfiguration
Retrieves a single TimeManagementTerminationEndHandlingLegalEntityConfiguration entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
TimeManagementTerminationEndHandlingConfiguration_externalCode | string | Yes | key: TimeManagementTerminationEndHandlingConfiguration_externalCode |
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetTimeManagementTerminationEndHandlingLegalEntityConfigurationQueries | No | Queries to be sent with the request |
Returns: Time\ Management\ Termination\ End\ Handling\ Legal\ Entity\ Configuration|error
Sample code:
Time\ Management\ Termination\ End\ Handling\ Legal\ Entity\ Configuration result = check client->getTimeManagementTerminationEndHandlingLegalEntityConfiguration(TimeManagementTerminationEndHandlingConfiguration_externalCode, externalCode);
EmployeeTimePOL
listEmployeeTimePOLs
Queries the EmployeeTimePOL collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListEmployeeTimePOLsQueries | No | Queries to be sent with the request |
Returns: Wrapper_50|error
Sample code:
Wrapper_50 result = check client->listEmployeeTimePOLs();
Sample response:
{
"d": {}
}
createEmployeeTimePOL
Creates a new EmployeeTimePOL entity from the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | EmployeeTimePOL | Yes | New entity |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: CreatedEmployee\ Time\ POL|error
Sample code:
CreatedEmployee\ Time\ POL result = check client->createEmployeeTimePOL(payload);
getEmployeeTimePOL
Retrieves a single EmployeeTimePOL entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
EmployeeTime_externalCode | string | Yes | key: EmployeeTime_externalCode |
externalCode | int | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetEmployeeTimePOLQueries | No | Queries to be sent with the request |
Returns: Employee\ Time\ POL|error
Sample code:
Employee\ Time\ POL result = check client->getEmployeeTimePOL(EmployeeTime_externalCode, externalCode);
updateEmployeeTimePOL
Updates the EmployeeTimePOL identified by its key properties with the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
EmployeeTime_externalCode | string | Yes | key: EmployeeTime_externalCode |
externalCode | int | Yes | key: externalCode |
payload | ModifiedEmployee\ Time\ POL | Yes | New property values |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateEmployeeTimePOL(EmployeeTime_externalCode, externalCode, payload);
deleteEmployeeTimePOL
Deletes the EmployeeTimePOL identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
EmployeeTime_externalCode | string | Yes | key: EmployeeTime_externalCode |
externalCode | int | Yes | key: externalCode |
headers | DeleteEmployeeTimePOLHeaders | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteEmployeeTimePOL(EmployeeTime_externalCode, externalCode);
TimeAccountPayout
listTimeAccountPayouts
Queries the TimeAccountPayout collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListTimeAccountPayoutsQueries | No | Queries to be sent with the request |
Returns: json|error
Sample code:
json result = check client->listTimeAccountPayouts();
getTimeAccountPayout
Retrieves a single TimeAccountPayout entity identified by its key property.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetTimeAccountPayoutQueries | No | Queries to be sent with the request |
Returns: json|error
Sample code:
json result = check client->getTimeAccountPayout(externalCode);
getAccountTypeNavOfTimeAccountPayout
Retrieves a single TimeAccountPayout entity identified by its key property.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetAccountTypeNavOfTimeAccountPayoutQueries | No | Queries to be sent with the request |
Returns: TimeAccountType|error
Sample code:
TimeAccountType result = check client->getAccountTypeNavOfTimeAccountPayout(externalCode);
Sample response:
{
"externalCode": "1000",
"countryExtensionAUS": {
"TimeAccountType_externalCode": "1000",
"externalCode": "1000"
},
"periodicTimeAccountUpdateProfileNav": {
"externalCode": "1000"
},
"recalculationBasedFieldList": {
"results": [
{
"TimeAccountType_externalCode": "1000",
"recalcField": "string"
}
]
},
"timeAccountPayoutProfileNav": {
"externalCode": "1000"
},
"timeAccountPurchaseProfileNav": {
"externalCode": "1000",
"deductionPayComponents": {
"results": []
}
}
}
getTimeAccountDetailNavOfTimeAccountPayout
Retrieves a single TimeAccountPayout entity identified by its key property.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetTimeAccountDetailNavOfTimeAccountPayoutQueries | No | Queries to be sent with the request |
Returns: json|error
Sample code:
json result = check client->getTimeAccountDetailNavOfTimeAccountPayout(externalCode);
getTimeAccountNavOfTimeAccountPayout
Retrieves a single TimeAccountPayout entity identified by its key property.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetTimeAccountNavOfTimeAccountPayoutQueries | No | Queries to be sent with the request |
Returns: json|error
Sample code:
json result = check client->getTimeAccountNavOfTimeAccountPayout(externalCode);
TimeAccountPayoutProfile
listTimeAccountPayoutProfiles
Queries the TimeAccountPayoutProfile collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListTimeAccountPayoutProfilesQueries | No | Queries to be sent with the request |
Returns: Wrapper_51|error
Sample code:
Wrapper_51 result = check client->listTimeAccountPayoutProfiles();
Sample response:
{
"d": {}
}
getTimeAccountPayoutProfile
Retrieves a single TimeAccountPayoutProfile entity identified by its key property.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetTimeAccountPayoutProfileQueries | No | Queries to be sent with the request |
Returns: Time\ Account\ Payout\ Profile|error
Sample code:
Time\ Account\ Payout\ Profile result = check client->getTimeAccountPayoutProfile(externalCode);
TimeAccountSummary
listTimeAccountSummarys
Queries the TimeAccountSummary collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListTimeAccountSummarysQueries | No | Queries to be sent with the request |
Returns: CollectionofTime\ Account\ Summary|error
Sample code:
CollectionofTime\ Account\ Summary result = check client->listTimeAccountSummarys();
getTimeAccountSummary
Retrieves a single TimeAccountSummary entity identified by its key property.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetTimeAccountSummaryQueries | No | Queries to be sent with the request |
Returns: TimeAccountSummary|error
Sample code:
TimeAccountSummary result = check client->getTimeAccountSummary(externalCode);
Sample response:
{
"createdBy": "string",
"createdDateTime": "2026-01-01",
"entityUUID": "1000",
"externalCode": "1000",
"lastModifiedBy": "string",
"lastModifiedDateTime": "2026-01-01",
"mdfSystemRecordStatus": "string"
}
TimeAccountTypeAUS
listTimeAccountTypeAUSs
Queries the TimeAccountTypeAUS collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListTimeAccountTypeAUSsQueries | No | Queries to be sent with the request |
Returns: Wrapper_52|error
Sample code:
Wrapper_52 result = check client->listTimeAccountTypeAUSs();
Sample response:
{
"d": {}
}
getTimeAccountTypeAUS
Retrieves a single TimeAccountTypeAUS entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
TimeAccountType_externalCode | string | Yes | key: TimeAccountType_externalCode |
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetTimeAccountTypeAUSQueries | No | Queries to be sent with the request |
Returns: Time\ Account\ Type\ AUS|error
Sample code:
Time\ Account\ Type\ AUS result = check client->getTimeAccountTypeAUS(TimeAccountType_externalCode, externalCode);
PeriodicTimeAccountUpdateProfile
listPeriodicTimeAccountUpdateProfiles
Queries the PeriodicTimeAccountUpdateProfile collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListPeriodicTimeAccountUpdateProfilesQueries | No | Queries to be sent with the request |
Returns: Wrapper_53|error
Sample code:
Wrapper_53 result = check client->listPeriodicTimeAccountUpdateProfiles();
Sample response:
{
"d": {}
}
getPeriodicTimeAccountUpdateProfile
Retrieves a single PeriodicTimeAccountUpdateProfile entity identified by its key property.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetPeriodicTimeAccountUpdateProfileQueries | No | Queries to be sent with the request |
Returns: Periodic\ Time\ Account\ Update\ Profile|error
Sample code:
Periodic\ Time\ Account\ Update\ Profile result = check client->getPeriodicTimeAccountUpdateProfile(externalCode);
AvailableTimeType
listAvailableTimeTypes
Queries the AvailableTimeType collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListAvailableTimeTypesQueries | No | Queries to be sent with the request |
Returns: Wrapper_54|error
Sample code:
Wrapper_54 result = check client->listAvailableTimeTypes();
Sample response:
{
"d": {}
}
getAvailableTimeType
Retrieves a single AvailableTimeType entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
TimeTypeProfile_externalCode | string | Yes | key: TimeTypeProfile_externalCode |
TimeTypeProfile_mdfSystemEffectiveStartDate | string | Yes | key: TimeTypeProfile_mdfSystemEffectiveStartDate |
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetAvailableTimeTypeQueries | No | Queries to be sent with the request |
Returns: Available\ Time\ Type|error
Sample code:
Available\ Time\ Type result = check client->getAvailableTimeType(TimeTypeProfile_externalCode, TimeTypeProfile_mdfSystemEffectiveStartDate, externalCode);
WorkSchedule
listWorkSchedules
Queries the WorkSchedule collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListWorkSchedulesQueries | No | Queries to be sent with the request |
Returns: Wrapper_55|error
Sample code:
Wrapper_55 result = check client->listWorkSchedules();
Sample response:
{
"d": {}
}
createWorkSchedule
Creates a new WorkSchedule entity from the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | WorkSchedule | Yes | New entity |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: CreatedWork\ Schedule|error
Sample code:
CreatedWork\ Schedule result = check client->createWorkSchedule(payload);
getWorkSchedule
Retrieves a single WorkSchedule entity identified by its key property.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetWorkScheduleQueries | No | Queries to be sent with the request |
Returns: Work\ Schedule|error
Sample code:
Work\ Schedule result = check client->getWorkSchedule(externalCode);
updateWorkSchedule
Updates the WorkSchedule identified by its key property with the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
payload | ModifiedWork\ Schedule | Yes | New property values |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateWorkSchedule(externalCode, payload);
deleteWorkSchedule
Deletes the WorkSchedule identified by its key property.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
headers | DeleteWorkScheduleHeaders | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteWorkSchedule(externalCode);
EmployeeTimeAUS
listEmployeeTimeAUSs
Queries the EmployeeTimeAUS collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListEmployeeTimeAUSsQueries | No | Queries to be sent with the request |
Returns: Wrapper_56|error
Sample code:
Wrapper_56 result = check client->listEmployeeTimeAUSs();
Sample response:
{
"d": {}
}
createEmployeeTimeAUS
Creates a new EmployeeTimeAUS entity from the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | EmployeeTimeAUS | Yes | New entity |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: CreatedEmployee\ Time\ AUS|error
Sample code:
CreatedEmployee\ Time\ AUS result = check client->createEmployeeTimeAUS(payload);
getEmployeeTimeAUS
Retrieves a single EmployeeTimeAUS entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
EmployeeTime_externalCode | string | Yes | key: EmployeeTime_externalCode |
externalCode | int | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetEmployeeTimeAUSQueries | No | Queries to be sent with the request |
Returns: Employee\ Time\ AUS|error
Sample code:
Employee\ Time\ AUS result = check client->getEmployeeTimeAUS(EmployeeTime_externalCode, externalCode);
updateEmployeeTimeAUS
Updates the EmployeeTimeAUS identified by its key properties with the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
EmployeeTime_externalCode | string | Yes | key: EmployeeTime_externalCode |
externalCode | int | Yes | key: externalCode |
payload | ModifiedEmployee\ Time\ AUS | Yes | New property values |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateEmployeeTimeAUS(EmployeeTime_externalCode, externalCode, payload);
deleteEmployeeTimeAUS
Deletes the EmployeeTimeAUS identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
EmployeeTime_externalCode | string | Yes | key: EmployeeTime_externalCode |
externalCode | int | Yes | key: externalCode |
headers | DeleteEmployeeTimeAUSHeaders | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteEmployeeTimeAUS(EmployeeTime_externalCode, externalCode);
WorkScheduleDayModelSegment
listWorkScheduleDayModelSegments
Queries the WorkScheduleDayModelSegment collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListWorkScheduleDayModelSegmentsQueries | No | Queries to be sent with the request |
Returns: Wrapper_57|error
Sample code:
Wrapper_57 result = check client->listWorkScheduleDayModelSegments();
Sample response:
{
"d": {}
}
createWorkScheduleDayModelSegment
Creates a new WorkScheduleDayModelSegment entity from the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | WorkScheduleDayModelSegment | Yes | New entity |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: CreatedWork\ Schedule\ Day\ Model\ Segment|error
Sample code:
CreatedWork\ Schedule\ Day\ Model\ Segment result = check client->createWorkScheduleDayModelSegment(payload);
getWorkScheduleDayModelSegment
Retrieves a single WorkScheduleDayModelSegment entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
WorkScheduleDayModel_externalCode | string | Yes | key: WorkScheduleDayModel_externalCode |
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetWorkScheduleDayModelSegmentQueries | No | Queries to be sent with the request |
Returns: Work\ Schedule\ Day\ Model\ Segment|error
Sample code:
Work\ Schedule\ Day\ Model\ Segment result = check client->getWorkScheduleDayModelSegment(WorkScheduleDayModel_externalCode, externalCode);
updateWorkScheduleDayModelSegment
Updates the WorkScheduleDayModelSegment identified by its key properties with the supplied payload.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
WorkScheduleDayModel_externalCode | string | Yes | key: WorkScheduleDayModel_externalCode |
externalCode | string | Yes | key: externalCode |
payload | ModifiedWork\ Schedule\ Day\ Model\ Segment | Yes | New property values |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateWorkScheduleDayModelSegment(WorkScheduleDayModel_externalCode, externalCode, payload);
deleteWorkScheduleDayModelSegment
Deletes the WorkScheduleDayModelSegment identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
WorkScheduleDayModel_externalCode | string | Yes | key: WorkScheduleDayModel_externalCode |
externalCode | string | Yes | key: externalCode |
headers | DeleteWorkScheduleDayModelSegmentHeaders | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteWorkScheduleDayModelSegment(WorkScheduleDayModel_externalCode, externalCode);
RecalculationBasedField
listRecalculationBasedFields
Queries the RecalculationBasedField collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListRecalculationBasedFieldsQueries | No | Queries to be sent with the request |
Returns: Wrapper_58|error
Sample code:
Wrapper_58 result = check client->listRecalculationBasedFields();
Sample response:
{
"d": {}
}
getRecalculationBasedField
Retrieves a single RecalculationBasedField entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
TimeAccountType_externalCode | string | Yes | key: TimeAccountType_externalCode |
recalcField | string | Yes | key: recalcField |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetRecalculationBasedFieldQueries | No | Queries to be sent with the request |
Returns: Recalculation\ Based\ Field|error
Sample code:
Recalculation\ Based\ Field result = check client->getRecalculationBasedField(TimeAccountType_externalCode, recalcField);
Holiday
listHolidays
Queries the Holiday collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListHolidaysQueries | No | Queries to be sent with the request |
Returns: Wrapper_59|error
Sample code:
Wrapper_59 result = check client->listHolidays();
Sample response:
{
"d": {
"results": [
{
"d": {}
}
]
}
}
getHoliday
Retrieves a single Holiday entity identified by its key property.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
holidayCode | string | Yes | key: holidayCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetHolidayQueries | No | Queries to be sent with the request |
Returns: Holiday|error
Sample code:
Holiday result = check client->getHoliday(holidayCode);
Sample response:
{
"d": {}
}
EmployeeTimeCalendar
listEmployeeTimeCalendars
Queries the EmployeeTimeCalendar collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListEmployeeTimeCalendarsQueries | No | Queries to be sent with the request |
Returns: json|error
Sample code:
json result = check client->listEmployeeTimeCalendars();
getEmployeeTimeCalendar
Retrieves a single EmployeeTimeCalendar entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
EmployeeTime_externalCode | string | Yes | key: EmployeeTime_externalCode |
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetEmployeeTimeCalendarQueries | No | Queries to be sent with the request |
Returns: json|error
Sample code:
json result = check client->getEmployeeTimeCalendar(EmployeeTime_externalCode, externalCode);
TimeTypeAUS
listTimeTypeAUSs
Queries the TimeTypeAUS collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListTimeTypeAUSsQueries | No | Queries to be sent with the request |
Returns: Wrapper_61|error
Sample code:
Wrapper_61 result = check client->listTimeTypeAUSs();
Sample response:
{
"d": {}
}
getTimeTypeAUS
Retrieves a single TimeTypeAUS entity identified by its key properties.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
TimeType_externalCode | string | Yes | key: TimeType_externalCode |
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetTimeTypeAUSQueries | No | Queries to be sent with the request |
Returns: Time\ Type\ AUS|error
Sample code:
Time\ Type\ AUS result = check client->getTimeTypeAUS(TimeType_externalCode, externalCode);
EmployeeTime
listEmployeeTimes
Queries the EmployeeTime collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | ListEmployeeTimesQueries | No | Queries to be sent with the request |
Returns: json|error
Sample code:
json result = check client->listEmployeeTimes();
getEmployeeTime
Retrieves a single EmployeeTime entity identified by its key property.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetEmployeeTimeQueries | No | Queries to be sent with the request |
Returns: json|error
Sample code:
json result = check client->getEmployeeTime(externalCode);
deleteEmployeeTime
Deletes the EmployeeTime identified by its key property.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
externalCode | string | Yes | key: externalCode |
headers | DeleteEmployeeTimeHeaders | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteEmployeeTime(externalCode);