Companies

Add Restrictions for a Company

Adds talent as 'do not place' for a company.

post/v1/company-restrictions

Request

Base URL
https://api.avionte.com/front-office
URL
https://api.avionte.com/front-office/v1/company-restrictions
Auth
- API key in header x-api-key
- or HTTP bearer

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.

Request body

dnaIDinteger

The identifier for the restriction.

companyIDinteger

The identifier for the company.

branchIDsinteger[]

The identifiers for the departments the restriction applies to.

talentIDinteger

The identifier for the talent.

restrictedByUserIDinteger

The identifier for the user who added the restriction.

dnaDatestring date-time

The date when restriction was added. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.

dnaNotesstring

The notes for the restriction.

Example request

{
  "dnaID": 123,
  "companyID": 456,
  "branchIDs": [
    789,
    101112
  ],
  "talentID": 18394,
  "restrictedByUserID": 12345,
  "dnaNotes": "This is a sample note."
}

Response

The created company restriction.

idinteger

The identifier for the company restriction.

companyIdinteger

The identifier for the company the restriction applies to.

branchIdsstring

The string representation of the array of identifiers for the departments the restriction applies to.

talentNamestring

The name of the talent who has been restricted from placement.

notesstring

Notes on the restriction.

userIdinteger

The identifier for the user who has added the restriction.

userNamestring

The name of the user who has added a restriction.

companyNamestring

The name of the company the restriction applies to.

talentIdinteger

The identifier for the talent who is blocked from placement at the selected company or office.

restrictionDatestring date-time

The date when the restriction has been added. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.

Example response

{
  "id": 123456,
  "companyId": 284997,
  "branchIds": "[1835, 1383, 1922]",
  "talentName": "John Doe",
  "notes": "This talent is not eligible for placement due to previous performance issues.",
  "userId": 12345,
  "userName": "Jane Smith",
  "companyName": "Acme Corp",
  "talentId": 123456,
  "departments": [
    {
      "id": 123456,
      "name": "Warehouse",
      "companyId": 12345,
      "officeId": 67890,
      "statusId": 143,
      "status": "Active",
      "statusType": "General",
      "parentDepartmentId": 98765,
      "address": {
        "street1": "123 Main Street",
        "street2": "Suite 100",
        "city": "St. Paul",
        "state_Province": "MN",
        "postalCode": "55121",
        "country": "US",
        "county": "Dakota",
        "geoCode": "241231070",
        "schoolDistrictCode": "00000"
      },
      "addresses": [
        {
          "street1": "123 Main Street",
          "street2": "Suite 100",
          "city": "St. Paul",
          "state_Province": "MN",
          "postalCode": "55121",
          "country": "US",
          "county": "Dakota",
          "geoCode": "241231070",
          "schoolDistrictCode": "00000",
          "addressId": 12345,
          "branchId": 12346,
          "companyId": 12347,
          "phone": "+1-555-123-4567",
          "isDefault": true,
          "origin": "Acme Partner",
          "salesTaxes": [
            {
              "configSalesTaxGUID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
              "name": "Minnesota State Tax",
              "description": "MN state sales tax rate",
              "state": "MN"
            }
          ]
        }
      ],
      "departmentPhone": "234-567-8900",
      "defaultJobOwnerIDs": [
        123456,
        789012
      ],
      "origin": "Acme Partner",
      "originId": 54321,
      "weekendDay": "Friday",
      "payPeriod": "Weekly",
      "payCycle": "2",
      "billingPeriod": "BiWeekly",
      "billingCycle": "2",
      "originRecordId": "DEPT-12345"
    }
  ]
}

Changes

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