Create Person

Registers a new person in the Organization module.

 

URL

{RMUrl}/api/Organization/people

 

REQUEST METHOD

POST

 

URL PARAMETERS

This feature does not have parameters.

 

FORM CONTENT

Name (Required): Name of the person to be created. Limit of 400 characters.

Description (Optional): Description of the person to be created.

Email (Required): E-mail address of the person to be created.

Phone (Optional): Phone number of the person to be created.

AdditionalInformation (Optional): Additional information on the person to be created.

CustomAttributes (Optional): List of objects with information on the attributes associated with the person. Each attribute is referenced by its variable name. Relationship-type attributes can be referenced by the Id field, the Caption field, or both. If both fields are provided, they must refer to the same object. It is recommended to use the Id field whenever possible. See Appendix 2: Format for Completing Attributes for the list of formats for the Id and Caption fields.

 

FORM CONTENT EXAMPLE

Create a person with all fields completed:

{

"Name":"Charles Windsor",

"Description":"Employee – Marketing department",

"Email":"cwindsor@example.com",

"Phone":"+1 (646) 555-0000",

"AdditionalInformation":"Marketing department manager"

}

 

SUCCESS RESPONSE

Code of the newly registered person. Returns a string.