The attributes in this document have not been updated to match the Core Schema proposal.
About the Write API
This API is used to send SOR information to the Identity Registry.
Methods
SOR Person Role Added
It is up to the Identity Registry to determine how to map the provided attributes to its internal data model.
In these examples, hrms is the SOR, X12345 is the SORID, and R98765 and R98766 are SOR Role IDs.
Request Using Separate Person-Level and Role-Level Attributes
POST /sor_people/hrms/X12345
{
"givenName":"Pat",
"sn":"Lee",
"dateofBirth":"1983-03-18"
}
POST /sor_people/hrms/X12345/R98765
{
"title":"Professor of Phrenology"
"percentAllocation":"50%"
}
POST /sor_people/hrms/X12345/R98766
{
"title":"Administrative Assistant"
"percentAllocation":"20%"
}
Response
Response |
Description |
|---|---|
|
Request successfully processed |
|
There was a problem with the data submitted |
|
Authentication required |
|
Client is attempting to operate outside of its authority (eg: to the wrong SOR path) |
|
There is already a person or role with the specified identifer |
|
Unknown error |
The Identity Registry may return a Reference Identifier if identity match is not called separately. (The other ID Match responses may apply, as well.)
201 Created
{
"responseType":"referenceId",
"version":"1.0",
"referenceId":"M225127891"
}
Additional attributes, such as identifiers, may also be returned.
201 Created
{
"responseType":"referenceId",
"version":"1.0",
"referenceId":"M225127891",
"netId":"pl53",
"email":"pat.lee@university.edu"
}
Request Using Person-Level Attributes Expressed As Role-Level Attributes
In this example, the SOR is capable of representing Person-Level Attributes, but the Identity Registry is not. This example also applies where the Identity Registry is capable of representing Person-Level Attributes, but the SOR is not.
POST /sor_people/hrms/X12345/R98765
{
"givenName":"Pat",
"sn":"Lee",
"dateofBirth":"1983-03-18"
"title":"Professor of Phrenology"
"percentAllocation":"50%"
}
POST /sor_people/hrms/X12345/R98766
{
"givenName":"Pat",
"sn":"Lee",
"dateofBirth":"1983-03-18"
"title":"Administrative Assistant"
"percentAllocation":"20%"
}
SOR Person Role Deleted
DELETE /sor_people/hrms/X12345/R98765
Response
Response |
Description |
|---|---|
|
Request successfully processed |
|
Authentication required |
|
Client is attempting to operate outside of its authority (eg: to the wrong SOR path) |
|
The specified person is unknown |
|
The specified role is unknown |
|
Unknown error |
SOR Person Role Updated
For a PUT operation, the entire dataset must be provided.
PUT /sor_people/hrms/X12345/R98765
{
"givenName":"Patricia",
}
Response
Response |
Description |
|---|---|
|
Request successfully processed |
|
There was a problem with the data submitted |
|
Authentication required |
|
Client is attempting to operate outside of its authority (eg: to the wrong SOR path) |
|
The specified person is unknown |
|
The specified role is unknown |
|
Unknown error |