BH-88269 added documentation for new corporateUser service

source/includes/_services.md

@@ -5,12 +5,12 @@
 The California Consumer Privacy Act (CCPA) is a bill meant to enhance privacy rights and consumer protection for residents of California and goes into effect on January, 2020. Notify on Capture is a feature of this bill that notifies a person in the system that their data is being captured for the purposes of serving them as a staffing agency. An email is sent and a note is added to the person record for tracking. The staffing agency is responsible for knowing if and when to send Notify on Capture emails.
 
 The email body and subject line are pulled from system settings (private label attributes) that are specific to the person record:
-
- * `candidateDataCaptureNotificationEmailBody` / `candidateDataCaptureNotificationEmailSubjectLine`
- * `contactDataCaptureNotificationEmailBody` / `contactDataCaptureNotificationEmailSubjectLine`
- * `leadDataCaptureNotificationEmailBody` / `leadDataCaptureNotificationEmailSubjectLine`
 
-After the email is successfully sent a note is added to the person record with an action type from the: `dataCaptureNotificationNoteType` system setting. 
+* `candidateDataCaptureNotificationEmailBody` / `candidateDataCaptureNotificationEmailSubjectLine`
+* `contactDataCaptureNotificationEmailBody` / `contactDataCaptureNotificationEmailSubjectLine`
+* `leadDataCaptureNotificationEmailBody` / `leadDataCaptureNotificationEmailSubjectLine`
+
+After the email is successfully sent a note is added to the person record with an action type from the: `dataCaptureNotificationNoteType` system setting.
 
 ``` shell
 curl -X POST \
@@ -45,6 +45,159 @@ entity | yes | One of: "Candidate", "ClientContact", or "Lead".
 ids | yes | List of IDs of the given type of entity, a maximum of 500 per call.
 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.
 
+## POST / PUT /services/CorporateUser
+
+With appropriate access, you can add or update users. Adding users may incur additional user fees. For questions about your account and billing, please contact Support or your Account Manager.
+
+``` shell
+curl -X PUT \
+      https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/services/CorporateUser
+
+curl -X POST \
+      https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/services/CorporateUser/{corporateUserID}
+
+# Example Request
+{
+    "userType": {
+            "id": 456789
+        },
+        "privateLabel": {
+            "id": 987654
+        },
+        "userSettings": {
+            "openOutboundMailInDefaultClient": "FALSE",
+            "sendAppointmentReminder": "FALSE",
+            "sendInvitationsToOwner": "FALSE",
+            "mobileEnabled": "0"
+        },
+        "firstName": "Jane",
+        "middleName": "Francine",
+        "lastName": "Doe",
+        "name": "Jane Doe",
+        "username": "JaneDoe",
+        "nickName": "Janey",
+        "password": "FakePassword",
+        "enabled": true,
+        "emailNotify": false,
+        "timeZoneOffsetEST": 600,
+        "address": {
+            "address1": "Fake Address 1",
+            "address2": "Fake Address 2",
+            "city": "Boston",
+            "countryID": 1,
+            "state": "MA",
+            "zip": "02108"
+        },
+        "userDateAdded": 1550874742177,
+        "dateLastComment": 1607036876320,
+        "departments": [
+            {
+                "id": 123456,
+                "isPrimary": true
+            },
+            {
+                "id": 456789,
+                "isPrimary": false
+            }
+        ],
+        "email": "[email protected]",
+        "email2": "[email protected]",
+        "email3": "[email protected]",
+        "emailSignature": "Jane Doe",
+        "externalEmail": "[email protected]",
+        "phone": "12345678912",
+        "phone2": "45612378894",
+        "phone3": "12346512384",
+        "mobile": "13216549456",
+        "pager": "456987412512",
+        "fax": "12345678912",
+        "fax2": "45612378894",
+        "fax3": "12346512384",
+        "occupation": "HR",
+        "companyName": "Fake Company",
+        "addressSourceLocation": {
+            "id": 7
+        },
+        "namePrefix": "Ms",
+        "nameSuffix": "ii",
+        "isDayLightSavings": false,
+        "isLockedOut": false,
+        "isOutboundFaxEnabled": false,
+        "inboundEmailEnabled": false,
+        "customText1": "Custom Text",
+        "customText2": "Custom Text",
+        "customText3": "Custom Text",
+        "customText4": "Custom Text",
+        "customText5": "Custom Text",
+        "customText6": "Custom Text",
+        "customText7": "Custom Text",
+        "customText8": "Custom Text",
+        "customText9": "Custom Text",
+        "customText10": "Custom Text",
+        "customText11": "Custom Text",
+        "customText12": "Custom Text",
+        "customText13": "Custom Text",
+        "customText14": "Custom Text",
+        "customText15": "Custom Text",
+        "customText16": "Custom Text",
+        "customText17": "Custom Text",
+        "customText18": "Custom Text",
+        "customText19": "Custom Text",
+        "customText20": "Custom Text",
+        "customDate1": "1550874742177",
+        "customDate2": "1550874742177",
+        "customDate3": "1550874742177",
+        "customFloat1": 1.3,
+        "customFloat2": 0.4,
+        "customFloat3": 10.5,
+        "customInt1": 100,
+        "customInt2": 450,
+        "customInt3": 30,
+        "isDeleted": false,
+        "massMailOptOut": false,
+        "smsOptIn": false,
+        "loginRestrictions": {
+            "ipAddress": "149.176.114.106",
+            "timeStart": "23:30:00",
+            "timeEnd": "00:30:00",
+            "weekDays": [
+                1,
+                2,
+                6
+            ]
+        },
+        "samlInfo": {
+            "samlIdpID": 456,
+            "nameID": "[email protected]",
+            "idpType": 1
+        }
+}
+
+# Example Response for PUT
+{
+    "changedEntityType": "CorporateUser",
+    "changedEntityId": 123456,
+    "changeType": "INSERT",
+    "data": {}
+}
+
+# Example Response for POST
+{
+    "changedEntityType": "CorporateUser",
+    "changedEntityId": 123456,
+    "changeType": "UPDATE",
+    "data": {}
+}
+```
+
+### HTTP Request
+
+`{corpToken}/services/CorporateUser` and `{corpToken}/services/CorporateUser/{corporateUserID}`
+
+Parameter | Required | Description
+--------- |----------| -----------
+BhRestToken | yes      | 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.
+
 ## POST / PUT /services/DirectDepositAccount
 
 The Direct Deposit Account service allows for the creation of direct deposit accounts attached to a single candidate.
@@ -148,7 +301,7 @@ BhRestToken | no | Token that represents a session established by the login proc
 
 ## 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. 
+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.
 
 ``` shell
 curl -X PUT \
@@ -258,7 +411,7 @@ Parameter | Required | Description
 ------ | -------- | -----
 BhRestToken | yes | 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.
 
-## PUT /services/RevenueRecognition/UnbilledRevenueDistributionBatch 
+## PUT /services/RevenueRecognition/UnbilledRevenueDistributionBatch
 
 Handles the creation of an UnbilledRevenueDistributionBatch and its subsequent association to UnbilledRevenueDistributions.
 

source/includes/changelog/changelog.md

@@ -1,6 +1,12 @@
 # REST API Change Log
 
 This is where you can find a list of changes to the Bullhorn REST API. This change log was initiated with the 2024.5 release. Prior changes are not listed by release.
+## October 2024 Release (2024.10)
+
+| ADDED ```|``` [CorporateUser service POST](http://bullhorn.github.io/rest-api-docs/index.html#post-services-corporateuser) |
+
+| ADDED ```|``` [CorporateUser service PUT](http://bullhorn.github.io/rest-api-docs/index.html#put-services-corporateuser) |
+
 ## August 2024 Release (2024.8)
 
 | ADDED ```|``` [TimesheetEntry approvedBy, billRate, customerRequiredFields, dateAdded, dateLastModified, payRate, timesheetEntryApprovalStatusLogEntry fields](http://bullhorn.github.io/rest-api-docs/entityref.html#timesheetentry) |

source/includes/entityref/_corporateuser.md

@@ -2,6 +2,8 @@
 
 Read-only entity that represents an internal user at an organization.
 
+With appropriate access, you can add or update users. Adding users may incur additional user fees. For questions about your account and billing, please contact Support or your Account Manager.
+
 | **CorporateUser field** | **Type** | **Description** | **Not null** | **Read-only** |
 | --- | --- | --- | --- | --- |
 | id | Integer | Unique identifier for this entity. | X | X |