IdentityPersonIDPhoto

This service accesses the ID Photo in the Person (PRO) System. It is the web service version of the web page PERPIC in the PRO System.

More information: https://it.byu.edu
Contact Info: api@byu.edu

Base URL: /domains/legacy/identity/person/idphoto

Version: v1

Default response content-types: application/json, application/xml
Schemes: https

Summary

Path Operation Description
/* GET

Shows the photo by the ID

/documentation GET

service definition

Paths

Shows the photo by the ID

GET /*

Tags: IDPhotoService

Shows the photo by the ID specified (via attributes: p, b, or n) or defaults to the current user(if no attribute p, b, or n is specified.) The service will allow an instructor to view a photo if the user is the instructor of a class that the requested person is in (checked via the attributes yt, ci, tc, and sn.)

p

string -> PERSON_ID: 9 digit number

query string , { x | x ≤ 9 }
b

string -> BYU_ID: 9 digit number

query string , { x | x ≤ 9 }
N

string -> NET_ID: string

query string
yt

string -> [0-9]{4}[1|3|4|5]

query string
ci

string -> CURRICULUM_ID: 5 digit number

query string , { x | x ≤ 5 }
tc

string -> TITLE_CODE: 3 digit number

query string , { x | x ≤ 3 }
sn

string -> SECTION_NUMBER: 3 digit number

query string , { x | x ≤ 3 }

image/jpeg

200 OK

The ID given matches a photo in the database

400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

401 Unauthorized

Failure to authenticate

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

A conflict has occurred. The response structure may contain information about the conflict.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

service definition

GET /documentation

service definition

Uses default content-types: application/json application/xml

200 OK

Success

Schema definitions

Service Path: 
/domains/legacy/identity/person/idphoto
Domain or University API: 
/domains/D/identity/person/idphoto

Community

 

Don't see your question listed here? Ask!