POST v2/TalentUsers


Documentation/Notes

Existing users are identified by Username and, if found, they are updated with the request data.


Request Information

Authorization required.

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


URI Parameters

None.


Body Parameters

Collection of TalentUserPostRequestModel_V2
NameDescriptionTypeAdditional information
LastPromotionDate

date

None.

SSOUserName

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

None.

LastRaiseDate

date

None.

LastRaiseAmount

Numeric, Up to 2 decimals

decimal number

None.

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

application/xml, text/xml

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

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 'IList`1'.


Response Information

Resource Description

PostTalentUserResulutsModel_V2
NameDescriptionTypeAdditional 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.V2">
  <messages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Portal.PublicAPI.Models.V1" />
  <status xmlns="http://schemas.datacontract.org/2004/07/Portal.PublicAPI.Models.V1">sample string 1</status>
</PostTalentUserResultsModel>