Sign in

v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Placements

Get Active Placements by Company IDs

Returns a list of active placements for the specified company IDs.

post/v1/placement/active-placements

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

IntegerSchema[] required

Response

A list of active placements for each company ID.

placementGuidstring uuid

The unique identifier for the placement, formatted as a GUID.

branchGuidstring uuid

The unique identifier for the branch associated with the talent, formatted as a GUID.

backOfficeAssignmentIdinteger

The ID of the Assignment in the Back Office.

isW2boolean

An indication of whether the placement is a W2 placement (true) or a contract placement (false).

agencyGuidstring uuid

The vendor agency GUID, used when the placement is a contract placement (IsW2 = false) and payment should be directed to the vendor instead of the talent.

jobTitlestring

Job title for the placement, as defined on the Job.

payPeriod'Unknown' | 'Weekly' | 'BiWeekly' | 'Monthly' | 'SemiMonthly' | 'Daily' | 'Yearly' | 'Hourly'

Example response

[
  {
    "WorkSiteAddress": {
      "addressGuid": "cb63d8fc-6d06-f011-87a7-a0595061251e",
      "street1": "123 Main St.",
      "street2": "Suite 250",
      "city": "Minneapolis",
      "state": "MN",
      "postalCode": "55435",
      "country": "US"
    }
  }
]