diff --git a/guide.html b/guide.html index e7aa7fd..2cf9765 100644 --- a/guide.html +++ b/guide.html @@ -369,11 +369,11 @@
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.
+
+
+
+Parameter
+Required
+Description
+
+
+
+ids
+yes
+List of entity ids. Must be set in the body of the request rather than in a URL query parameter.
+
+
+count
+no
+Limit 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.
+
+
+start
+no
+From the set of matched results, return record numbers start through (start + count).
+
+
+showTotalMatched
+no
+(true/false) When set to true, the total count of matching items is returned.
+
+
+BhRestToken
+no
+Token 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