Skip to end of metadata
Go to start of metadata

This document describes the attributes of the Name resource.  It also lists which attributes must be defined for operations that require input–note that there are many attributes but most operations only require that a few of the attributes be defined

Attributes

Following is a list of all attributes the account resource might return or require.  Not all methods or sources will return or require all of these attributes.  

 

Property Name
Description
Details
Read Only?
validid

RegID of person entity

Unique identifier for a person entityYes
formal_cnameConcatenated legal name of person entityFormed by concatenating Formal Fname and Formal Sname.Yes
formal_fnameLegal first name of person entity

If the person entity has records for both the student and employee sources, the fname value from the HEPPS source is put in this field.

If the person is only a student, then the fname value from the SDB source is put in this field.

Yes
formal_snameLegal surname of person entity

If the person entity has records for both the student and employee sources, the lname value from the HEPPS  source is put in this field.

If the person is only a student, then the lname value from the SDB source is put in this field.

Yes
formal_privacyPrivacy flag for legal nameSetting this flag has no effect (for now). Possible values: Restricted, Public, Extended UW CommunityYes
display_cnameConcatenated display name of person entityFormed by concatenating Display Fname and Display Sname.Yes

display_fname

Display first name of person entityThis is a display name rollup, contains preferred first name component if set. Otherwise some legal fname. 
display_snameDisplay surname of person entityThis is a display name rollup, contains preferred first name component if set. Otherwise some legal sname 
preferred_cnameConcatenated preferred name of person entityFormed by concatenating Preferred Fname, Preferred Mname and Preferred SnameYes
preferred_fnamePerson preferred first name.This is a "preferred name" set by the user. It is not a legal name. 
preferred_mnamePerson preferred middle name.This is a "preferred name" set by the user. It is not a legal name. 
preferred_snamePerson preferred last name.This is a "preferred name" set by the user. It is not a legal name. 
preferred_privacyPrivacy flag for preferred nameSetting this flag has no effect (for now). Possible values: Restricted, Public, Extended UW Community 

 

For Updating a Record

At least one of the following attributes must be submitted as a JSON payload when updating name information:

  • preferred_fname
  • preferred_mname
  • preferred_sname
  • preferred_privacy

You will receive the error "one or more arguments missing" if you fail to submit at least one of these in the payload.  Other attributes may be submitted (including read only attributes), but they will be ignored.  If you submit validid in the JSON payload, it must match the identifier provided in the URL.  

  • No labels