Page Comparison

...

1. Add new person:

   Code Block
   HTTP POST /sor/{sorSourceId}/people

   • HTTP request headers:
     • Content-Type: application/xml
   • HTTP request entity body:
     • <open-registry-person> XML representation
   • HTTP response entity body:
     • www-form-urlencoded representation of activation key (in case of 201). Example: activationKey=rsoktfqw
     • <open-registry-resources> XML representation (in case of 409)
   • HTTP status codes:
     • 201: the new person resource is successfully created
     • 400: the person XML representation is malformed or incomplete e.g. required fields are missing
     • 303: the exact person already exists in the system e.g. the system has found an exact match based on the incoming person representation
     • 409: possible one or more people exist in the system e.g. the system has found possible matches based on the incoming person representation
     • 415: the request entity body is missing
     • 401/403: the authentication/authorization fails
     • 500: any other server error that occurs
   • HTTP response headers:
     • Location: /people/{personIdType}/{personId} (URI of a newly created calculated person resource in case of 201)
     • Location: /people/{personIdType}/{personId} (URI of an existing calculated person resource in case of 303)
     • Content-Type: application/x-www-form-urlencoded (in case of 201)
2. 'Force Add' new person:

   Code Block
   HTTP POST /sor/{sorSourceId}/people?force=y

   • HTTP request headers:
     • Content-Type: application/xml
   • HTTP request entity body:
     • <open-registry-person> XML representation
   • HTTP response entity body:
     • www-form-urlencoded representation of activation key (in case of 201). Example: activationKey=rsoktfqw
   • HTTP status codes:
     • 201: the new person resource is successfully created
     • 400: the person XML representation is malformed or incomplete e.g. required fields are missing
     • 415: the request entity body is missing or is not of an appropriate media type
     • 401/403: the authentication/authorization fails
     • 500: any other server error that occurs
   • HTTP response headers:
     • Location: /people/{personIdType}/{personId} (URI of a newly created person resource in case of 201)
     • Content-Type: application/x-www-form-urlencoded (in case of 201)

Representations

Request for:

...

Add Person

<?xml version="1.0" encoding="UTF-8"?>
<open-registry-person sor="123" sor-person-id="123" first-name="John" last-name="Doe" email="j@gmail.com" phone="7326543322">
    <dob>1977-06-11</dob>
    <ssn>123223456</ssn>
    <gender>male</gender>
    <address-line1>123 Main st.</address-line1>
    <address-line2>suite 5</address-line2>
    <city>New Brunswick</city>
    <region>NJ</region>
    <postal-code>23458</postal-code>
</open-registry-person>

Response

...

for: Add Person's 409

...

response code

<?xml version="1.0" encoding="UTF-8"?>
<open-registry-resources>
    <link href="http://localhost:8080/openregistry/api/v1/people/RCPID/82" rel="person"/>
    <link href="http://localhost:8080/openregistry/api/v1/people/RCPID/83" rel="person"/>
</open-registry-resources>