Users
The Users API allows the retrieval of information for users.
GET
/users/{identifier}
DESCRIPTION
This endpoint is deprecated and will be sunset on 01 Aug 2024. Please update to using the
/users/search endpoint as a replacement.Returns a user's Net-ID based on the provided identifier (using either a Proximity Card or Magnetic Stripe Reader).
PARAMETERS
Header Parameters
| Name | Description | Required | Values | Default |
|---|---|---|---|---|
| X-API-KEY | The API Key to use for this request | Required | String | NULL |
URI Parameters
| Name | Description | Required | Values | Default |
|---|---|---|---|---|
| identifier | The output value from a Proximity Card or a Magnetic Stripe scan. | Required | Text | NULL |
RESPONSE
Type: application/json
A JSON object that complies with the JSON API standard (www.jsonapi.org).
| Status Code | Detail(s) |
|---|---|
| 200 | Successful response |
| 400 | Invalid user identifier |
| 401 | Invalid API key |
| 405 | Invalid request HTTP method |
| 429 | Too Many Requests |
Example Success Response
POST
/users/search
DESCRIPTION
Returns a user's Net-ID based on the provided identifier (using either a Proximity Card or Magnetic Stripe Reader)
PARAMETERS
Header Parameters
| Name | Description | Required | Values | Default |
|---|---|---|---|---|
| X-API-KEY | The API Key to use for this request | Required | String | NULL |
POST Parameters
| Name | Description | Required | Values | Default |
|---|---|---|---|---|
| identifier | The output value from a Proximity Card or a Magnetic Stripe scan. | Required | Text | NULL |
RESPONSE
Type: application/json
A JSON object that complies with the JSON API standard (www.jsonapi.org).
| Status Code | Detail(s) |
|---|---|
| 200 | Successful response |
| 400 | Invalid user identifier. This occurs when the identifier value is not found in the request object. |
| 401 | Invalid API key |
| 404 | User not found |
| 405 | Invalid request HTTP method |
| 429 | Too Many Requests |