Transeo Vantage REST API

The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.

There is a WADL document available that describes the resources API.

You may also enjoy the interactive interface provided for this API by Swagger.

Try it out!

name	path	methods	description
AppealResource	`/appeal/{visitClassId}`	`GET PUT`	Methods for Setting and Getting Appeal Data
AttributeGroupResource	`/attributeGroup/{attributeGroupName}/{classId}`	`GET PUT`	Methods for Setting and Getting IMS Attribute Groups
ClaimResource	`/claim/{visitClassId}`	`GET PUT`	Methods for Setting and Getting Claim Data
ClinicalTimeResource	`/clinicalTime` `/clinicalTime/{clinicalDay}/{room}`	`GET` `PUT`
CustomUserReportResource	`/customUserReports` `/customUserReports/{reportId}` `/customUserReports/{reportId}/{userId}`	`GET` `GET` `DELETE POST`	All endpoint required to support the Custom User Report Front-End application
DataEntryResource	`/dataentry/downtimeIssue` `/dataentry/lead` `/dataentry/nextCoin` `/dataentry/restore` `/dataentry/treatment` `/dataentry/visit` `/dataentry/mosaiqImage/{mosaiqId}` `/dataentry/treatment/{treatmentClassId}`	`POST` `POST` `GET` `POST` `POST` `POST` `GET` `DELETE`	Methods specific to uses in IMS Data Entry Applications
DataEntryXlsxResource	`/dataentryxlsx` `/dataentryxlsx/{applicationType}/{applicationName}`	`OPTIONS` `GET`
DataServerResource	`/dataserver/{dataType}` `/dataserver/{dataType}/{classId}`	`GET` `GET PUT`	Methods specific to uses in ProQueue Applications
DiagnosisInfoResource	`/diagnosisInfo/{visitClassId}` `/diagnosisInfo/{visitclassid}`	`GET` `PUT`	Methods for Setting and Getting IMS Diagnosis Info
DowntimeManagerResource	`/downtimeManager` `/downtimeManager/xlsx` `/downtimeManager/{classId}`	`GET POST` `GET` `DELETE GET PUT`
InsuranceResource	`/insurance/{classId}`	`GET PUT`	Methods for Setting and Getting IMS Insurance Data
LoginResource	`/login`	`POST`
NotesResource	`/notes` `/notes/{logId}` `/notes/all/{patientClassId}` `/notes/mosaiq/{patientClassId}` `/notes/patient/{patientClassId}`	`POST` `POST` `GET` `GET` `GET`	All methods for retrieving, editing, and creating IMS notes; and retrieving MosaiQ Notes.
PCEvent	`/pcevent` `/pcevent/{source}`	`GET POST` `GET`
PDFResource	`/pdf/{reportName}/{arg}`	`GET`	Methods specific to generating (Jasper) Reports
PGlobalsQuery	`/pGlobalsQuery/{queryName}`	`GET`
PausePlanLogResource	`/pausePlanLog` `/pausePlanLog/{classId}`	`PUT` `GET`
PaymentToPatientResource	`/paymentToPatient/{patientClassId}`	`GET PUT`	Methods for Setting and Getting IMS Payment To Patient Data
PhysicianAssociationResource	`/physicianAssociation/displayAsList` `/physicianAssociation/{classId}`	`GET` `GET PUT`	Methods for Setting and Getting IMS Insurance Data
PhysicianResource	`/physician` `/physician/{contactId}` `/physician/search/{criteria}`	`POST` `GET PUT` `GET`	Methods for Setting and Getting Physician Data Stored in CRM_Contact_Data. This is for those centers which persist their external physician in the Vantage database rather than in an external database (like MosaiQ)
PortalResource	`/portal/applicationGroups` `/portal/applications` `/portal/authUser` `/portal/users` `/portal/applicationGroups/{applicationGroupId}` `/portal/applications/{applicationId}` `/portal/users/dashboard` `/portal/users/{userId}`	`GET POST` `GET POST` `GET` `GET POST` `DELETE GET PUT` `DELETE GET PUT` `GET PUT` `DELETE GET PUT`
ProcessAnalysisReportResource	`/processAnalysis/dosimPhysics` `/processAnalysis/intakeProcess` `/processAnalysis/mosaiq` `/processAnalysis/treatmentProcess` `/processAnalysis/xray` `/processAnalysis/dosimPhysics/filterOptions` `/processAnalysis/dosimPhysics/xlsx` `/processAnalysis/intakeProcess/conversionRates` `/processAnalysis/intakeProcess/filterOptions` `/processAnalysis/intakeProcess/milestones` `/processAnalysis/intakeProcess/xlsx` `/processAnalysis/mosaiq/filterOptions` `/processAnalysis/mosaiq/xlsx` `/processAnalysis/treatmentProcess/filterOptions` `/processAnalysis/treatmentProcess/milestones` `/processAnalysis/treatmentProcess/xlsx` `/processAnalysis/xray/filterOptions` `/processAnalysis/xray/milestones` `/processAnalysis/xray/xlsx` `/processAnalysis/dosimPhysics/milestones/{planType}` `/processAnalysis/mosaiq/milestones/{planType}`	`POST` `POST` `POST` `POST` `POST` `GET` `POST` `POST` `GET` `GET` `POST` `GET` `POST` `GET` `GET` `POST` `GET` `GET` `POST` `GET` `GET`
RCBAnalysisResource	`/rcb` `/rcb/filterOptions` `/rcb/xlsx`	`POST` `GET` `POST`
ReportResource	`/reportQueries/downtimePct` `/reportQueries/patientServicesReport` `/reportQueries/patientServicesReportXlsx` `/reportQueries/rfidQuality` `/reportQueries/SimpleTable/{reportName}` `/reportQueries/StoredProcedure/{reportName}` `/reportQueries/StoredProcedureMultiple/{reportName}` `/reportQueries/SimpleTableXlsx/{reportName}/{fileName}` `/reportQueries/StoredProcedureMultipleXlsx/{reportName}/{fileName}` `/reportQueries/StoredProcedureXlsx/{reportName}/{fileName}`	`GET` `POST` `POST` `GET` `GET` `GET` `GET` `GET` `GET` `GET`
UtilityResource	`/util/archivedRecords` `/util/lookup` `/util/mosaiqApptTypes` `/util/columnConfig/{appName}` `/util/configurationValue/{parameterName}` `/util/configurationValueJSON/{parameterName}` `/util/filterLogic/{groupName}` `/util/lookup/{lookupType}` `/util/mosaiqApptTypes/{type}` `/util/nextTRAvailability/{visitClassId}` `/util/updateOIS/{visitClassId}` `/util/userCache/{id}` `/util/zip/{zipCode}` `/util/rfid/{mosaiqId}/{rfidKey}`	`GET` `GET` `GET` `GET` `GET` `GET` `GET` `GET PUT` `GET PUT` `GET` `PUT` `DELETE GET PUT` `GET` `PUT`	Misc. Utility methods used by many applications
WebLeadResource	`/weblead`	`POST`
XlsxReportApplicationsResource	`/xlsx/complex/true/{strQuery}/{nameForFile}` `/xlsx/simple/{simpleReportName}/{viewType}/{nameForFile}`	`GET` `GET`	Methods specific to generating and returning xlsx files for "simple" (single view) reports and "complex" (reports requiring SQL query construction at the client, due to complexity)

JSON

type	description
AbstractPCEvent
AppealModel
Application
ApplicationDetail
ApplicationGroup
ApplicationGroupDetail
ApplicationGroupSimple	The simple application group model without the child 'application' objects.
ApplicationSimple	The simple application model with only the data needed to be provided for PUT/POST endpoints.
ClaimModel
DashboardApplicationSimple	The simple application model for dashboard apps with only the data needed to be provided for PUT/POST endpoints.
DiagnosisInfoModel
DisplayUser	User data for the Display of a user and their apps in the portal
DowntimeIssueEdit
NewRecordModel
NoteData
PausePlanLog
PaymentToPatientModel
ProcessAnalysisQueryModel
RCBQueryModel
User	Simple User Model Just the very core data about a user
UserAdministration	User data for the administration of a user and their application rights.
UserAdministrationSimple	The simple user administration model with only the data needed to be provided for PUT/POST endpoints.

Resources

Data Types

JSON