ImagingIMGARAPIWebService

ImagingIMGARAPIWebService

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
More information: https://it.byu.edu
Contact Info: api@byu.edu
Version: v1
BasePath:/domains/legacy/imaging/IMGARAPI
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

Default

ImagingIMGARAPIWebService

Default

Up
get /documentation
service definition (getServiceDocumentation)
service definition

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

ImagingIMGARAPIWebService

Up
post /add_auth_user
adds specified authorization type to list of authorization types for specified net ID (addAuthorizationToNetID)
adds specified authorization type to list of authorization types for specified net ID

Query parameters

NetID (required)
Query Parameter x2014; string -> a string of up to 15 characters
AuthType (required)
Query Parameter x2014; string -> a string of up to 10 characters

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

204

Service request is OK but the response is the empty set - no content found. 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. ErrorResponse

403

The user does not have access to the resource. ErrorResponse

404

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

405

The service method is not supported by the service. ErrorResponse

409

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

500

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

Up
post /add_upload_role_doctype
adds specified document type to list of allowed document types for specified Document Imaging upload role (addDocTypetoUploadRole)
adds specified document type to list of allowed document types for specified Document Imaging upload role

Query parameters

UploadRole (required)
Query Parameter x2014; string -> a string of up to 20 characters
DocumentType (required)
Query Parameter x2014; string -> a string of up to 15 characters

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

204

Service request is OK but the response is the empty set - no content found. 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. ErrorResponse

403

The user does not have access to the resource. ErrorResponse

404

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

405

The service method is not supported by the service. ErrorResponse

409

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

500

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

Up
post /add_netid_to_upload_role
adds specified net ID to specified Document Imaging upload role (addNetIDToUploadRole)
adds specified net ID to specified Document Imaging upload role

Query parameters

NetID (required)
Query Parameter x2014; string -> a string of up to 15 characters
UploadRole (required)
Query Parameter x2014; string -> a string of up to 20 characters

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

204

Service request is OK but the response is the empty set - no content found. 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. ErrorResponse

403

The user does not have access to the resource. ErrorResponse

404

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

405

The service method is not supported by the service. ErrorResponse

409

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

500

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

Up
post /create_upload_role
creates specified permission role for Document Imaging uploading (createRoleForUploading)
creates specified permission role for Document Imaging uploading

Query parameters

UploadRole (required)
Query Parameter x2014; string -> a string of up to 20 characters
Description (required)
Query Parameter x2014; string -> a string of up to 50 characters
OrganizationId (required)
Query Parameter x2014; string -> a string of up to 20 characters

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

204

Service request is OK but the response is the empty set - no content found. 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. ErrorResponse

403

The user does not have access to the resource. ErrorResponse

404

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

405

The service method is not supported by the service. ErrorResponse

409

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

500

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

Up
get /get_archived_uploads
gets list of archived uploads (getArchivedUploads)
gets list of archived uploads

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

204

Service request is OK but the response is the empty set - no content found. 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. ErrorResponse

403

The user does not have access to the resource. ErrorResponse

404

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

405

The service method is not supported by the service. ErrorResponse

409

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

500

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

Up
get /get_auth_users
gets Document Imaging users with specified authorization type (getAuthUsers)
gets Document Imaging users with specified authorization type

Query parameters

AuthType (required)
Query Parameter x2014; string -> a string of up to 10 characters

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

204

Service request is OK but the response is the empty set - no content found. 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. ErrorResponse

403

The user does not have access to the resource. ErrorResponse

404

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

405

The service method is not supported by the service. ErrorResponse

409

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

500

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

Up
get /get_doc_groups
gets all authorization groups for Document Imaging viewing (getDocGroups)
gets all authorization groups for Document Imaging viewing

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

204

Service request is OK but the response is the empty set - no content found. 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. ErrorResponse

403

The user does not have access to the resource. ErrorResponse

404

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

405

The service method is not supported by the service. ErrorResponse

409

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

500

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

Up
get /get_doc_types
get list of all Document Imaging document types (getDocTypes)
get list of all Document Imaging document types

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

204

Service request is OK but the response is the empty set - no content found. 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. ErrorResponse

403

The user does not have access to the resource. ErrorResponse

404

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

405

The service method is not supported by the service. ErrorResponse

409

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

500

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

Up
get /get_doc_types_for_netid
get list of all Document Imaging document types for the specified net ID (getDocTypesForNetID)
get list of all Document Imaging document types for the specified net ID

Query parameters

NetID (required)
Query Parameter x2014; string -> a string of up to 15 characters

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

204

Service request is OK but the response is the empty set - no content found. 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. ErrorResponse

403

The user does not have access to the resource. ErrorResponse

404

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

405

The service method is not supported by the service. ErrorResponse

409

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

500

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

Up
get /get_netids_for_upload_role
gets net IDs who are in specified Document Imaging upload role (getNetIDsForUploadRole)
gets net IDs who are in specified Document Imaging upload role

Query parameters

UploadRole (required)
Query Parameter x2014; string -> a string of up to 20 characters

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

204

Service request is OK but the response is the empty set - no content found. 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. ErrorResponse

403

The user does not have access to the resource. ErrorResponse

404

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

405

The service method is not supported by the service. ErrorResponse

409

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

500

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

Up
get /get_new_uploads
gets list of recent uploads (getNewUploads)
gets list of recent uploads

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

204

Service request is OK but the response is the empty set - no content found. 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. ErrorResponse

403

The user does not have access to the resource. ErrorResponse

404

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

405

The service method is not supported by the service. ErrorResponse

409

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

500

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

Up
get /get_periods
gets various types of BYU date periods used in Document Imaging (getPeriods)
gets various types of BYU date periods used in Document Imaging

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

204

Service request is OK but the response is the empty set - no content found. 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. ErrorResponse

403

The user does not have access to the resource. ErrorResponse

404

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

405

The service method is not supported by the service. ErrorResponse

409

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

500

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

Up
get /get_upload_role_doctypes
gets list of allowed document types for specified Document Imaging upload role (getUploadRoleDoctypes)
gets list of allowed document types for specified Document Imaging upload role

Query parameters

NetID (required)
Query Parameter x2014; string -> a string of up to 15 characters
UploadRole (required)
Query Parameter x2014; string -> a string of up to 20 characters

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

204

Service request is OK but the response is the empty set - no content found. 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. ErrorResponse

403

The user does not have access to the resource. ErrorResponse

404

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

405

The service method is not supported by the service. ErrorResponse

409

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

500

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

Up
get /get_upload_roles
gets all authorization roles for Document Imaging uploading (getUploadRoles)
gets all authorization roles for Document Imaging uploading

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

204

Service request is OK but the response is the empty set - no content found. 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. ErrorResponse

403

The user does not have access to the resource. ErrorResponse

404

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

405

The service method is not supported by the service. ErrorResponse

409

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

500

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

Up
get /get_upload_roles_for_netid
gets Document Imaging upload roles for specified net ID (getUploadRolesForNetID)
gets Document Imaging upload roles for specified net ID

Query parameters

NetID (required)
Query Parameter x2014; string -> a string of up to 15 characters

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

204

Service request is OK but the response is the empty set - no content found. 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. ErrorResponse

403

The user does not have access to the resource. ErrorResponse

404

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

405

The service method is not supported by the service. ErrorResponse

409

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

500

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

Up
get /get_users
gets Document Imaging users (getUsers)
gets Document Imaging users

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

204

Service request is OK but the response is the empty set - no content found. 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. ErrorResponse

403

The user does not have access to the resource. ErrorResponse

404

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

405

The service method is not supported by the service. ErrorResponse

409

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

500

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

Up
get /get_users_for_upload_role
gets users who are in specified Document Imaging upload role (getUsersForUploadRole)
gets users who are in specified Document Imaging upload role

Query parameters

UploadRole (required)
Query Parameter x2014; string -> a string of up to 20 characters

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

204

Service request is OK but the response is the empty set - no content found. 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. ErrorResponse

403

The user does not have access to the resource. ErrorResponse

404

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

405

The service method is not supported by the service. ErrorResponse

409

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

500

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

Up
get /is_auth_user
determines whether specified net ID has specified authorization type (isAuthUser)
determines whether specified net ID has specified authorization type

Query parameters

NetID (required)
Query Parameter x2014; string -> a string of up to 15 characters
AuthType (required)
Query Parameter x2014; string -> a string of up to 10 characters

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

204

Service request is OK but the response is the empty set - no content found. 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. ErrorResponse

403

The user does not have access to the resource. ErrorResponse

404

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

405

The service method is not supported by the service. ErrorResponse

409

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

500

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

Up
get /lookup_upload_auth
gets list of upload roles and list of document types that can be uploaded for specified net ID (lookupUploadAuth)
gets list of upload roles and list of document types that can be uploaded for specified net ID

Query parameters

NetID (required)
Query Parameter x2014; string -> a string of up to 15 characters

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

204

Service request is OK but the response is the empty set - no content found. 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. ErrorResponse

403

The user does not have access to the resource. ErrorResponse

404

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

405

The service method is not supported by the service. ErrorResponse

409

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

500

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

Up
get /lookup_upload_auth_p
gets list of upload roles and list of document types that can be uploaded for specified person ID (lookupUploadAuthP)
gets list of upload roles and list of document types that can be uploaded for specified person ID

Query parameters

PersonID (required)
Query Parameter x2014; string -> a string of 9 characters

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

204

Service request is OK but the response is the empty set - no content found. 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. ErrorResponse

403

The user does not have access to the resource. ErrorResponse

404

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

405

The service method is not supported by the service. ErrorResponse

409

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

500

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

Up
post /remove_netid_from_upload_role
removes specified net ID from specified Document Imaging upload role (removeNetIDFromUploadRole)
removes specified net ID from specified Document Imaging upload role

Query parameters

NetID (required)
Query Parameter x2014; string -> a string of up to 15 characters
UploadRole (required)
Query Parameter x2014; string -> a string of up to 20 characters

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

204

Service request is OK but the response is the empty set - no content found. 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. ErrorResponse

403

The user does not have access to the resource. ErrorResponse

404

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

405

The service method is not supported by the service. ErrorResponse

409

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

500

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

Up
post /remove_upload_role
removes specified permission role for Document Imaging uploading (removeUploadRole)
removes specified permission role for Document Imaging uploading

Query parameters

UploadRole (required)
Query Parameter x2014; string -> a string of up to 20 characters

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

204

Service request is OK but the response is the empty set - no content found. 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. ErrorResponse

403

The user does not have access to the resource. ErrorResponse

404

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

405

The service method is not supported by the service. ErrorResponse

409

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

500

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

Up
post /update_upload_role
updates specified permission role for Document Imaging uploading (updateUploadRole)
updates specified permission role for Document Imaging uploading

Query parameters

UploadRole (required)
Query Parameter x2014; string -> a string of up to 20 characters
OrganizationId (required)
Query Parameter x2014; string -> a string of up to 20 characters
Description (required)
Query Parameter x2014; string -> a string of up to 50 characters

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

204

Service request is OK but the response is the empty set - no content found. 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. ErrorResponse

403

The user does not have access to the resource. ErrorResponse

404

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

405

The service method is not supported by the service. ErrorResponse

409

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

500

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

Up
get /ym_upload_authorized
Determines whether specified NetID is authorized to upload specified DocumentType (yMUploadAuthorized)
Determines whether specified NetID is authorized to upload specified DocumentType

Query parameters

NetID (required)
Query Parameter x2014; string -> a string of up to 15 characters
DocumentType (required)
Query Parameter x2014; string -> a string of up to 15 characters

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

204

Service request is OK but the response is the empty set - no content found. 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. ErrorResponse

403

The user does not have access to the resource. ErrorResponse

404

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

405

The service method is not supported by the service. ErrorResponse

409

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

500

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

Up
get /ym_upload_authorized_p
Determines whether specified PersonID is authorized to upload specified DocumentType (yMUploadAuthorizedP)
Determines whether specified PersonID is authorized to upload specified DocumentType

Query parameters

PersonID (required)
Query Parameter x2014; string -> a string of 9 characters
DocumentType (required)
Query Parameter x2014; string -> a string of up to 15 characters

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

204

Service request is OK but the response is the empty set - no content found. 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. ErrorResponse

403

The user does not have access to the resource. ErrorResponse

404

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

405

The service method is not supported by the service. ErrorResponse

409

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

500

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

Models

[ Jump to Methods ]

Table of Contents

  1. ErrorResponse
  2. error_data
  3. errors

ErrorResponse - Up

errors (optional)
response (optional)

error_data - Up

code (optional)
name (optional)
message (optional)
httpStatusCode (optional)
Service Path: 
/domains/legacy/imaging/IMGARAPI
Domain or University API: 
D

Community

 

Don't see your question listed here? Ask!