IdentityAccessAIMInfoAreaInfoArea

IdentityAccessAIMInfoAreaInfoArea

This service accesses the 'info area' configuration which controls authorization on C-Framework web pages (mostly PRO-Person and AIM systems).
More information: https://it.byu.edu
Contact Info: api@byu.edu
Version: v1
BasePath:/domains/legacy/identity/access/AIMinfoarea/infoarea
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

Default

InfoAreaService

Default

Up
get /info.area.cgi/documentation
Documentation-Info_area (getInfoAreaServiceDocumentation)
Documentation-Info_area

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json
  • application/xml

Responses

200

Success String

InfoAreaService

Up
get /info.area.cgi/{info_area_name}/{credit_institution}/{category}
List authorized users (listAuthorizedUsers)
List authorized users

Path parameters

info_area_name (required)
Path Parameter x2014; Information area name
credit_institution (required)
Path Parameter x2014; A specified credit institution/school
category (required)
Path Parameter x2014; Specifies category of users

Query parameters

page_attribute (required)
Query Parameter x2014; Specifies set of resources is to be returned

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json
  • application/xml

Responses

200

Service request is OK and a response has been generated. String

400

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. String

403

The user does not have access to the resource. String

404

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

405

The service method is not supported by the service. String

409

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

500

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

Up
get /info.area.cgi/
List info areas (listInfoAreas)
List info areas

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json
  • application/xml

Responses

200

Service request is OK and a response has been generated. String

400

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. String

401

Failure to authenticate String

403

The user does not have access to the resource. String

404

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

405

The service method is not supported by the service. String

409

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

500

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

Up
get /info.area.cgi/{info_area_name}/{credit_institution}/WALL
List Web resources (listWebResources)
List web resources

Path parameters

info_area_name (required)
Path Parameter x2014; Information area name
credit_institution (required)
Path Parameter x2014; A specified credit institution/school

Query parameters

page_attribute (required)
Query Parameter x2014; Specifies set of resources is to be returned

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json
  • application/xml

Responses

200

Service request is OK and a response has been generated. String

400

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. String

401

Failure to authenticate String

403

The user does not have access to the resource. String

404

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

405

The service method is not supported by the service. String

409

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

500

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

Models

[ Jump to Methods ]

Table of Contents

Service Path: 
/domains/legacy/identity/access/AIMinfoarea/infoarea
Domain or University API: 
D

Community

 

Don't see your question listed here? Ask!