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

200 OK

Success

documentation

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

200 OK

Service request is OK and a response has been generated.

PersonIdsService

Example for application/json

{
    "Person Identifiers Service": {
        "request": {
            "attributes": "",
            "method": "GET",
            "resource": "/json/123456789",
            "status": "200"
        },
        "resource": {
            "URI": "/[personid|netid]",
            "attributes": {
                "prox_id": {
                    "description": "Unique identifier of a physical proximity card that has been issued to the individual as their ID card",
                    "required": false
                },
                "ssn": {
                    "description": "Social Security Number of the United States of America",
                    "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"
                ]
            },
            "note": "If an attribute is not present in the PUT request, the current value in the database will be retained.  That is to say only the values that are to be changed need be present in the PUT request.  Examples: /[personid]?ssn=111224444, /[personid]?prox_id=1234567, /[personid]?ssn=111224444&prox_id=1234567"
        },
        "response": {
            "net_id": "johnd",
            "person_id": "123456789",
            "prox_id": "",
            "ssn": "987-65-4321",
            "update_field_set": [
                ""
            ],
            "warnings": [
                "Non-Directory information is accessible only to yourself and to university personnel with a legitimate need to know",
                "No update is allowed"
            ]
        }
    }
}

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.

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.