Sign in

v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Departments

Update a Department

Updates an existing department record.

patch/v1/department/{departmentId}

Path parameters

departmentIdstring required

The identifier for the department to update.

Headers

RequestIdstring uuid

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

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.

Request body

op'replace'

The operation to perform. Only 'replace' is supported.

path'/name' | '/officeId' | '/statusId' | '/address/street1' | '/address/street2' | '/address/city' | '/address/state_Province' | '/address/postalCode' | '/address/country' | '/departmentPhone' | '/defaultJobOwnerIDs' | '/weekendDay' | '/payPeriod' | '/payCycle' | '/billingPeriod' | '/billingCycle'

A JSON Pointer indicating the department field to update.

{"stackTrail":"paths:/v1/department/{departmentId}:patch:requestBody:content:application/json:schema:items:properties:value","oasType":"schema","type":"unknown","description":"The new value to set for the specified path. Valid values for /weekendDay are: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday. Valid values for /payPeriod and /billingPeriod are: Hourly, Daily, Weekly, BiWeekly, SemiMonthly, Monthly, Yearly. Valid values for /payCycle and /billingCycle are: 1, 2, 3, 4, Last Week. The /address/stateProvince and /address/country fields must be two-character ISO codes."}

Response

The updated department record.

companyExternalIdstring nullable

The unique system-defined identifier for the Company.

companyGuidstring uuid nullable

The Back Office unique identifier for the Company, formatted as a UUID.

departmentExternalIdstring nullable

The unique system-defined identifier for the Company Department.

departmentGuidstring uuid nullable

The Back Office unique identifier for the Department, formatted as a UUID.

departmentNamestring

The name of the company department.