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.

More information: https://it.byu.edu
Contact Info: api@byu.edu

Base URL: /domains/legacy/unstructuredcontent/legacyimaging/imagingdocrights

Version: v1

Default response content-types: application/json, application/xml
Schemes: https

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 a list of all authorized document types for AR for current user or specified net_id

GET /ar/{net_id}

Tags: ImgDocRightsWSService

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

service definition

GET /documentation

service definition

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

200 OK

Success

Get a list of all authorized document types for FS for current user or specified net_id

GET /fs/{net_id}

Tags: ImgDocRightsWSService

Get 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 a list of all authorized document types for AR and FS for current user or specified net_id

GET /{net_id}

Tags: ImgDocRightsWSService

Get 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

ar_document_types: object[]

object

attributes: string

auth_ar_doc_type_count: number

auth_doc_type_count: number

auth_fs_doc_type_count: number

error_data: object

code: string
name: string
message: string
httpStatusCode: number

ErrorResponse: object

request: request
errors: errors
response: object

errors: object[]

fs_document_types: object[]

object

ImgDocRightsWSService1: object

request: request
response: response1

ImgDocRightsWSService2: object

request: request
response: response2

ImgDocRightsWSService3: object

request: request
response: response3

message: string

method: string

net_id: string

request: object

status: status
resource: resource
method: method
attributes: attributes
statusMessage: statusMessage

requested_system: string

resource: string

response1: object

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

response2: object

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

response3: object

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

status: number

statusMessage: string

Service Path: 
/domains/legacy/unstructuredcontent/legacyimaging/imagingdocrights
Domain or University API: 
/domains/D/unstructuredcontent/Dimaging/imagingdocrights

Community

 

Don't see your question listed here? Ask!