Uses default content-types: application/json

200 OK

Success

documentation

Uses default content-types: application/json

200 OK

A Person Id Card

personIdCard

Example for application/json

{
    "ID Card Service": {
        "request": {
            "attributes": "",
            "method": "GET",
            "resource": "/json/123456789",
            "status": "200"
        },
        "resource": {
            "URI": "/[personid|netid]",
            "attributes": {
                "lost_stolen": {
                    "default": "false",
                    "description": "A boolean indicator.  If true indicates that the ID Card has been lost or stolen",
                    "required": false
                },
                "unlisted": {
                    "default": "false",
                    "description": "A boolean indicator.  If true indicates the desire make the ID Card unlisted (unavailable) except to those who have a legitimate need to know",
                    "required": false
                }
            },
            "examples": [
                "/",
                "/123456789",
                "/byu999"
            ],
            "identifiers": [
                {
                    "personid": {
                        "default": "Identifier of authenticated individual",
                        "description": "Unique identifier of an individual",
                        "required": false
                    }
                },
                {
                    "netid": {
                        "description": "Online account or network identifier of an individual",
                        "required": false
                    }
                }
            ],
            "methods": {
                "adaptations": [
                    {
                        "PUT": [
                            "Tunnel through a GET with attributes in the query string name value pairs",
                            "Tunnel through a POST with attributes in POST content name values pairs"
                        ]
                    }
                ],
                "options": [
                    "GET",
                    "PUT"
                ]
            }
        },
        "response": {
            "ID_card_name": "John Albert Doe",
            "ID_card_role": "Student",
            "beard": false,
            "byu_id": "98-765-4321",
            "card_status": "",
            "dtf": false,
            "expiration_date": "31-DEC-2020",
            "id_card_roles": {
                "current": {
                    "primary_role": "Student",
                    "secondary_role": "full time student junior"
                },
                "when_issued": {
                    "primary_role": "Student",
                    "secondary_role": "full time student sophomore"
                }
            },
            "issue_number": "02",
            "lost_stolen": false,
            "photo_URL": "https://y.byu.edu/ry/ae/prod/person/cgi/personPhoto.cgi/123456789",
            "relationships": [
                {
                    "affiliation": "",
                    "deceased": "",
                    "employee": "ADM/FT/TRM",
                    "name": "Jack Doe",
                    "person_id": "111222333",
                    "student": "Former Student",
                    "type": "Child of:"
                }
            ],
            "unlisted": false,
            "warnings": [
                "Non-Directory information is accessible only to yourself and to university personnel with a legitimate need to know"
            ]
        }
    }
}

400 Bad Request

There appears to be a syntax error in the composition of the service request.

errors

401 Unauthorized

Failure to authenticate

errors

403 Forbidden

The user does not have access to the resource

errors

404 Not Found

The target resource cannot be found for the provided resouce identifiers

errors

405 Method Not Allowed

The service method is not supported by the service.

errors

409 Conflict

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

errors

500 Internal Server Error

An error occurred generating the response to the service request.

errors