IdentityAccessInfoArea
InfoAreaService
Base URL: /domains/legacy/identity/access/infoarea
Version: v1
Summary
| Path | Operation | Description |
|---|---|---|
| /info.area.cgi/ | GET | List info areas |
| /info.area.cgi/documentation | GET | Documentation-Info_area |
| /info.area.cgi/{info_area_name}/{credit_institution}/WALL* | GET | List Web resources |
| /info.area.cgi/{info_area_name}/{credit_institution}/{category}* | GET | List authorized users |
Paths
List info areas
| page | Specifies set of resources is to be returned | query | string |
Uses default content-types: application/json
- 200 OK
-
Service request is OK and a response has been generated.
- 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.
GET /info.area.cgi/documentation
Documentation-Info_area
Uses default content-types: application/json
- 200 OK
-
Success
GET /info.area.cgi/{info_area_name}/{credit_institution}/WALL*
Tags: InfoAreaServiceList web resources
| info_area_name | Information area name | path | string | |
| credit_institution | A specified credit institution/school | path | string | |
| page | Specifies set of resources is to be returned | query | string |
Uses default content-types: application/json
- 200 OK
-
Service request is OK and a response has been generated.
Example for application/json{
"request": {
"attributes": "page=1",
"method": "GET",
"resource": "/PERSON/BYU PROVO/WALL",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"creditInstitution": "",
"dateTimeUpdated": "06 Dec 2002",
"description": "",
"filter": "WALL",
"informationalArea": "PERSON",
"listSet": "W",
"totalPages": 0,
"updateType": "D",
"updatedBy": "Southern, Jennifer A",
"webResourcesList": [
{
"outOfService": "N",
"pageName": "Unlist Information",
"restrictedFlag": "N",
"speedURL": "UNLIST",
"updatedTime": "04 Mar 2011"
}
]
}
} - 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.
GET /info.area.cgi/{info_area_name}/{credit_institution}/{category}*
Tags: InfoAreaServiceList authorized users
| info_area_name | Information area name | path | string | |
| credit_institution | A specified credit institution/school | path | string | |
| page | Specifies set of resources is to be returned | query | string | |
| category | Specifies category of users | path | string , x ∈ { AALL , AACT , AEXP } |
Uses default content-types: application/json
- 200 OK
-
Service request is OK and a response has been generated.
Example for application/json{
"request": {
"attributes": "page=1",
"method": "GET",
"resource": "/PERSON/BYU PROVO/WALL",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"creditInstitution": "",
"dateTimeUpdated": "06 Dec 2002",
"description": "",
"filter": "WALL",
"informationalArea": "PERSON",
"listSet": "W",
"totalPages": 0,
"updateType": "D",
"updatedBy": "Southern, Jennifer A",
"webResourcesList": [
{
"outOfService": "N",
"pageName": "Unlist Information",
"restrictedFlag": "N",
"speedURL": "UNLIST",
"updatedTime": "04 Mar 2011"
}
]
}
} - 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.
Schema definitions
- request: object
-
- method: string
-
- resource: string
-
- attributes: string
-
- status: number
-
- statusMessage: string
-
- response: object
-
- informationalArea: string
-
- creditInstitution: string
-
- description: string
-
- filter: string
-
- listSet: string
-
- dateTimeUpdated: string
-
- updateType: string
-
- updatedBy: string
-
- totalPages: number
-
- webResourcesList: object[]
- webResource: object
-
- speedURL: string
-
- pageName: string
-
- restrictedFlag: string
-
- outOfService: string
-
- updatedTime: string
-
- errors: object[]
-
object - code: number
-
- name: string
-
- message: string
-
- httpStatusCode: number
-
