Create People

To call the API so that it performs the operations or returns the data requested by your application, you need to make a POST request to the appropriate endpoint. When creating new resources like an EmpowerID Person, you need to POST a request to the endpoint that starts the EmpowerID Workflow service, passing to the API the necessary header and request data. For creating an EmpowerID Person, this data is as follows.

Endpoint

https://{FQDN_OF_Your_EmpowerID_Web_Server}/api/services/v1/workflow/start

Headers

Key

Value

Key

Value

X-EmpowerID-API-Key

The API key for the OAuth application you created above.

Content-Type

application/json

Request Data

Request data is sent to the API in JSON format. The data in the below request represents the minimum key/value pairs required for creating an EmpowerID Person. The API Reference includes all possible key/value pairs that can be submitted when creating people.

OutputParameters are optional, but are useful for viewing the results of the operation.

{ "Name": "CreatePerson", "InputParameters": { "TargetPerson" : { "LastName": "Adams", "FirstName": "Samuel", "PrimaryOrgRoleOrgZoneID": "2" } }, "OutputParameters": [{"TargetPerson": ["PersonID", "FirstName", "LastName"]}] }

 

Element

Description

Type

Required

Element

Description

Type

Required

Name

Name of the workflow

String

Required

InputParameters

Workflow input

Data Object

Required

TargetPerson

Attributes of the person

Data Object

Required

Firstname

First name of the person

String

Required

LastName

Last name of the person

String

Required

PrimaryOrgRoleOrgZoneID

Primary Business Role and Location of the person

Integer

Required

OutputParameters

Workflow output

Data Object

Optional

 

Code Examples

In the examples, we are passing in the minimum number of parameters and requesting an output showing the PersonID, LastName and FirstName attributes of the person that is created by the operation.

C#

var url = "https://{FQDN_OF_Your_EmpowerID_Web_Server}/api/services/v1/workflow/start"; using (var webClient = new WebClient()) { webClient.Headers[HttpRequestHeader.Authorization] = String.Format(BearerHeaderFormat, {Your_Access_Token}); webClient.Headers[ApiKeyHeader] = {Your_API_Key}; webClient.Headers.Add(HttpRequestHeader.ContentType, "application/json"); var workflowInput = new WorkflowInput {Name = "CreatePerson"}; workflowInput.InputParameters["TargetPerson"] = new { FirstName = "Samuel"; LastName = "Adams"; PrimaryOrgRoleOrgZoneID = 2; //Temporary Role in Temporary Location }; workflowInput.OutputParameters.Add(new { PargetPerson = new[] {"PersonGUID", "PersonID", FirstName", "LastName"}}); var inputJsonData = Json.convert.SerializeObject(workflowInput); var jsonResult = webClient.UploadString(url, inputJsonData); //Write results to console if desired if(!String.IsNullOrWhiteSpace(jsonResult)) { workflowOutput = JsonConvert.DeserializeObject<WorkflowOutput>(jsonResult); string results = workflowOutput.OutputParameters["TargetPerson"].ToString(); Console.Write(results); } }

 

cURL

Be sure to use double quotes unless you are making hte request from a non-Windows OS.

 

Ajax

 

Response

If the request is successful, you should receive a JSON response that looks similar to that below:

 

Postman Example

  1. Open the Postman app on your machine.

  2. In Postman, open a new tab, select POST as the HTTP method and enter https://{FQDN_Of_Your_EmpowerID_Web_Server}/api/services/workflow/start.

  3. Click the Headers tab and add the above mentioned key/value pairs.



  4. Click the Body tab, select raw and then add the below JSON:

     



  5. Click Send.

    If the request is successful, you should receive a JSON response that looks similar to that shown below.

     


Next Steps

Edit people

Reset passwords

Check access

IN THIS ARTICLE