SoR Person Resource

Owned by ScottS
Last updated: Dec 02, 2010 by Nancy MondVersion comment
3 min read

SoR Person

The System of Record Person resource as defined by the Open Registry is identified by the following URI:

/sor/{sorSourceId}/people/{sorPersonId}

Note: {sorSourceId} is something like Registrar, HR, etc.

Delete SoR Person

HTTP DELETE /sor/{sorSourceId}/people/{sorPersonId}

HTTP DELETE /sor/{sorSourceId}/people/{sorPersonId}?mistake=true
  • HTTP response entity body:
    • empty (in case of 204)
  • HTTP status codes:
    • 204: the system of record person resource has been successfully deleted
    • 400: if one of the required arguments is missing
    • 404: the system of record person resource is not found
    • 401/403: the authentication/authorization fails
    • 500: any other server error that occurs

Add SoR Person

  1. Add new person: 
    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: 
    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)

Update/Edit SoR Person

HTTP PUT /sor/{sorSourceId}/people/{sorPersonId}
  • HTTP request headers:
    • Content-Type: application/xml
  • HTTP request entity body:
    • <open-registry-modify-person> XML representation
  • HTTP response entity body:
    • empty (in case of 204)
  • HTTP status codes:
    • 204: the system of record person resource has been successfully modified
    • 400: if one of the required arguments is missing
    • 404: the system of record person resource is not found
    • 401/403: the authentication/authorization fails
    • 409: update/edit request changes key data about the person such that they no longer reconcile to the same person.
    • 500: any other server error that occurs

Representations

Request for: Add Person

<open-registry-person> example representation
<?xml version="1.0"?>
<open-registry-person sor="TEST" sor-person-id="134" >
    <dob>1964-02-10</dob>
    <ssn>123456789</ssn>
    <gender>F</gender>
    <names>
       <name type="FORMAL" first="Cindy" last="Simon" />
    </names>
   <reconciliation>
	<emails>
		<email>simon@gmail</email>
        </emails>
        <address>
                <address-line1>123 Main St.</address-line1>
                <address-line2>Suite 5</address-line2>
                <city>New Brunswick</city>
                <region>NJ</region>
                <postal-code>08819</postal-code>
        </address>
        <phones>
                <phone>908-445-3355</phone>
        </phones>
        <identifiers>
                <identifier type="NETID">CS101010</identifier>
        </identifiers>
   </reconciliation>
</open-registry-person>

Response for: Add Person's 409 response code

<open-registry-resources> example representation
<?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>

Request for: Update/Edit Person

<open-registry-modify-person> example representation
<?xml version="1.0" encoding="UTF-8"?>
<open-registry-person>
    <dob>1978-03-11</dob>
    <ssn>123456789</ssn>
    <gender>F</gender>
    <names>
       <name type="FORMAL" first="Cindy" last="Simon" middle="E"/>
    </names>
</open-registry-person>