NetId Management Resource

NetId Management

The NetId Management resource as defined by the Open Registry is identified by the following URI:

/netids/{primaryNetId}

Modify primary NetId

HTTP PUT /netids/{primaryNetId}
  • HTTP request headers:
    • Content-Type: application/x-www-form-urlencoded
    • Authorization: Basic (base64 encoded user:password for this service)
  • HTTP request entity body:
    • Url-encoded form with the following input key-value pair: newPrimaryNetId=(the netId that would become a primary one)
  • HTTP response entity body:
    • empty (in case of 204)
  • HTTP status codes:
    • 204: the provided primary netId has successfully become a new primary netId. The current primary netId has become a non-primary netId
    • 404: URI identifies a non-existent primary netId
    • 409: The provided new primary netId is already in use; The primaryNetId equals non-primary; the provided new primary netIs already IS primary
    • 415: the request entity body is missing
    • 401/403: the authentication/authorization fails
    • 500: any other server error that occurs

Add non-primary NetId

HTTP POST /netids/{primaryNetId}
  • HTTP request headers:
    • Content-Type: application/x-www-form-urlencoded
    • Authorization: Basic (base64 encoded user:password for this service)
  • HTTP request entity body:
    • Url-encoded form with the following input key-value pair: newNonPrimaryNetId=(the new non-primary netId that would be added to the person)
  • HTTP response entity body:
    • empty (in case of 204)
  • HTTP status codes:
    • 204: the provided non-primary netId has successfully been added
    • 404: URI identifies a non-existent primary netId
    • 409: The provided new non-primary netId is already in use
    • 415: the request entity body is missing
    • 401/403: the authentication/authorization fails
    • 500: any other server error that occurs