Sign in

v1

latestOpenAPI 3.0.32026-07-14265579.8 KB
Order

Retrieve order resources

Retrieve order resources is used to retrieve all orders filtered by parameters.

get/order

Query parameters

firstNamestring

Returns orders matching this specific candidate name.

lastNamestring

Returns orders matching this specific candidate name.

middleNamestring

Returns orders matching this specific candidate name.

ssnstring

Returns orders matching the specific SSN.

status'COMPLETE' | 'PENDING' | 'INCOMPLETE'

Returns orders matching the specific status.

result'FAIL' | 'SUCCESS' | 'PENDING'

Returns orders matching the specific result.

packageType'PKG_BASIC' | 'PKG_STANDARD' | 'PKG_PRO' | 'PKG_EMPTY'

Returns orders matching the specific result.

source'INTEGRATION::TALEO-EE' | 'INTEGRATION::TALEO-BE' | 'INTEGRATION::KENEXA-CS' | 'INTEGRATION::KRONOS' | 'INTEGRATION::NP' | 'INTEGRATION::AVATURE' | 'INTEGRATION::PEOPLESOFT' | 'INTEGRATION::SALESFORCE' | 'INTEGRATION::ADP' | 'INTEGRATION::STD-API' | 'INTEGRATION::API-V3' | 'INTEGRATION::ICIMS_API' | 'INTEGRATION::JOBVITE_API' | 'INTEGRATION::WORKDAY_WWS' | 'INTEGRATION::SUCCESS_FACTORS_API' | 'INTEGRATION::ULTIPRO_API' | 'INTEGRATION::SMART_RECRUITERS_API' | 'INTEGRATION::KIOSK' | 'INTEGRATION::TALEO-EE' | 'INTEGRATION::PAGEUP_API'

Returns orders matching the specific result.

createdstring date-time

Returns orders made on a specific date. Date can be passed as 2020-03-11, or 2019-12-06T19:07:20Z

beginCreatedstring date-time

Returns order made after a specific date/time. Date can be passed as 2020-03-11, or 2019-12-06T19:07:20Z

endCreatedstring date-time

Returns order made before a specific date/time. Date can be passed as 2020-03-11, or 2019-12-06T19:07:20Z

beginCompletedstring date-time

Returns order made after a specific date/time. Date can be passed as 2020-03-11, or 2019-12-06T19:07:20Z

endCompletedstring date-time

Returns order made before a specific date/time. Date can be passed as 2020-03-11, or 2019-12-06T19:07:20Z

beginUpdatedstring date-time

Returns order made after a specific date/time. Date can be passed as 2020-03-11, or 2019-12-06T19:07:20Z

endUpdatedstring date-time

Returns order made after a specific date/time. Date can be passed as 2020-03-11, or 2019-12-06T19:07:20Z

Response

Success Response

resourcestring
idstring
createdstring date-time
updatedstring date-time
maskedboolean
packageType'PKG_BASIC' | 'PKG_STANDARD' | 'PKG_PRO' | 'PKG_EMPTY'
workflow'EXPRESS' | 'INTERACTIVE'
copyOfReportboolean
clientCommentsstring
referenceCodesstring[]
candidateIdstring
candidateInfoCompleteboolean
statusstring
resultstring
percentageCompleteinteger
candidateInfoChangedboolean
sourcestring
searchIdinteger
subjectIdinteger
submittedstring date-time
supportReferenceIdstring

Example response

[
  {
    "clientComments": "Client comments",
    "complianceTokens": {
      "companyName": "Accurate",
      "companyAddress": "200 Spectrum Ctr",
      "companyCity": "Irvine",
      "companyRegion": "CA",
      "companyCountry": "US",
      "companyEmail": "elmer@wb.com"
    },
    "jobLocation": {
      "country": "US",
      "region": "CA",
      "region2": "Orange",
      "city": "Irvine"
    },
    "candidateId": "56eb1389a78e5bf65e414cfc",
    "candidate": {
      "firstName": "Elmer",
      "lastName": "Fudd",
      "middleName": "Fiddlesticks",
      "suffix": "Jr",
      "dateOfBirth": "1945-01-01T00:00:00.000Z",
      "email": "Elmer@wb.com",
      "address": "123 Silly Street",
      "city": "Lousville",
      "region": "KY",
      "country": "US",
      "governmentId": {
        "country": "US",
        "type": "SpyCard",
        "number": "ABC12345"
      }
    },
    "status": "RECEIVED",
    "result": "PENDING",
    "reports": [
      {
        "base64encodedHTML": "/report/572d0904f1b9a4602bc83a09"
      }
    ],
    "additionalProductTypes": [
      {
        "productType": "TERB"
      }
    ],
    "products": [
      {
        "id": 53756466,
        "productType": "NCRIM",
        "status": "PENDING",
        "result": "PENDING"
      }
    ],
    "documents": [
      {
        "documentId": "602ad78042dcb1000c24c7a7",
        "documentUrl": "/order/602ad1744b9ccf1bbb4fa292/document/602ad78042dcb1000c24c7a7",
        "documentName": "Addtl doc.jpg",
        "externalDocumentId": "602ad780a424f6000bf08b59"
      }
    ],
    "percentageComplete": 50,
    "source": "INTEGRATION::API-V3",
    "searchId": 197111504,
    "subjectId": 25600748
  }
]