Sign in

v1

latestOpenAPI 3.0.12026-07-245752052.0 MB
employmentProfiles

partially update one existing employmentProfile

Partially update one existing employmentProfile

patch/api/serviceemployment/employmentProfiles/{identifier}

Path parameters

identifierstring uuid required

employmentProfile unique identifier

Request body

uuidstring uuid required

Unique identifier

createdAtstring date-time

Creation timestamp

createdBystring uuid

Creator UUID

lastUpdatedAtstring date-time

Last update timestamp

lastUpdatedBystring uuid

Last updater UUID

lastUpdatedByAudiencestring

Audience of last updater

lastUpdatedByAudienceUuidstring uuid

Audience UUID of last updater

lastUpdatedByImpersonatedBystring uuid

Impersonator UUID

lastUpdatedByCompanyUuidstring uuid

Company UUID of last updater

lastUpdatedByEnterpriseUuidstring uuid

Enterprise UUID of last updater

companyUuidstring uuid required

Company UUID

peopleUuidstring uuid required

UUID of the people record

i9Casesobject

I-9 cases associated with the profile

dataCollectionSubmittedboolean required

Indicates if the data collection has been submitted

everifyCasesobject

E-Verify cases associated with the profile

w4Casesobject

W-4 cases associated with the profile

workerCasesobject required

Worker cases associated with the profile

workerUuidsstring[] required

Array of worker UUIDs associated with the profile (derived from workerCases)

readOnlyboolean required

Indicates if the profile is read-only and cannot be modified

{"stackTrail":"components:schemas:EmploymentProfile:properties:profileErrors","oasType":"schema","type":"unknown","description":"Validation issues, external system errors, or other error data","nullable":true}

Example request

{
  "uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
  "createdAt": "2021-05-05T01:02:03.924Z",
  "createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
  "lastUpdatedAt": "2021-05-05T04:05:06.924Z",
  "lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
  "lastUpdatedByAudience": "employer",
  "lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
  "lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
  "lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
  "lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
  "companyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
  "peopleUuid": "b9b128c6-0cea-4afb-8ec5-8b56b43836d4",
  "workerUuids": [
    "72f4c54f-fd36-44da-b19e-88a5e689c1c6",
    "74b1867c-2cf2-4f71-bc38-46004578ded4"
  ],
  "employeeIds": [
    {
      "subdomain": "fountain-sandbox",
      "employeeId": 123456
    }
  ],
  "virtualWorkers": [
    {
      "uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
      "locationUuids": [
        "e3425972-86df-4384-9f40-8de005ba30b0"
      ],
      "securityGroupUuids": [
        "887436c5-47f4-43cc-963a-1d1d4e21f665"
      ],
      "jobIdentifiers": [
        {
          "jobUuid": "e1e3da43-915e-4ed9-97dc-175f458821ac",
          "relationship": "primary"
        }
      ],
      "openingUuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426"
    }
  ]
}

Response

updated employmentProfile. Wrapped in a JsonAPI root response.

Example response

{
  "data": {
    "uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
    "createdAt": "2021-05-05T01:02:03.924Z",
    "createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
    "lastUpdatedAt": "2021-05-05T04:05:06.924Z",
    "lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
    "lastUpdatedByAudience": "employer",
    "lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
    "lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
    "lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
    "lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
    "companyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
    "peopleUuid": "b9b128c6-0cea-4afb-8ec5-8b56b43836d4",
    "workerUuids": [
      "72f4c54f-fd36-44da-b19e-88a5e689c1c6",
      "74b1867c-2cf2-4f71-bc38-46004578ded4"
    ],
    "employeeIds": [
      {
        "subdomain": "fountain-sandbox",
        "employeeId": 123456
      }
    ],
    "virtualWorkers": [
      {
        "uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
        "locationUuids": [
          "e3425972-86df-4384-9f40-8de005ba30b0"
        ],
        "securityGroupUuids": [
          "887436c5-47f4-43cc-963a-1d1d4e21f665"
        ],
        "jobIdentifiers": [
          {
            "jobUuid": "e1e3da43-915e-4ed9-97dc-175f458821ac",
            "relationship": "primary"
          }
        ],
        "openingUuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426"
      }
    ]
  },
  "meta": {
    "timestamp": "2021-05-05T09:47:58.924Z",
    "verb": "GET",
    "path": "/api/structure/resources/5949cf7c-fec6-4b31-947c-3aceabff58c5",
    "jti": "%cQN3RIGp",
    "rid": "$2d2zkHZ5",
    "count": 1,
    "status": "200",
    "duration": 17,
    "size": 1234
  }
}