Skip to end of metadata
Go to start of metadata

The name resource allows you to read and update source-independent names associated with person entities.

 

Attributes

IRWS Name Attributes describes all the attributes of the Name resource, as well as which attributes must be defined when performing certain operations (read, update, etc.) on the resource.  

Actions

Note:  Your application may not be authorized for all of these actions.  

Reading a Record (GET)

You can read a source record with the following HTTP request:

GET {baseurl}/name/{identifier}

where {baseurl} is the base URL for the service, and {identifier} is an institutional identifier for this record.  The institutional identifier can be a RegID, UW Employee ID Number, or UW Student Number.  No payload is required, and it will be ignored if provided.

Details on parameters and schemas are available in the API Specification.  

IRWS Name Attributes provides detailed descriptions of attributes.  

Updating a Record (POST)

You can update a source record with the following HTTP request:

POST {baseurl}/name/{identifier}

where {baseurl} is the base URL for the service, and {identifier} is an institutional identifier for this record.  The institutional identifier can be a RegID, UW Employee ID Number, or UW Student Number.

Details on parameters and schemas are available in the API Specification.  

IRWS Name Attributes provides detailed descriptions of attributes.  

 

Updates to the name resource may be made by either PUT or POST.

  • No labels