AVavionte
Jobs
Placements

Get an Overtime Rule

Returns details about the specified overtime rule.

get/v1/rules/overtime/{otRuleId}

Request

  • Base URL
    https://api.avionte.com/front-office
  • URL
    https://api.avionte.com/front-office/v1/rules/overtime/{otRuleId}
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

otRuleIdstring required

The identifier for the Overtime Rule to retrieve.

Headers

RequestIdstring uuid

Unique request identifier in UUID format used to correlate request data to log entries and events.

Example:63680b86-c7e0-4a36-ae4a-d0d481089aff

Unique request identifier (UUID) used to correlate request data with log entries and events.

FrontOfficeTenantIdinteger

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Response

The Overtime Rule details.

ruleIdinteger

The identifier for the overtime rule.

ruleNamestring

The name of the overtime rule.

Example response

{
  "ruleId": 12345,
  "ruleName": "Standard Overtime Rule"
}

Changes

No recorded changes to this operation across all 1 revision of this API.