ImagingV2

ImagingV2

Web service to access AR Document Imaging V2 web services for AR Imaging web pages and AR Scanning and Data Entry desktop applications

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

Base URL: /domains/legacy/imagingV2/ARAPI

Version: v1

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

Summary

Path Operation Description
/* GET

generic resource point for resources used by desktop clients
POST

generic resource point for resources used by desktop clients

Paths

generic resource point for resources used by desktop clients

GET /*

Tags: ImagingV2
$RESOURCE

string -> a string of up to 50 characters

 query string
BatchRef

string -> a string of up to 15 characters

 query string
CCode

string

 query string
CTNum

string

 query string
Count

number string

 query string
DE1NetID

string

 query string
DE2NetID

string

 query string
DEData

string

 query string
DENum

string

 query string
Direction

string

 query string
EndDate

string

 query string
Identifier

string

 query string
ImageName

string

 query string
ImageType

string

 query string
Index

number string

 query string
Key1

string

 query string
Key2

string

 query string
KeyRest

string

 query string
Key1Op

string

 query string
Key2Op

string

 query string
KeyRestOp

string

 query string
Method

string

 query string
NetID

string

 query string
NewRef

string

 query string
OsRoot

string

 query string
ScanLoc

string

 query string
ScanNetID

string

 query string
Start

number string

 query string
StartDate

string

 query string
Status

string

 query string
ImageFile

a file for upload

 formData string

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

200 OK

Service request is OK and a response has been generated.

204 No Content

Service request is OK but the response is the empty set - no content found.

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.

ErrorResponse
403 Forbidden

The user does not have access to the resource.

ErrorResponse
404 Not Found

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

ErrorResponse
405 Method Not Allowed

The service method is not supported by the service.

ErrorResponse
409 Conflict

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

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

ErrorResponse
generic resource point for resources used by desktop clients

POST /*

Tags: ImagingV2
$RESOURCE

string -> a string of up to 50 characters

 query string
Imagefile

a file for upload

 formData string
BatchRef

string -> a string of up to 15 characters

 query string
ImageName

string

 query string
CCode

string

 query string
CTNum

string

 query string
Count

string

 query string
DE1NetID

string

 query string
DE2NetID

string

 query string
DEData

string

 query string
DENum

string

 query string
Direction

string

 query string
EndDate

string

 query string
Identifier

string

 query string
ImageType

string

 query string
Index

number string

 query string
Key1

string

 query string
Key2

string

 query string
KeyRest

string

 query string
Key1Op

string

 query string
Key2Op

string

 query string
KeyRestOp

string

 query string
Method

string

 query string
NetID

string

 query string
NewRef

string

 query string
OsRoot

string

 query string
ScanLoc

string

 query string
ScanNetID

string

 query string
Start

number string

 query string
StartDate

string

 query string
Status

string

 query string

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

200 OK

Service request is OK and a response has been generated.

204 No Content

Service request is OK but the response is the empty set - no content found.

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.

ErrorResponse
403 Forbidden

The user does not have access to the resource.

ErrorResponse
404 Not Found

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

ErrorResponse
405 Method Not Allowed

The service method is not supported by the service.

ErrorResponse
409 Conflict

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

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

ErrorResponse

Schema definitions

error_data: object

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

ErrorResponse: object

response: object
errors: errors

errors: object[]

error_data
Service Path: 
/domains/legacy/imagingV2/ARAPI
Domain or University API: 
/domains/D/imagingV2/ARAPI
Tags: 
domains
legacy
imagingV2
ARAPI

Community

 

Don't see your question listed here? Ask!

View This API in the API Store

Get Elevated Access