...
The message format is a JSON object with a single member,two possible members: sorAttributes
and returnUrl
.
The message should be sent with a Content-Type
header of text/json
.
sorAttributes
sorAttributes
is a required sorAttributes
, in turn, is an object whose members are from the following list of available attributes, as defined in the SOR-Registry Core Schema Specification:
...
*Plural attributes may have multiple values, provided via a JSON array
returnURL
returnUrl
is optional, and consists of a single string containing a URL. This URL is used as a Petition-Specific Redirect Target, if API Source is connected to a Pipeline that in turn is connected to an Enrollment Flow. Make sure the returnUrl is configured in the Enrollment Flow's Return URL Whitelist configurationThe message should be sent with a Content-Type
header of text/json
.
Code Block | ||||
---|---|---|---|---|
| ||||
{
"sorAttributes": {
"names": [
{
"type": "official",
"given": "Pat",
"middle": "X",
"family": "Lee"
}
],
"affiliation": "faculty",
"organization": "School of Philosophy and Biopharmacology",
"department": "Department of Metaphysics",
"title": "Associate Professor of Metaphysical Microbiology",
"dateOfBirth": "1990-04-25",
"validFrom": "2019-09-01T00:00:00Z",
"validThrough": "2020-08-31T23:59:59Z",
"identifiers": [
{
"type": "national",
"identifier": "541-00-3732"
}
],
"emailAddresses": [
{
"type": "personal",
"address": "patxlee@email.nil",
"verified": true
}
],
"addresses": [
{
"type": "home",
"streetAddress": "3593 Red Maple Drive",
"locality": "Los Angeles",
"region": "CA",
"postalCode": "90046",
"country": "US"
}
],
"telephoneNumbers": [
{
"type": "home",
"number": "323-555-1208"
}
],
"urls": [
{
"type": "personal",
"url": "https://metaphysics.spb.ac.nil/plee"
}
]
},
"returnUrl": "https://registry.myvo.org/localapps/post-enrollment?regid=12345"
} |
PUT (Response)
The message format is a JSON object, currently with a single member: identifiers
, representing a list of identifiers associated with the CO Person created by or attached to the SOR record. Additional attributes may be returned in the future.
...