Description Adds the given Person entity to the Personalia system. A given value for the url property will be ignored.
Method POST
URI Path https://{subdomain}.personalia.webapiservices.com/{version}/persons
URI Parameters
{version}
Value alpha
Headers
Authorization
Description The Authorization header must contain a valid OAuth 2 access token with each request to the Personalia API.
Type string
Required true

Content-Type
Description The format of the body content
Type string
Required true
Permitted Values [application/json, application/xml]
Body Type: Person

Spliced example:

{  
  "key": "A-453",
  "title": "prof.",
  "initials": "J.F.",
  "firstName": "John",
  "middleNames": "Francis",
  "prefix": "da",
  "lastName": "Costa",
  "gender": 1,
  "dateOfBirth": "1997-09-23",
  "nationality": 840
}

Concatenated example:

{  
  "key": "A-453",
  "firstName": "prof. John Francis",
  "lastName": "da Costa",
  "gender": 1,
  "dateOfBirth": "1997-09-23",
  "nationality": 840
}
Success Responses
Code: 201
Description: Returned when the Person entity is successfully added to the Personalia system.
Headers
Location
Description Contains the URL of the newly added Person entity.
Type string
Error Responses
Code: 400
Description: Returned when the request send to the Personalia API was malformed. The request must be corrected before resending it to the Personalia API.

Code: 401
Description: Returned when no OAuth token is provided or the provided OAuth token is invalid.

Code: 403
Description: Returned when the user is not authorized to perform the action on the resource.

Code: 415
Description: Returned when no Content-Type header is present in the request or the header contains a MIME type that is not supported by the Personalia API.

Code: 422
Description: Returned when validation of the Person entity failed.
Body: Type: Error[]

Code: 500
Description: Returned when an unexpected error occured within the Personalia system. These errors are automaticly logged and reviewed. Please try again, and if the problem persists, please contact our helpdesk.
Body: Type: Error