RelationshipManagementStudentYMSGInterface

RelationshipManagementStudentYMSGInterface

The Imaging Y-Message Interface web service was created to allow Y-Message to 'push' documents and images onto Imaging. It also has the capability to get data and delete previously created documents if ever necessary. Document and image files are stored on Alfresco when uploaded to Y-Message. Once there it is accessible to Imaging, so all that is necessary to create the imaging document is the meta-data that is to be associated with the uploaded file.
More information: https://it.byu.edu
Contact Info: api@byu.edu
Version: v1
BasePath:/domains/legacy/relationshipmanagement/student/YMSGinterface
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

Default

YMSGInterfaceService

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

YMSGInterfaceService

Up
put /document
Creates a document from Y-Message (createYMessageDocument)
Creates a document from Y-Message

Query parameters

ObjectID (required)
Query Parameter x2014; string -> Alfresco object id.
DocumentType (required)
Query Parameter x2014; string -> One of the authorized types.
Period (required)
Query Parameter x2014; string -> Year, Year-term, or academic year.
BYUID (required)
Query Parameter x2014; string -> [0-9]{9}
CollegeCode (required)
Query Parameter x2014; string -> [0-9]{5}

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

500

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

Up
delete /{DocumentID}
Deletes a previously created document by Y-Message (deleteYMessageDocument)
Deletes a previously created document by Y-Message

Path parameters

DocumentID (required)
Path Parameter x2014; string -> [0-9]{1,8}

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

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 /{DocumentID}
Gets a previously created document by Y-Message (getYMessageDocument)
Gets a previously created document by Y-Message

Path parameters

DocumentID (required)
Path Parameter x2014; string -> [0-9]{1,8}

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

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/relationshipmanagement/student/YMSGinterface
Domain or University API: 
D

Community

 

Don't see your question listed here? Ask!