UnstructuredContentLegacyImagingImagingDocRights
This service returns a list of authorized document types in either AR (academic records) or FS (PeopleSoft Financial Services) for a given user or net id.
Base URL: /domains/legacy/unstructuredcontent/legacyimaging/imagingdocrights
Version: v1
Summary
| Path | Operation | Description |
|---|---|---|
| /ar/{net_id} | GET | Get a list of all authorized document types for AR for current user or specified net_id |
| /documentation | GET | service definition |
| /fs/{net_id} | GET | Get a list of all authorized document types for FS for current user or specified net_id |
| /{net_id} | GET | Get a list of all authorized document types for AR and FS for current user or specified net_id |
Paths
GET /ar/{net_id}
Tags: ImgDocRightsWSServiceGet a list of all authorized document types for AR for current user or specified net_id
| net_id | string -> a string of up to 15 characters | path | string |
Uses default content-types: application/json application/xml
- 200 OK
-
Service request is OK and a response has been generated.
Example for applications/json{
"request": {
"attributes": "",
"method": "GET",
"resource": "/ar/joestud",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"ar_document_types": [
],
"auth_ar_doc_type_count": 0,
"auth_doc_type_count": 0,
"message": "0 document types found for joestud",
"net_id": "joestud",
"requested_system": "AR"
}
} - 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.
- 405 Method Not Allowed
-
The service method is not supported by the service.
- 409 Conflict
-
A conflict has occurred. The response structure may contain information about the conflict.
- 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 /documentation
service definition
Uses default content-types: application/json application/xml
- 200 OK
-
Success
GET /fs/{net_id}
Tags: ImgDocRightsWSServiceGet a list of all authorized document types for FS for current user or specified net_id
| net_id | string -> a string of up to 15 characters | path | string |
Uses default content-types: application/json application/xml
- 200 OK
-
Service request is OK and a response has been generated.
Example for applications/json{
"request": {
"attributes": "",
"method": "GET",
"resource": "/fs/joestud",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"auth_doc_type_count": 0,
"auth_fs_doc_type_count": 0,
"fs_document_types": [
],
"message": "0 document types found for joestud",
"net_id": "joestud",
"requested_system": "FS"
}
} - 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.
- 405 Method Not Allowed
-
The service method is not supported by the service.
- 409 Conflict
-
A conflict has occurred. The response structure may contain information about the conflict.
- 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 /{net_id}
Tags: ImgDocRightsWSServiceGet a list of all authorized document types for AR and FS for current user or specified net_id
| net_id | string -> a string of up to 15 characters | path | string |
Uses default content-types: application/json application/xml
- 200 OK
-
Service request is OK and a response has been generated.
Example for applications/json{
"request": {
"attributes": "",
"method": "GET",
"resource": "/joestud",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"ar_document_types": [
],
"auth_ar_doc_type_count": 0,
"auth_doc_type_count": 0,
"auth_fs_doc_type_count": 0,
"fs_document_types": [
],
"message": "0 document types found for joestud",
"net_id": "joestud",
"requested_system": "ALL"
}
} - 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.
- 405 Method Not Allowed
-
The service method is not supported by the service.
- 409 Conflict
-
A conflict has occurred. The response structure may contain information about the conflict.
- 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
- status: status
-
- resource: resource
-
- method: method
-
- attributes: attributes
-
- statusMessage: statusMessage
-
- net_id: net_id
-
- requested_system: requested_system
-
- auth_doc_type_count: auth_doc_type_count
-
- message: message
-
- auth_ar_doc_type_count: auth_ar_doc_type_count
-
- auth_fs_doc_type_count: auth_fs_doc_type_count
-
- ar_document_types: ar_document_types
-
- fs_document_types: fs_document_types
-
- net_id: net_id
-
- requested_system: requested_system
-
- auth_doc_type_count: auth_doc_type_count
-
- message: message
-
- auth_ar_doc_type_count: auth_ar_doc_type_count
-
- ar_document_types: ar_document_types
-
- net_id: net_id
-
- requested_system: requested_system
-
- auth_doc_type_count: auth_doc_type_count
-
- message: message
-
- auth_fs_doc_type_count: auth_fs_doc_type_count
-
- fs_document_types: fs_document_types
-
