Skip to content Skip to site navigation Skip to service navigation

Person RESTful Web Services API

The person web service provides a way to retrieve the person data.

This includes:

  • Get person details
  • Get specific details of a person by specifying one or more tags
  • To get person's name, title, biodemo, address, telephone, email, URL, location, place, affiliation, identifier, privgroup, profile, emergency_contact, and visibility.
  • To get the person's photo as base64 encoded text

How to get started with the Person API

Follow the Middleware and Integration Services Integration (MaIS) checklist for RESTful Web Services. If you need help, are not sure whether the Web APIs are the best method for integrating with the registry, or just have some questions, contact the MaIS team.

HTTP Status codes

Code Conditions
200 OK The usual successful return code.
403 Access Denied The request was made without valid certificate.
404 Not Found The record you're looking for doesn't exist.
500 Internal Server Error Something broke with our code. Please tell us about it.

Error Handling

Person API sends error status via standard HTTP status codes (4xx or 5xx)

Get Person details

Description Get person details. Tags is optional. To get specific details tags can be used.
Valid tags values are: name, title, biodemo, address, telephone, email, url, location, place, affiliation, identifier, privgroup, profile, emergency, and visibility.
It can be a combination of one or more values also. ex: tags=(name,email)
URL https://registry.stanford.edu/doc/person/{id}?tags=(tagnames1,tagname2..)
Method GET
Returns 200 & Person details xml
403 & error: not authorized to access the service.
404 & error: personId is invalid.

Id could be univid, sunetid or regid.

Get Person name

Description Get person name
URL https://registry.stanford.edu/doc/person/{id}/name
Method GET
Returns 200 & Person name
403 & error: not authorized to access the service.
404 & error: personId is invalid.

Id could be univid, sunetid or regid.

Get Person title

Description Get person title
URL https://registry.stanford.edu/doc/person/{id}/title
Method GET
Returns 200 & Person title
403 & error: not authorized to access the service.
404 & error: personId is invalid.

Id could be univid, sunetid or regid.

Get Person biodemo

Description Get person biodemo
URL https://registry.stanford.edu/doc/person/{id}/biodemo
Method GET
Returns 200 & Person biodemo
403 & error: not authorized to access the service.
404 & error: personId is invalid.

Id could be univid, sunetid or regid.

Get Person address

Description Get person address
URL https://registry.stanford.edu/doc/person/{id}/address
Method GET
Returns 200 & Person address
403 & error: not authorized to access the service.
404 & error: personId is invalid.

Id could be univid, sunetid or regid.

Get Person telephone

Description Get person telephone
URL https://registry.stanford.edu/doc/person/{id}/telephone
Method GET
Returns 200 & Person telephone
403 & error: not authorized to access the service.
404 & error: personId is invalid.
Id could be univid, sunetid or regid.

Get Person email

Description Get person email
URL https://registry.stanford.edu/doc/person/{id}/email
Method GET
Returns 200 & Person email
403 & error: not authorized to access the service.
404 & error: personId is invalid.

Id could be univid, sunetid or regid.

Get Person url

Description Get person url
URL https://registry.stanford.edu/doc/person/{id}/url
Method GET
Returns 200 & Person url
403 & error: not authorized to access the service.
404 & error: personId is invalid.

Id could be univid, sunetid or regid.

Get Person location

Description Get person location
URL https://registry.stanford.edu/doc/person/{id}/location
Method GET
Returns 200 & Person location
403 & error: not authorized to access the service.
404 & error: personId is invalid.

Id could be univid, sunetid or regid.

Get Person place

Description Get person place
URL https://registry.stanford.edu/doc/person/{id}/place
Method GET
Returns 200 & Person place
403 & error: not authorized to access the service.
404 & error: personId is invalid.

Id could be univid, sunetid or regid.

Get Person affiliation

Description Get person affiliation
URL https://registry.stanford.edu/doc/person/{id}/affiliation
Method GET
Returns 200 & Person affiliation
403 & error: not authorized to access the service.
404 & error: personId is invalid.

Id could be univid, sunetid or regid.

Get Person identifier

Description Get person identifier
URL https://registry.stanford.edu/doc/person/{id}/identifier
Method GET
Returns 200 & Person identifier
403 & error: not authorized to access the service.
404 & error: personId is invalid.

Id could be univid, sunetid or regid.

Get Person privgroup

Description Get person privgroup
URL https://registry.stanford.edu/doc/person/{id}/privgroup
Method GET
Returns 200 & Person privgroup
403 & error: not authorized to access the service.
404 & error: personId is invalid.

Id could be univid, sunetid or regid.

Get Person profile

Description Get person profile
URL https://registry.stanford.edu/doc/person/{id}/profile
Method GET
Returns 200 & Person profile
403 & error: not authorized to access the service.
404 & error: personId is invalid.

Id could be univid, sunetid or regid.

Get Person emergency_contact

Description Get person emergency_contact
URL https://registry.stanford.edu/doc/person/{id}/emergency_contact
Method GET
Returns 200 & Person emergency_contact
403 & error: not authorized to access the service.
404 & error: personId is invalid.

Id could be univid, sunetid or regid.

Get Person visibility

Description Get person visibility
URL https://registry.stanford.edu/doc/person/{id}/visibility
Method GET
Returns 200 & Person visibility
403 & error: not authorized to access the service.
404 & error: personId is invalid.

Id could be univid, sunetid or regid.

Get Person image

Description Get person image by id
Set accept header with value image/jpeg to access this web service.
URL https://registry.stanford.edu/doc/person/{id}/image
Method GET
Returns 200 & Person Image
403 & error: not authorized to access the service.
404 & error: personId is invalid.

Id could be univid, sunetid or regid.

Get Person image as xml

Description Get person image by id as xml
Set accept header with value application/xml or text/xml to access this web service.
URL https://registry.stanford.edu/doc/person/{id}/image
Method GET
Returns 200 & Person Image xml
403 & error: not authorized to access the service.
404 & error: personId is invalid.

Id could be univid, sunetid or regid.

Last modified January 19, 2017