diff --git a/guide.html b/guide.html index e7aa7fd..2cf9765 100644 --- a/guide.html +++ b/guide.html @@ -369,11 +369,11 @@

Get metadata for custom objects

“confidential” : false, “label” : “Custom Object9s”, “optionsType” : “PersonCustomObjectInstance9”, - “optionsUrl” : “https://rest.bullhornstaffing.com/rest-services/1yg8p/options/PersonCustomObjectInstance9”, + “optionsUrl” : “https://rest{swimlane#}.bullhornstaffing.com/rest-services/1yg8p/options/PersonCustomObjectInstance9”, “hideFromSearch” : false, “associatedEntity” : { “entity” : “PersonCustomObjectInstance9”, - “entityMetaUrl” : “https://rest.bullhornstaffing.com/rest-services/1yg8p/meta/PersonCustomObjectInstance9?fields=”, + “entityMetaUrl” : “https://rest{swimlane#}.bullhornstaffing.com/rest-services/1yg8p/meta/PersonCustomObjectInstance9?fields=”, “label” : “ClientDefinedCO”, “dateLastModified” : “1505885678477”, “fields” : [ { @@ -443,11 +443,11 @@

Client-defined custom object meta “confidential” : false, “label” : “Person”, “optionsType” : “Person”, - “optionsUrl” : “https://rest.bullhornstaffing.com/rest-services/1yg8p/options/Person”, + “optionsUrl” : “https://rest{swimlane#}.bullhornstaffing.com/rest-services/1yg8p/options/Person”, “hideFromSearch” : false, “associatedEntity” : { “entity” : “Person”, - “entityMetaUrl” : “https://rest.bullhornstaffing.com/rest-services/1yg8p/meta/Person?fields=*”, + “entityMetaUrl” : “https://rest{swimlane#}.bullhornstaffing.com/rest-services/1yg8p/meta/Person?fields=*”, “label” : “Person”, “dateLastModified” : “1505885679669”, “fields” : [ { @@ -485,7 +485,7 @@

Client-defined custom object meta “confidential” : false, “label” : “clientDefinedText”, “optionsType” : “$PersonclientDefinedText”, - “optionsUrl” : “https://rest.bullhornstaffing.com/rest-services/1yg8p/options/$PersonclientDefinedText”, + “optionsUrl” : “https://rest{swimlane#}.bullhornstaffing.com/rest-services/1yg8p/options/$PersonclientDefinedText”, “hideFromSearch” : false } ], “staticTemplateName” : “ClientDefinedCO”, @@ -517,11 +517,11 @@

Static custom object metadata

“confidential” : false, “label” : “Custom Object2s”, “optionsType” : “PersonCustomObjectInstance2”, - “optionsUrl” : “https://rest.bullhornstaffing.com/rest-services/1yg8p/options/PersonCustomObjectInstance2”, + “optionsUrl” : “https://rest{swimlane#}.bullhornstaffing.com/rest-services/1yg8p/options/PersonCustomObjectInstance2”, “hideFromSearch” : false, “associatedEntity” : { “entity” : “PersonCustomObjectInstance2”, - “entityMetaUrl” : “https://rest.bullhornstaffing.com/rest-services/1yg8p/meta/PersonCustomObjectInstance2?fields=”, + “entityMetaUrl” : “https://rest{swimlane#}.bullhornstaffing.com/rest-services/1yg8p/meta/PersonCustomObjectInstance2?fields=”, “label” : “RestAutomation1”, “fields” : [ { “name” : “date1”, @@ -848,11 +848,11 @@

Get metadata for custom objects

“confidential” : false, “label” : “Custom Object9s”, “optionsType” : “PersonCustomObjectInstance9”, - “optionsUrl” : “https://rest.bullhornstaffing.com/rest-services/1yg8p/options/PersonCustomObjectInstance9”, + “optionsUrl” : “https://rest{swimlane#}.bullhornstaffing.com/rest-services/1yg8p/options/PersonCustomObjectInstance9”, “hideFromSearch” : false, “associatedEntity” : { “entity” : “PersonCustomObjectInstance9”, - “entityMetaUrl” : “https://rest.bullhornstaffing.com/rest-services/1yg8p/meta/PersonCustomObjectInstance9?fields=”, + “entityMetaUrl” : “https://rest{swimlane#}.bullhornstaffing.com/rest-services/1yg8p/meta/PersonCustomObjectInstance9?fields=”, “label” : “ClientDefinedCO”, “dateLastModified” : “1505885678477”, “fields” : [ { @@ -922,11 +922,11 @@

Client-defined custom object meta “confidential” : false, “label” : “Person”, “optionsType” : “Person”, - “optionsUrl” : “https://rest.bullhornstaffing.com/rest-services/1yg8p/options/Person”, + “optionsUrl” : “https://rest{swimlane#}.bullhornstaffing.com/rest-services/1yg8p/options/Person”, “hideFromSearch” : false, “associatedEntity” : { “entity” : “Person”, - “entityMetaUrl” : “https://rest.bullhornstaffing.com/rest-services/1yg8p/meta/Person?fields=*”, + “entityMetaUrl” : “https://rest{swimlane#}.bullhornstaffing.com/rest-services/1yg8p/meta/Person?fields=*”, “label” : “Person”, “dateLastModified” : “1505885679669”, “fields” : [ { @@ -964,7 +964,7 @@

Client-defined custom object meta “confidential” : false, “label” : “clientDefinedText”, “optionsType” : “$PersonclientDefinedText”, - “optionsUrl” : “https://rest.bullhornstaffing.com/rest-services/1yg8p/options/$PersonclientDefinedText”, + “optionsUrl” : “https://rest{swimlane#}.bullhornstaffing.com/rest-services/1yg8p/options/$PersonclientDefinedText”, “hideFromSearch” : false } ], “staticTemplateName” : “ClientDefinedCO”, @@ -996,11 +996,11 @@

Static custom object metadata

“confidential” : false, “label” : “Custom Object2s”, “optionsType” : “PersonCustomObjectInstance2”, - “optionsUrl” : “https://rest.bullhornstaffing.com/rest-services/1yg8p/options/PersonCustomObjectInstance2”, + “optionsUrl” : “https://rest{swimlane#}.bullhornstaffing.com/rest-services/1yg8p/options/PersonCustomObjectInstance2”, “hideFromSearch” : false, “associatedEntity” : { “entity” : “PersonCustomObjectInstance2”, - “entityMetaUrl” : “https://rest.bullhornstaffing.com/rest-services/1yg8p/meta/PersonCustomObjectInstance2?fields=”, + “entityMetaUrl” : “https://rest{swimlane#}.bullhornstaffing.com/rest-services/1yg8p/meta/PersonCustomObjectInstance2?fields=”, “label” : “RestAutomation1”, “fields” : [ { “name” : “date1”, diff --git a/index.html b/index.html index 8212aef..0c406ef 100644 --- a/index.html +++ b/index.html @@ -701,7 +701,7 @@

Errors

allCorpNotes

GET /allCorpNotes

-
curl https://rest.bullhornstaffing.com/rest-services/e999/allCorpNotes?clientCorpId=4&fields=start=0&count=5
+
curl https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/allCorpNotes?clientCorpId=4&fields=start=0&count=5
 
 # Example Response
 {
@@ -765,10 +765,80 @@ 

HTTP Request

-

Entitlements

+

association

+ +

POST /association

+
curl -X POST \
+     -H "Content-Type: application/json" \
+     -d '{ "ids": [7681,2625,1464], "showTotalMatched": true, "start": 0, "count": 3}' \
+      https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/association/Candidate/primarySkills
+
+# Example Response
+{
+    "total": 24,
+    "data": [
+        [
+            7681,
+            10115
+        ],
+        [
+            2625,
+            19739
+        ],
+        [
+            1464,
+            241506
+        ]
+    ]
+}
+
+ +

Retrieves a list of associated entity ids for a given entity. The association field can be a to-many or to-one association.

+ +

HTTP Request

+ +

{corpToken}/association/{entity}/{association field}

+ +

Note: The ids parameter is the only required parameter and must be set in the request body as JSON. All other parameters can be set in the request body or as query parameters on the URL.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterRequiredDescription
idsyesList of entity ids. Must be set in the body of the request rather than in a URL query parameter.
countnoLimit on the number of records to return. If the set of matched results is larger than count, cap the returned results at size count. The Max allowed count is 10000.
startnoFrom the set of matched results, return record numbers start through (start + count).
showTotalMatchedno(true/false) When set to true, the total count of matching items is returned.
BhRestTokennoToken that represents a session established by the login process. Must be sent with all subsequent requests to the API. The session key can be provided in the BhRestToken query string, a cookie, or an HTTP header.
+ +

entitlements

GET /entitlements

-
curl https://rest.bullhornstaffing.com/rest-services/e999/entitlements/Candidate
+
curl https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/entitlements/Candidate
 
 # Example Response
 [
@@ -849,10 +919,10 @@ 

File privacy entitlements

  • If file ownership is enabled, the user is the owner (uploader) of the file; otherwise, the user is the owner or secondary owner of the entity to which the file is associated
  • -

    Entity

    +

    entity

    GET /entity

    -
    curl https://rest.bullhornstaffing.com/rest-services/e999/entity/Candidate/5059165?fields=firstName,lastName,address
    +
    curl https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/entity/Candidate/5059165?fields=firstName,lastName,address
     
     # Example Response
     {
    @@ -926,7 +996,7 @@ 

    HTTP Request

    Multiple Entities

    -
    curl https://rest.bullhornstaffing.com/rest-services/e999/entity/Candidate/123,456?fields=id,firstName,lastName
    +
    curl https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/entity/Candidate/123,456?fields=id,firstName,lastName
     
     # Example Response
     {
    @@ -997,7 +1067,7 @@ 

    HTTP Request

    To-many Associations

    -
    curl https://rest.bullhornstaffing.com/rest-services/e999/entity/ClientCorporation/5059165,2362648/clientContacts?fields=firstName,lastName,address&count=2
    +
    curl https://rest{{swimlane#}.bullhornstaffing.com/rest-services/e999/entity/ClientCorporation/5059165,2362648/clientContacts?fields=firstName,lastName,address&count=2
     
     # Example Response
     {
    @@ -1450,10 +1520,10 @@ 

    Associated effective-dated ent

    In the examples, Location is an effective-dated entity field requested from an associated Placement. The effectiveOn value is applied to the requested Location.

    -

    Department Entities

    +

    departmentEntities

    GET /department{Entity}s

    -
    curl https://rest.bullhornstaffing.com/rest-services/e999/departmentClientContacts?fields=firstName,lastName,address&start=0&count=5
    +
    curl https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/departmentClientContacts?fields=firstName,lastName,address&start=0&count=5
     
     # Example Response
     {
    @@ -1580,10 +1650,10 @@ 

    HTTP Request

    -

    My Entities

    +

    myEntities

    GET /my{Entity}s

    -
    curl https://rest.bullhornstaffing.com/rest-services/e999/myClientContacts?fields=firstName,lastName,address&start=0&count=5
    +
    curl https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/myClientContacts?fields=firstName,lastName,address&start=0&count=5
     
     # Example Response
     {
    @@ -1710,10 +1780,10 @@ 

    HTTP Request

    -

    File

    +

    file

    GET /file

    -
    curl https://rest.bullhornstaffing.com/rest-services/e999/file/Candidate/3835/231
    +
    curl https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/file/Candidate/3835/231
     
     # Example Response
     {"File": {
    @@ -1761,7 +1831,7 @@ 

    HTTP Request

    GET /entityFiles

    (deprecated; replaced by /entity/{entityType}/{entityId}/fileAttachments)

    -
    curl https://rest.bullhornstaffing.com/rest-services/e999/entityFiles/Candidate/203866
    +
    curl https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/entityFiles/Candidate/203866
     
     # Example Response
     {"EntityFiles": [
    @@ -1815,7 +1885,7 @@ 

    HTTP Request

    GET /entity/{entityType}/{entityId}/fileAttachments

    -
    curl https://rest.bullhornstaffing.com/rest-services/e999/entity/JobOrder/203866/fileAttachments?fields=id
    +
    curl https://rest{{swimlane#}.bullhornstaffing.com/rest-services/e999/entity/JobOrder/203866/fileAttachments?fields=id
     
     # Example Response
     {
    @@ -2202,10 +2272,10 @@ 

    HTTP Request

    -

    Find

    +

    find

    GET /find

    -
    curl https://rest.bullhornstaffing.com/rest-services/e999/find?query=smith&countPerEntity=3
    +
    curl https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/find?query=smith&countPerEntity=3
     
     # Example Response
     {
    @@ -2452,7 +2522,7 @@ 

    Query logic

    -

    Login

    +

    login

    Partner login using OAuth

    curl https://rest.bullhornstaffing.com/login?access_token=xxx&version=*
    @@ -2460,7 +2530,7 @@ 

    Partner login using OAuth

    # Example Response { "BhRestToken" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", - "restUrl" : "https://rest.bullhornstaffing.com/rest-services/{corpToken}/" + "restUrl" : "https://rest{swimlane#}.bullhornstaffing.com/rest-services/{corpToken}/" }
    @@ -2499,7 +2569,7 @@

    Partner login using OAuth

    Logout

    -
    curl https://rest.bullhornstaffing.com/rest-services/e999/logout
    +
    curl https://rest{{swimlane#}.bullhornstaffing.com/rest-services/e999/logout
     
     # Example Response
     {
    @@ -2509,10 +2579,10 @@ 

    Logout

    Log out and invalidate your REST session.

    -

    Mass Update

    +

    massUpdate

    GET /massUpdate

    -
    curl https://rest.bullhornstaffing.com/rest-services/e999/massUpdate
    +
    curl https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/massUpdate
     
     # Example Response
     [
    @@ -2551,7 +2621,7 @@ 

    HTTP Request

    GET /massUpdate/{entityType}

    -
    curl https://rest.bullhornstaffing.com/rest-services/e999/massUpdate/JobOrder
    +
    curl https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/massUpdate/JobOrder
     
     # Example Response
     [ {
    @@ -2597,7 +2667,7 @@ 

    POST /massUpdate/{e
    curl -X POST \
          -H "Content-Type: application/json" \
          -d '{"ids": [789,790], "status": "active"}' \
    -     https://rest.bullhornstaffing.com/rest-services/e999/massUpdate/JobOrder
    +     https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/massUpdate/JobOrder
     
     # Example Response
     {
    @@ -2643,36 +2713,36 @@ 

    POST /massUpdate/{e }

    -

    Meta

    +

    meta

    GET /meta

    -
    curl https://rest.bullhornstaffing.com/rest-services/e999/meta
    +
    curl https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/meta
     
     # Example Response
     [
         {
             "entity": "Appointment",
    -        "metaUrl": "https://rest.bullhornstaffing.com/rest-services/e999/meta/Appointment?fields=*"
    +        "metaUrl": "https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/meta/Appointment?fields=*"
         },
         {
             "entity": "BusinessSector",
    -        "metaUrl": "https://rest.bullhornstaffing.com/rest-services/e999/meta/BusinessSector?fields=*"
    +        "metaUrl": "https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/meta/BusinessSector?fields=*"
         },
         {
             "entity": "Candidate",
    -        "metaUrl": "https://rest.bullhornstaffing.com/rest-services/e999/meta/Candidate?fields=*"
    +        "metaUrl": "https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/meta/Candidate?fields=*"
         },
         {
             "entity": "Category",
    -        "metaUrl": "https://rest.bullhornstaffing.com/rest-services/e999/meta/Category?fields=*"
    +        "metaUrl": "https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/meta/Category?fields=*"
         },
         {
             "entity": "ClientContact",
    -        "metaUrl": "https://rest.bullhornstaffing.com/rest-services/e999/meta/ClientContact?fields=*"
    +        "metaUrl": "https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/meta/ClientContact?fields=*"
         },
         {
             "entity": "ClientCorporation",
    -        "metaUrl": "https://rest.bullhornstaffing.com/rest-services/e999/meta/ClientCorporation?fields=*"
    +        "metaUrl": "https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/meta/ClientCorporation?fields=*"
         },
         ...
     ]
    @@ -2683,11 +2753,11 @@ 

    GET /meta

    Read-only system fields ( fields with names prefixed with _ ) are not represented in entity metadata ever, even with * calls.

    GET /meta/{Entity}

    -
    curl https://rest.bullhornstaffing.com/rest-services/e999/meta/Candidate?fields=*
    +
    curl https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/meta/Candidate?fields=*
     # Example Response
     {
       "entity" : "Candidate",
    -  "entityMetaUrl" : "https://rest.bullhornstaffing.com/rest-services/e999/meta/Candidate?fields=*",
    +  "entityMetaUrl" : "https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/meta/Candidate?fields=*",
       "label" : "Candidate",
       "fields" : { {
         "name" : "id",
    @@ -2812,28 +2882,28 @@ 

    Property Metadata

    Entity metadata for TO_ONE and TO_MANY type.

    -

    Options

    +

    options

    GET /options

    -
    curl https://rest.bullhornstaffing.com/rest-services/e999/options
    +
    curl https://rest{{swimlane#}.bullhornstaffing.com/rest-services/e999/options
     
     # Example Response
     {
       "data" : [ {
         "optionsType" : "BillRateCategory",
    -    "optionsUrl" : "https://rest.bullhorn.com/rest-services/e999/options/BillRateCategory"
    +    "optionsUrl" : "https://rest{swimlane#}.bullhorn.com/rest-services/e999/options/BillRateCategory"
       }, {
         "optionsType" : "BusinessSector",
    -    "optionsUrl" : "https://rest.bullhorn.com/rest-services/e999/options/BusinessSector"
    +    "optionsUrl" : "https://rest{swimlane#}.bullhorn.com/rest-services/e999/options/BusinessSector"
       }, {
         "optionsType" : "BusinessSectorText",
    -    "optionsUrl" : "https://rest.bullhorn.com/rest-services/e999/options/BusinessSectorText"
    +    "optionsUrl" : "https://rest{swimlane#}.bullhorn.com/rest-services/e999/options/BusinessSectorText"
       }, {
         "optionsType" : "Candidate",
    -    "optionsUrl" : "https://rest.bullhorn.com/rest-services/e999/options/Candidate"
    +    "optionsUrl" : "https://rest{swimlane#}.bullhorn.com/rest-services/e999/options/Candidate"
       }, {
         "optionsType" : "CandidateText",
    -    "optionsUrl" : "https://rest.bullhorn.com/rest-services/e999/options/CandidateText"
    +    "optionsUrl" : "https://rest{swimlane#}.bullhorn.com/rest-services/e999/options/CandidateText"
       },
     ...
     ]
    @@ -2860,7 +2930,7 @@ 

    HTTP Request

    GET /options/{optionsType}

    -
    curl https://rest.bullhornstaffing.com/rest-services/e999/options/Country
    +
    curl https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/options/Country
     
     # Example Response
     {
    @@ -3029,10 +3099,10 @@ 

    Option Types List

    -

    Ping

    +

    ping

    GET /ping

    -
    curl https://rest.bullhornstaffing.com/rest-services/e999/ping
    +
    curl https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/ping
     
     # Example Response
     {
    @@ -3056,10 +3126,10 @@ 

    GET /ping

    -

    Query

    +

    query

    GET /query

    -
    curl https://rest.bullhornstaffing.com/rest-services/e999/query/ClientContact?fields=firstName,lastName&where=lastName='smith'&count=3
    +
    curl https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/query/ClientContact?fields=firstName,lastName&where=lastName='smith'&count=3
     
     # Example Response
     {
    @@ -3154,7 +3224,7 @@ 

    POST /query

    curl -X POST \
          -H "Content-Type: application/json" \
          -d '{"where": "id IN (10125, 10126, 10127, 10128, 10129, 10130, 10131, 10132, 10133, 10134, 10135, 10136, 10137, 10138, 17376, 26865, 67604, 67605, 80203, 80204, 80205, 80206, 80207, 80208, 80209, 80210, 80211, 80212, 80213, 80214)"}' \
    -      https://rest.bullhornstaffing.com/rest-services/e999/query/ClientContact?fields=id,firstName,lastname&count=3
    +      https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/query/ClientContact?fields=id,firstName,lastname&count=3
     
     # Example Response
     {
    @@ -3295,23 +3365,15 @@ 

    Boolean values

    Datetime values

      -
    • UNIX long millis. For example, dateAdded > 1324579022

    • -
    • ISO 8601 Date Time String. For example, dateAdded > '1997-07-16T19:20:30.45+01:00’

    • -
    • Date Time String without Time Zone (default is America/New_York). In the format 'yyyy-MM-dd hh:mm:ss.SSS’

    • -
    • Date Time String with Time Zone 'yyyy-MM-dd hh:mm:ss.SSS TZ’ where TZ may be specified as:

      - -
        -
      • Full TZ name, such as 'Asia/Tokyo’
      • -
      • An offset [-]hh:mm. For example, 3:00 or -5:00
      • -
    • +
    • UNIX long millis. For example, dateAdded > 1324579022
    -

    Resume

    +

    resume

    POST /resume/parseToCandidate

    curl -X POST \
          -F "file=@sampleresume.html" \
    -     https://rest.bullhorn.com/rest-services/e999/resume/parseToCandidate?format=text&populateDescription=html
    +     https://rest{swimlane#}.bullhorn.com/rest-services/e999/resume/parseToCandidate?format=text&populateDescription=html
     
     # Example Response
     {
    @@ -3392,7 +3454,7 @@ 

    POST /resu -H "Content-Type: application/json" \ -d '{"resume" : "\r\n\r\nDr. Minun Keskimm\u00E4inen Nimi\r\n123 Osoite Katu\r\nApartment 1\r\nKaupunki, MA 02210\r\nHome: 466-346-4663 \u00A0Business: 387-438-3874 ext. 89 \u00A0Mobile: 662-466-6624\r\nTelephone: 835-383-8353 ext. 90 \u00A0VoiceNumber: 864-386-8643\r\nFax: 329-329-3290 \u00A0Pager: 724-772-7247\r\nMinun.Nimi@finland.com ...}' \ \ - https://rest.bullhorn.com/rest-services/e999/resume/parseToCandidateViaJson?format=text&populateDescription=html + https://rest{swimlane#}.bullhorn.com/rest-services/e999/resume/parseToCandidateViaJson?format=text&populateDescription=html # Example Response { @@ -3470,7 +3532,7 @@

    HTTP Request

    POST /resume/parseToHrXml

    curl -X POST \
          -F "file=@sampleresume.pdf" \
    -     https://rest.bullhorn.com/rest-services/e999/resume/parseToHrXml?format=pdf
    +     https://rest{swimlane#}.bullhorn.com/rest-services/e999/resume/parseToHrXml?format=pdf
     # Example Response
     {"hrXml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Resume \
      xmlns=\"http://ns.hr-xml.org\" xmlns:hr=\"http://ns.hr-xml.org/PersonDescriptors\" \
    @@ -3516,7 +3578,7 @@ 

    POST /resume/p Telephone: 835-383-8353 ext. 90 \u00A0VoiceNumber: 864-386-8643\r\n \ Fax: 329-329-3290 \u00A0Pager: 724-772-7247\r\nMinun.Nimi@finland.com ...}' \ \ - https://rest.bullhorn.com/rest-services/e999/resume/parseToHrXmlViaJson?format=text&format=html + https://rest{swimlane#}.bullhorn.com/rest-services/e999/resume/parseToHrXmlViaJson?format=text&format=html # Example Response {"hrXml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Resume \ @@ -3559,7 +3621,7 @@

    HTTP Request

    POST /resume/convertToText|Html

    curl -X POST \
          -F "file=@sampleresume.pdf" \
    -     https://rest.bullhornstaffing.com/rest-services/e999/resume/convertToHtml?format=pdf
    +     https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/resume/convertToHtml?format=pdf
     
     # Example Response
     {
    @@ -3614,7 +3676,7 @@ 

    POST /re -H "Content-Type: application/json" \ -d '{"resume" : "\r\n\r\nDr. Minun Keskimm\u00E4inen Nimi\r\n123 Osoite Katu\r\nApartment 1\r\nKaupunki, MA 02210\r\nHome: 466-346-4663 \u00A0Business: 387-438-3874 ext. 89 \u00A0Mobile: 662-466-6624\r\nTelephone: 835-383-8353 ext. 90 \u00A0VoiceNumber: 864-386-8643\r\nFax: 329-329-3290 \u00A0Pager: 724-772-7247\r\nMinun.Nimi@finland.com ...}' \ \ - https://rest.bullhorn.com/rest-services/e999/resume/convertToTextViaJson?format=html + https://rest{swimlane#}.bullhorn.com/rest-services/e999/resume/convertToTextViaJson?format=html # Example Response {"text": "\r\n\r\nDr. Minun Keskimmäinen Nimi\r\n123 Osoite Katu\r\nApartment 1\r\nKaupunki, \ @@ -3656,14 +3718,14 @@

    POST /re -

    Saved Search

    +

    savedSearch

    GET /savedSearch

    -
    curl https://rest.bullhornstaffing.com/rest-services/e999/savedSearch
    +
    curl https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/savedSearch
     
     or:
     
    -curl https://rest.bullhorn.com/rest-services/e999/savedSearch?entity=Candidate&entityId=20
    +curl https://rest{swimlane#}.bullhorn.com/rest-services/e999/savedSearch?entity=Candidate&entityId=20
     
     # Example Response
     {
    @@ -3711,11 +3773,11 @@ 

    HTTP Request

    GET /mySavedSearch

    -
    curl https://rest.bullhornstaffing.com/rest-services/e999/mySavedSearch
    +
    curl https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/mySavedSearch
     
     or:
     
    -curl https://rest.bullhorn.com/rest-services/e999/mySavedSearch?entity=Candidate&entityId=20
    +curl https://rest{swimlane#}.bullhorn.com/rest-services/e999/mySavedSearch?entity=Candidate&entityId=20
     
     # Example Response
     {
    @@ -3753,7 +3815,7 @@ 

    HTTP Request

    GET /savedSearch/{savedSearchId}

    -
    curl https://rest.bullhornstaffing.com/rest-services/e999/esavedSearch/4
    +
    curl https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/esavedSearch/4
     
     # Example Response
     {
    @@ -3793,7 +3855,7 @@ 

    PUT /savedSearch

    "query" : "name:pinacle" \ } \ ' \ - https://rest.bullhornstaffing.com/rest-services/e999/savedSearch + https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/savedSearch # Example Response { @@ -3837,7 +3899,7 @@

    POST /savedSear "query" : "name:pinacle" \ } \ ' \ - https://rest.bullhornstaffing.com/rest-services/e999/savedSearch/4 + https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/savedSearch/4 # Example Response { @@ -3875,7 +3937,7 @@

    HTTP Request

    DELETE /savedSearch/{savedSearchId}

    curl -X DELETE \
    -https://rest.bullhornstaffing.com/rest-services/e999/esavedSearch/4
    +https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/esavedSearch/4
     
     # Example Response
     TBD
    @@ -3902,7 +3964,7 @@ 

    HTTP Request

    PUT /savedSearchAssociation

    curl -X PUT \
    -     https://rest.bullhornstaffing.com/rest-services/e999/savedSearchAssociation/4/JobOrder/1495    
    +     https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/savedSearchAssociation/4/JobOrder/1495    
     

    Creates an association between a saved search and a specified entity id. @@ -3928,7 +3990,7 @@

    HTTP Request

    DELETE /savedSearchAssociation

    curl -X DELETE \
    -     https://rest.bullhornstaffing.com/rest-services/e999/savedSearchAssociation/4/JobOrder/1495    
    +     https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/savedSearchAssociation/4/JobOrder/1495    
     

    Deletes an association between a saved search and a specified entity id. @@ -3953,7 +4015,7 @@

    HTTP Request

    GET /savedSearchGrants

    -
    curl https://rest.bullhorn.com/rest-services/e999/savedSearchGrants/4
    +
    curl https://rest{swimlane#}.bullhorn.com/rest-services/e999/savedSearchGrants/4
     
     # Example Response
     [
    @@ -3988,7 +4050,7 @@ 

    HTTP Request

    DELETE /savedSearchGrant

    -
    curl https://rest.bullhorn.com/rest-services/e999/savedSearchGrant/4/CORP
    +
    curl https://rest{swimlane#}.bullhorn.com/rest-services/e999/savedSearchGrant/4/CORP
     

    Deletes entitlements for a saved search. @@ -4020,7 +4082,7 @@

    HTTP Request

    PUT /savedSearchFavorite

    curl -X PUT \
    -     https://rest.bullhornstaffing.com/rest-services/e999/savedSearchFavorite/4
    +     https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/savedSearchFavorite/4
     

    Adds a saved search to saved search favorites. @@ -4046,7 +4108,7 @@

    HTTP Request

    DELETE /savedSearchAssociation

    curl -X DELETE \
    -     https://rest.bullhornstaffing.com/rest-services/e999/savedSearchAssociation/4/JobOrder/1495    
    +     https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/savedSearchAssociation/4/JobOrder/1495    
     

    Deletes an association between a saved search and a specified entity id. @@ -4074,7 +4136,7 @@

    HTTP Request

    PUT /savedSearchFavorite

    curl -X PUT \
    -     https://rest.bullhornstaffing.com/rest-services/e999/savedSearchFavorite/4
    +     https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/savedSearchFavorite/4
     

    Adds a saved search to saved search favorites. @@ -4100,7 +4162,7 @@

    HTTP Request

    DELETE /savedSearchFavorite

    curl -X DELETE \
    -     https://rest.bullhornstaffing.com/rest-services/e999/savedSearchFavorite/4
    +     https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/savedSearchFavorite/4
     

    Removes a saved search from saved search favorites. @@ -4124,10 +4186,10 @@

    HTTP Request

    -

    Search

    +

    search

    -
    curl https://rest.bullhornstaffing.com/rest-services/e999/search/Candidate?query=lastName:Smith&fields=id,firstName,lastname&count=3
    +
    curl https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/search/Candidate?query=lastName:Smith&fields=id,firstName,lastname&count=3
     
     # Example Response
     {
    @@ -4148,7 +4210,7 @@ 
     

    Note that the response contains a _score field. This is the Lucene score. Also, if the database record for an entity id is missing, the response contains an _error field for that record.

    -
    curl https://rest.bullhornstaffing.com/rest-services/e999/search/Candidate?query=isDeleted:0
    +
    curl https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/search/Candidate?query=isDeleted:0
     
     # Example Response
     {
    @@ -4230,7 +4292,7 @@ 

    POST /search

    curl -X POST \
          -H "Content-Type: application/json" \
          -d '{"query": "id:10125 10126 10127 10128 10129 10130 10131 10132 10133 10134 10135 10136 10137 10138 17376 26865 67604 67605 80203 80204 80205 80206 80207 80208 80209 80210 80211 80212 80213 80214"}' \
    -      https://rest.bullhornstaffing.com/rest-services/e999/search/Candidate?fields=id,firstName,lastname&count=3
    +      https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/search/Candidate?fields=id,firstName,lastname&count=3
     
     # Example Response
     {
    @@ -4317,7 +4379,7 @@ 

    HTTP Request

    -

    Services

    +

    services

    POST /services/CCPA/notifyOnCapture

    @@ -4333,7 +4395,7 @@

    POST /services/CCPA/notifyOnCapture<

    After the email is successfully sent a note is added to the person record with an action type from the: dataCaptureNotificationNoteType system setting.

    curl -X POST \
    -      https://rest.bullhornstaffing.com/rest-services/e999/services/CCPA/notifyOnCapture
    +      https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/services/CCPA/notifyOnCapture
     
     # Example Response
     {
    @@ -4386,7 +4448,7 @@ 

    POST / PUT /services/DirectDepos

    The Direct Deposit Account service allows for the creation of direct deposit accounts attached to a single candidate.

    curl -X POST / PUT \
    -      https://rest.bullhornstaffing.com/rest-services/e999/services/DirectDepositAccount
    +      https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/services/DirectDepositAccount
     
     # Example Request
     {
    @@ -4495,7 +4557,7 @@ 

    PUT /services/IssueReport

    The Issue Report service allows for creation of issues to be presented to the user. These user-facing issues will be related to existing entities, and provide data on what the issue is and how to fix it.

    curl -X PUT \
    -      https://rest.bullhornstaffing.com/rest-services/e999/services/IssueReport
    +      https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/services/IssueReport
     
     # Example Request
     {
    @@ -4554,7 +4616,7 @@ 

    HTTP Request

    POST /services/PlacementChangeRequest/approve/

    curl -X POST \
    -      https://rest.bullhornstaffing.com/rest-services/e999/services/PlacementChangeRequest/approve/123
    +      https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/services/PlacementChangeRequest/approve/123
     
     # Example Response
     {
    @@ -4593,7 +4655,7 @@ 

    Handles the creation of a BillMasterTransactionDistributionBatch and its subsequent association to BillableCharges.

    curl -X PUT \
    -      https://rest.bullhornstaffing.com/rest-services/e999/services/RevenueRecognition/BillMasterTransactionDistributionBatch
    +      https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/services/RevenueRecognition/BillMasterTransactionDistributionBatch
     
     # Example Request
     {
    @@ -4631,7 +4693,7 @@ 

    PUT /s

    Handles the creation of an UnbilledRevenueDistributionBatch and its subsequent association to UnbilledRevenueDistributions.

    curl -X PUT \
    -      https://rest.bullhorn.com/rest-services/e999/services/RevenueRecognition/UnbilledRevenueDistributionBatch 
    +      https://rest{swimlane#}.bullhorn.com/rest-services/e999/services/RevenueRecognition/UnbilledRevenueDistributionBatch 
     
     # Example Request
     {
    @@ -4669,7 +4731,7 @@ 

    POST /se

    Allows the API user to update the unbilledRevenueGeneralLedgerExportStatus for one or more BillMasterTransactions.

    curl -X POST \
    -      https://rest.bullhorn.com/rest-services/e999/services/RevenueRecognition/UpdateTransactionExportStatus 
    +      https://rest{swimlane#}.bullhorn.com/rest-services/e999/services/RevenueRecognition/UpdateTransactionExportStatus 
     
     # Example Request
     {
    @@ -4713,7 +4775,7 @@ 

    POST /services/PayExport

    NOTE: If you submit a batch export status update where there is only a single failed record with an entity name of PayExportBatch and the entityId matches the sourceBatchId, then we will treat the request as if you had asked our system to fail every PayMasterTransaction associated with that PayExportBatch. Issue creation logic will be unaffected.

    curl -X POST \
    -      https://rest.bullhorn.com/rest-services/e999/services/PayExportBatch/batchExportStatus
    +      https://rest{swimlane#}.bullhorn.com/rest-services/e999/services/PayExportBatch/batchExportStatus
     
     # Example Request
     {
    @@ -4806,10 +4868,10 @@ 

    HTTP Request

    -

    Settings

    +

    settings

    GET /settings/setting1[,setting2…]

    -
    curl https://rest.bullhornstaffing.com/rest-services/e999/settings/allPrivateLabelIds,currencyFormat
    +
    curl https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/settings/allPrivateLabelIds,currencyFormat
     
     # Example Response
     {
    @@ -4822,29 +4884,29 @@ 

    GET /settings/setting1[,setting2…

    GET /settings

    -
    curl -X GET "http://rest.bullhornstaffing.com/rest-services/e999/settings"
    +
    curl -X GET "http://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/settings"
     
     # Example Response
     {
       "data": [
         {
           "name": "accountLockoutDuration",
    -      "valueUrl": "http://rest.bullhornstaffing.com/rest-services/e999/settings/accountLockoutDuration",
    +      "valueUrl": "http://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/settings/accountLockoutDuration",
           "valueType": "INTEGER",
           "isArray": false
         }, {
           "name": "allDeptIds",
    -      "valueUrl": "http://rest.bullhornstaffing.com/rest-services/e999/settings/allDeptIds",
    +      "valueUrl": "http://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/settings/allDeptIds",
           "valueType": "INTEGER",
           "isArray": true
         }, {
           "name": "allPrivateLabelIds",
    -      "valueUrl": "http://rest.bullhornstaffing.com/rest-services/e999/settings/allPrivateLabelIds",
    +      "valueUrl": "http://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/settings/allPrivateLabelIds",
           "valueType": "INTEGER",
           "isArray": true
         }, {
           "name": "commentActionList",
    -      "valueUrl": "http://rest.bullhornstaffing.com/rest-services/e999/settings/commentActionList",
    +      "valueUrl": "http://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/settings/commentActionList",
           "valueType": "STRING",
           "isArray": true
         }
    @@ -4855,10 +4917,10 @@ 

    GET /settings

    Returns a list of predefined setting names and their metadata.

    -

    Events

    +

    events

    GET /event/subscription

    -
    curl https://rest.bullhornstaffing.com/rest-services/e999/event/subscription/Abcde?maxEvents=100
    +
    curl https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/event/subscription/Abcde?maxEvents=100
     
     # Example Response
     {{
    @@ -4957,7 +5019,7 @@ 

    HTTP Response

    GET /event/subscription/lastRequestId

    -
    curl https://rest.bullhornstaffing.com/rest-services/e999/event/subscriptioN/Abcde/lastRequestId
    +
    curl https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/event/subscriptioN/Abcde/lastRequestId
     
     # Example Response
     {'result': 1}
    @@ -4986,7 +5048,7 @@ 

    HTTP Request

    PUT /event/subscription

    curl -X PUT \
          -H "Content-Type: application/json" \
    -     https://rest.bullhornstaffing.com/rest-services/e999/event/subscription/Abcde?type=entity&names=Candidate
    +     https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/event/subscription/Abcde?type=entity&names=Candidate
     &eventTypes=INSERTED,UPDATED,DELETED
     
     # Example Response
    @@ -5033,7 +5095,7 @@ 

    HTTP Request

    DELETE /event/subscription

    -
    curl https://rest.bullhornstaffing.com/rest-services/e999/event/subscription/Abcde
    +
    curl https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/event/subscription/Abcde
     &eventTypes=INSERTED,UPDATED,DELETED
     
     # Example Response
    @@ -5061,10 +5123,10 @@ 

    HTTP Request

    -

    User Headshot File

    +

    userHeadshotFile

    GET /userHeadshotFile

    -
    curl https://rest.bullhornstaffing.com/rest-services/e999/userHeadshotFile/Candidate/3835
    +
    curl https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/userHeadshotFile/Candidate/3835
     
     # Example Response
     <A multipart-encoded version of the file>
    @@ -5113,7 +5175,7 @@ 

    PUT /userHeadshotFile

    \ -F "file=@headshotfile.jpg" \ - https://rest.bullhornstaffing.com/rest-services/e999/userHeadshotFile/Candidate/5097909/raw?filetype=SAMPLE&externalID=portfolio + https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/userHeadshotFile/Candidate/5097909/raw?filetype=SAMPLE&externalID=portfolio # Example Response {"fileId": 178} @@ -5256,7 +5318,7 @@

    POST /userHeadshotFile\ -F "file=@headshotfile.jpg" \ - https://rest.bullhornstaffing.com/rest-services/e999/userHeadshotFile/Candidate/5097909/raw?filetype=SAMPLE&externalID=portfolio + https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/userHeadshotFile/Candidate/5097909/raw?filetype=SAMPLE&externalID=portfolio # Example Response {"fileId": 179} @@ -5383,7 +5445,7 @@

    HTTP Request for multipart/for

    DELETE /userHeadshotFile

    curl -X DELETE \
    -     https://rest.bullhornstaffing.com/rest-services/e999/userHeadshotFile/Candidate/3835
    +     https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/userHeadshotFile/Candidate/3835
     
     # Example Response
     {