Available methods
The available methods described here give an overview of the functionality available using the MultiTrans REST API. For the full details required for development, refer to your Swagger environment for sample code.
- authenticateUser
You must provider user credentials to access any information in MultiTrans, regardless of whether you're connecting through the user interface or the API. Your credentials determine both the methods available and the information that is returned in query responses. - Version
Retrieves the version number of the MultiTrans TMS. - createProject
Creates a new MultiTrans TMS project. Contacts can only submit projects on behalf of their customer while system administrators can submit projects on behalf of any existing user. - updateProject
Updates an existing project. Contacts can only update projects belonging to their customer. System administrators can update projects on behalf of any existing user. - getProjectStatus
Queries the status of a specific project. Contacts can only query projects belonging to their customer. System administrators can query any project. - getQuote
Retrieves all sent quotes for a specific project. Contacts can only retrieve quotes belonging to their customer. System administrators can retrieve any sent quote. - approveQuote
Approves a specific quote for a specific project. Contacts can only approve quotes belonging to their customer. System administrators can approve any sent quote. - cancelQuote
Refuses a specific quote for a specific project. Contacts can only refuse quotes belonging to their customer. System administrators can refuse any sent quote. - getProjects
Retrieves a list of projects meeting the specified criteria. Contacts can only retrieve projects belonging to their customer. System administrators can retrieve any project. - getProjectDetails
Retrieves detailed information about a project or projects. The details are returned from a maximum of 100 projects (ordered by project number) for a single query; if more projects are required, filter and send multiple queries. Contacts can only retrieve projects belonging to their customer. System administrators can retrieve any project. - setReviewStatus
Sets the review status of a delivered document. - getReviewLink
Gets the link for an online post-delivery review. - getLanguageList
Retrieves the list of languages used by the server. - getDomainList
Retrieves the list of domains used by the server. - getCategoryList
Retrieves the list of categories used by the server. - downloadDocument
Retrieves a document from MultiTrans. - getTasks
Retrieves a list of tasks and the task details. Contacts can only retrieve tasks from projects belonging to their customer. System administrators can retrieve any task. - updateTask
Updates a task status, a task status note or a task target document. Contacts can only update tasks for projects belonging to their customer. System administrators can update any task. - getProjectGroups
Retrieves a list of project groups. Contacts can only retrieve project groups belonging to their customer. System administrators can retrieve any project group. - createProjectGroup
Creates a new project group. Contacts can only create project groups belonging to their customer. System administrators can create project groups on behalf of any existing user. - updateProjectGroup
Updates an existing project group. Contacts can only update project groups belonging to their customer and cannot change the customer associated to the project group. System administrators can update any project group. - endSession
Disconnects the querying user.