Add a Department

post https://api.avionte.com/front-office/v1/departments

Adds a new department record to the system.

Body Params

compId

int32

required

The identifier for company

departmentName

string

required

length ≥ 1

The name of the department.

officeId

int32

The identifier for the office.

statusId

int32

The identifier for the status.

parentDepartmentId

int32

The identifier for the parent department.

street1

string

Street address line 1

street2

string

Street address line 2

city

string

City for department

stateProvince

string

required

length ≥ 1

Province, state, or region for department.

postalCode

string

ZIP/postal code for department.

country

string

required

length ≥ 1

Country for department.

geoCode

string

Numerical coordinate. The value is generated based on the ZIP code, city, and state of the address.

departmentPhone

string

Phone no of the branch

defaultJobOwnerIDs

array of int32s

User Ids of the default job owners of the department.

defaultJobOwnerIDs

origin

string

The origin of the department.

weekEndDate

string

Week End Date for the department.
Allowed values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday.

payPeriod

string

Pay Period for the department.
Allowed values: Daily, Weekly, BiWeekly, Monthly, SemiMonthly, Yearly, Hourly.

payCycle

string

Pay Cycle for the department.
Allowed values: 1, 2, 3, 4, Last Week.

billingPeriod

string

Billing Period for the department.
Allowed values: Daily, Weekly, BiWeekly, Monthly, SemiMonthly, Yearly, Hourly.

billingCycle

string

Billing Cycle for the department.
Allowed values: 1, 2, 3, 4, Last Week.

originRecordId

string

The identifier for the origin of the department from partner database.

Headers

FrontOfficeTenantId

string

Front office ID that indicates the tenant for which the request is being made. Either Tenant or FrontOfficeTenantId is required.

RequestId

string

Allows client-specified request correlation. Provided value must be a valid GUID.

Tenant

string

A short code that indicates the tenant for which the request is being made. Either Tenant or FrontOfficeTenantId is required.

Authorization

string

required

Contains the caller's access token, in the form "Bearer {token}", without quotes.

Responses

400

Bad Request

401

Unauthorized

403

Access Denied

406

Unsupported format(s) indicated by Accept header

409

Duplicate Found.

415

Unsupported format(s) indicated by the Content-Type header

429

Too many requests

500

An unexpected error occurred

502

The request could not be completed because an error occurred in an upstream service

201201 response