POST v1/TalentUsers

Documentation/Notes

Existing users are identified by Username and, if found, they are updated with the request data. Otherwise a new user is created. If NULL is passed - field will be ignored. If an empty string is passed - field will be deleted. If an empty string is passed for a required field, the update of that record will fail and a message will be returned notifying the user what record(s) failed and why. If multiple records are passed and one fails, all records that can be successfully created/updated will be posted and a message will be returned notifying the user what record(s) failed and why.

Request Information

Authorization required.

Need to send an authorized BDtoken under the Authorization header along with the call.

URI Parameters

None.

Body Parameters

TalentUserPostRequestModel_V1

Name	Description	Type	Additional information
LastPromotionDate		date	None.
SSOUserName		string	Max length: 128
SSODomain		string	Max length: 128
Ethnicity		string	None.
Gender	Male or Female	string	None.
Department	Must match existing record	string	None.
LastName		string	Required Max length: 50
FirstName		string	Required Max length: 50
MiddleInitial		character	None.
DisplayName		string	Required Max length: 50
Phone1	Numeric	string	Max length: 50
Phone2	Numeric	string	Max length: 50
Phone3	Numeric	string	Max length: 50
Email	Email format, e.g. [text]@[text].com	string	Required Max length: 225
EmployeeId		string	Required Max length: 50
JobCode	Must match existing record	string	Required
JobTitle		string	Max length: 50
Username	Recommended best practice is email address	string	Required Max length: 150
Manager	Must match existing record and be listed as firstname lastname	string	Required
Organization		string	None.
CostCenter		string	None.
Institute		string	None.
HireDate		date	Required
TerminationDate		date	None.
NextEvaluationDate		date	None.
Salary	Numeric, Up to 2 decimals	decimal number	Max length: 50
LastRaiseDate		date	None.
LastRaiseAmount	Numeric, Up to 2 decimals	decimal number	Max length: 50
Location	Must match existing record	string	Required
Active		boolean	Required
IsManager		boolean	Required
AddToGroups	Requires Group Code, unlimited quantity.	Collection of string	None.
RemoveFromGroups	Requires Group Code, unlimited quantity.	Collection of string	None.

Request Formats

application/json, text/json

Sample:

{
  "lastPromotionDate": "2024-11-21T00:47:46.6946702-06:00",
  "ssoUserName": "sample string 1",
  "ssoDomain": "sample string 2",
  "ethnicity": "sample string 3",
  "gender": "sample string 4",
  "department": "sample string 5",
  "pid": 6,
  "lastName": "sample string 7",
  "firstName": "sample string 8",
  "middleInitial": "A",
  "displayName": "sample string 10",
  "phone1": "sample string 11",
  "phone2": "sample string 12",
  "phone3": "sample string 13",
  "email": "sample string 14",
  "employeeId": "sample string 15",
  "jobCode": "sample string 16",
  "jobTitle": "sample string 17",
  "username": "sample string 18",
  "manager": "sample string 19",
  "organization": "sample string 20",
  "costCenter": "sample string 21",
  "institute": "sample string 22",
  "hireDate": "2024-11-21T00:47:46.6946702-06:00",
  "terminationDate": "2024-11-21T00:47:46.6946702-06:00",
  "nextEvaluationDate": "2024-11-21T00:47:46.6946702-06:00",
  "salary": 1.0,
  "lastRaiseDate": "2024-11-21T00:47:46.6946702-06:00",
  "lastRaiseAmount": 1.0,
  "location": "sample string 23",
  "active": true,
  "isManager": true,
  "addToGroups": [
    "sample string 1",
    "sample string 2"
  ],
  "removeFromGroups": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<TalentUserPostRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Portal.PublicAPI.Models.V1">
  <Active>true</Active>
  <AddToGroups xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </AddToGroups>
  <CostCenter>sample string 21</CostCenter>
  <Department>sample string 5</Department>
  <DisplayName>sample string 10</DisplayName>
  <Email>sample string 14</Email>
  <EmployeeId>sample string 15</EmployeeId>
  <Ethnicity>sample string 3</Ethnicity>
  <FirstName>sample string 8</FirstName>
  <Gender>sample string 4</Gender>
  <HireDate>2024-11-21T00:47:46.6946702-06:00</HireDate>
  <Institute>sample string 22</Institute>
  <IsManager>true</IsManager>
  <JobCode>sample string 16</JobCode>
  <JobTitle>sample string 17</JobTitle>
  <LastName>sample string 7</LastName>
  <LastPromotionDate>2024-11-21T00:47:46.6946702-06:00</LastPromotionDate>
  <LastRaiseAmount>1</LastRaiseAmount>
  <LastRaiseDate>2024-11-21T00:47:46.6946702-06:00</LastRaiseDate>
  <Location>sample string 23</Location>
  <Manager>sample string 19</Manager>
  <MiddleInitial>65</MiddleInitial>
  <NextEvaluationDate>2024-11-21T00:47:46.6946702-06:00</NextEvaluationDate>
  <Organization>sample string 20</Organization>
  <PID>6</PID>
  <Phone1>sample string 11</Phone1>
  <Phone2>sample string 12</Phone2>
  <Phone3>sample string 13</Phone3>
  <RemoveFromGroups xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </RemoveFromGroups>
  <SSODomain>sample string 2</SSODomain>
  <SSOUserName>sample string 1</SSOUserName>
  <Salary>1</Salary>
  <TerminationDate>2024-11-21T00:47:46.6946702-06:00</TerminationDate>
  <Username>sample string 18</Username>
</TalentUserPostRequestModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'TalentUserPostRequestModel'.

Response Information

Resource Description

PostTalentUserResultsModel_V1

Name	Description	Type	Additional information
status	Sucessful, Error	string	None.
messages	Contains Error message if an error occured.	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "status": "sample string 1",
  "messages": []
}

application/xml, text/xml

Sample:

<PostTalentUserResultsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Portal.PublicAPI.Models.V1">
  <messages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
  <status>sample string 1</status>
</PostTalentUserResultsModel>