• Introduction
  • Web Service API
  • Callback service
  • Concepts
  • Testing

    Show / Hide Table of Contents
    • Overview
    • Concepts
      • API functionality
      • Web Service technology
      • Security
      • Accessing the services
      • Error reporting
      • Synchronous and asynchronous API
      • Testing
      • Telemetry
    • Translation memory API
      • Overview
      • ITMService
      • Lookup, concordance
      • Import, export
      • API
        • ConcordanceRequest
        • GenericFault
        • HeavyResourceInfo
        • HeavyResourceUpdateInfo
        • ImportTMMetadataSchemeResultInfo
        • InlineTagStrictness
        • InvalidSessionIdFault
        • ITMService
        • LookupSegmentRequest
        • NoLicenseFault
        • RequestXmlFormatFault
        • ResourceInfo
        • ResourceListFilter
        • ResourceUpdateInfo
        • ResultInfo
        • TMEngineType
        • TMFault
        • TMInfo
        • TMListFilter
        • TMOptimizationPreference
        • TMUpdateInfo
        • TmxImportResult
        • UnauthorizedAccessFault
        • UnexpectedFault
    • Term bases API
      • Overview
      • ITBService
      • Import, export
        • CSV
        • TBX
        • MultiTerm
      • API
        • CreateQTermTBFromTBXSettings
        • CreateQTermTBFromTBXTaskResult
        • CSVExportSettings
        • CSVExportTaskResult
        • CSVImportIntoExistingSettings
        • CSVImportIntoExistingTaskResult
        • CSVImportResult
        • CSVImportSettings
        • GenericFault
        • HeavyResourceInfo
        • HeavyResourceUpdateInfo
        • ITasksService
        • ITBService
        • QTermTBImportSettings
        • ResourceInfo
        • ResourceListFilter
        • ResourceUpdateInfo
        • ResultInfo
        • TaskDoesNotExistFault
        • TaskInfo
        • TaskNotFinishedFault
        • TaskResult
        • TaskStatus
        • TBCaseSensitivity
        • TBCloneInfo
        • TBFilter
        • TBFilterLangMode
        • TBInfo
        • TBMatching
        • TBNewTermDefaultForLanguage
        • TBUpdateInfo
        • TBXExportOptions
        • TBXExportTaskResult
        • TBXImportIntoExistingSettings
        • TBXImportResults
        • TBXImportSettings
        • TBXImportTaskResult
        • UnexpectedFault
    • LiveDocs API
      • Overview
      • ILiveDocsService
      • Alignment
      • API
        • AlignmentOptions
        • AlignmentResultInfo
        • CorpusIndexingOptions
        • CorpusIndexingSchedule
        • CorpusInfo
        • CorpusListFilter
        • CorpusUpdateInfo
        • DocumentForAlignment
        • GenericFault
        • HeavyResourceInfo
        • HeavyResourceUpdateInfo
        • ILiveDocsService
        • ImportBinaryFileIntoLiveDocsOptions
        • ImportFileIntoLiveDocsOptions
        • ImportFileIntoLiveDocsResultInfo
        • ImportLiveDocsXliffFileIntoLiveDocsOptions
        • ImportMonoOrBilingualFileIntoLiveDocsOptions
        • ResourceInfo
        • ResourceListFilter
        • ResourceUpdateInfo
        • ResultInfo
        • ResultStatus
        • UnexpectedFault
    • Light resources API
      • Overview
      • IResourceService
      • API
        • ExpectedFault
        • FilterConfigResourceInfo
        • FilterNames
        • GenericFault
        • IResourceService
        • LightResourceInfo
        • LightResourceInfoWithLang
        • LightResourceListFilter
        • PathRuleResourceInfo
        • PathRuleType
        • ProjectTemplateResourceInfo
        • ResourceInfo
        • ResourceType
        • ResourceUpdateInfo
        • UnexpectedFault
    • Server project API
      • Overview
      • User assignment
      • Omniscien Technologies services
      • IServerProjectService
      • API
        • AddProjectLanguageFault
        • AddProjectLanguageTBHandlingBehavior
        • AnalysisAsCSVResult
        • AnalysisAsCSVResultForLang
        • AnalysisOptions
        • AnalysisReportCounts
        • AnalysisReportForDocument
        • AnalysisReportInfo
        • AnalysisReportItem
        • AnalysisResultForLang
        • AnalysisResultInfo
        • AsiaOnlineBeginTranslationResultInfo
        • AsiaOnlineDomainCombination
        • AsiaOnlineGetDomainCombinationsResultInfo
        • AsiaOnlineGetLanguagePairCodeResultInfo
        • AsiaOnlineGetProjectIdsResultInfo
        • AsiaOnlineTranslateOptions
        • AsiaOnlineTranslationResultInfo
        • AsiaOnlineTranslationStatus
        • AssignmentChangeHistoryItemInfo
        • AutomatedActionStartedHistoryItemInfo
        • AutomatedActionStartedHistoryItemInfo.AutomatedActionTypes
        • BilingualDocFormat
        • CannotStartOperationFault
        • ConfirmAndUpdateDocError
        • ConfirmAndUpdateOptions
        • ConfirmAndUpdateResultInfo
        • ConfirmAndUpdateSegmentStatuses
        • ConfirmAndUpdateTaskResult
        • ConfirmAndUpdateTMBehaviors
        • ConfirmAndUpdateUserNameBehaviors
        • CorpusLanguagePair
        • CreateDeliveryResult
        • CustomPreTranslateParameter
        • DeadlineChangeHistoryItemInfo
        • DeliverDocumentFault
        • DeliverDocumentRequest
        • DocDeliveryResult
        • DocDeliveryResultInfo
        • DocumentBilingualImportHistoryItemInfo
        • DocumentDeliverHistoryItemInfo
        • DocumentExportOptions
        • DocumentHistoryItemInfo
        • DocumentHistoryItemType
        • DocumentHistoryRequest
        • DocumentImportHistoryItemInfo
        • DocumentReturnHistoryItemInfo
        • DocumentRowsLockedHistoryItemInfo
        • DocumentRowsLockedHistoryItemInfo.LockModes
        • DocumentSlicingHistoryItemInfo
        • DocumentSnapshotCreatedHistoryItemInfo
        • DocumentStatus
        • DocumentXTranslationHistoryItemInfo
        • ExpectedFinalStateAfterXTranslate
        • ExpectedSourceStateBeforeXTranslate
        • FileResultInfo
        • FirstAcceptAcceptHistoryItemInfo
        • FirstAcceptAssignHistoryItemInfo
        • FirstAcceptDeclineHistoryItemInfo
        • FirstAcceptFailedHistoryItemInfo
        • FirstAcceptStatus
        • FirstAcceptUserDecision
        • GenericFault
        • GroupSourcingAssignHistoryItemInfo
        • GroupSourcingDocumentDeliverHistoryItemInfo
        • ImportImageLocalizationPackResultInfo
        • ImportTranslationDocumentOptions
        • IServerProjectService
        • ListServerProjectTranslationDocument2Options
        • ListServerProjectTranslationDocumentSliceOptions
        • ListTranslationDocumentAssignmentsOptions
        • NewRevisionScenarioOptions
        • PackageContentDocument
        • PackageContentInfo
        • PackageCreationNotAllowedFault
        • PackageDeliveryOptions
        • PackageDeliveryResult
        • PackageDeliveryResultInfo
        • PackageInfo
        • PostTransAnalysisReportForDocument
        • PostTransAnalysisReportForUser
        • PostTransAnalysisReportItem
        • PostTranslationAnalysisAsCSVResult
        • PostTranslationAnalysisAsCSVResultForLang
        • PostTranslationAnalysisOptions
        • PostTranslationAnalysisReportInfo
        • PostTranslationAnalysisResultInfo
        • PostTranslationAnalysisTaskResult
        • PostTranslationReportCounts
        • PostTranslationResultForLang
        • PreparePackageResultInfo
        • PreTransFilter
        • PretranslateCopySourceToTargetBehavior
        • PretranslateCopySourceToTargetConditions
        • PretranslateExpectedFinalTranslationState
        • PretranslateLookupBehavior
        • PretranslateOptions
        • PreTranslateProblem
        • PretranslateStateToConfirmAndLock
        • PreTranslateTaskResult
        • PreviewCreation
        • ProjectLaunchedHistoryItemInfo
        • QAReport
        • QAReportForDocument
        • QAReportTypes
        • ReconsolidateDocumentFault
        • ReimportDocumentOptions
        • RenameProjectFault
        • ResultInfo
        • ResultStatus
        • RtfBilingualExportOptions
        • RunQAGetReportOptions
        • RunQATaskResult
        • ServerProjectAddLanguageInfo
        • ServerProjectCommunicationSettings
        • ServerProjectConfidentialitySettings
        • ServerProjectCorporaAssignments
        • ServerProjectCreateInfo
        • ServerProjectDesktopDocsCreateInfo
        • ServerProjectInfo
        • ServerProjectListFilter
        • ServerProjectNotificationSettings
        • ServerProjectPackageResourceHandlingOptions
        • ServerProjectResourceAssignment
        • ServerProjectResourceAssignmentDetails
        • ServerProjectResourceAssignmentForResourceType
        • ServerProjectResourcesInPackages
        • ServerProjectRoles
        • ServerProjectStatus
        • ServerProjectTBAssignments
        • ServerProjectTBsForTargetLang
        • ServerProjectTMAssignmentDetails
        • ServerProjectTMAssignmentsForTargetLang
        • ServerProjectTranslationDocBasicInfo
        • ServerProjectTranslationDocInfo
        • ServerProjectTranslationDocInfo2
        • ServerProjectTranslationDocSliceInfo
        • ServerProjectTranslationDocumentsDifferentLanguageTranslations
        • ServerProjectTranslationDocumentsFromSameSourceFile
        • ServerProjectTranslationDocumentUserAssignments
        • ServerProjectTranslationDocumentWorkflowStatusChange
        • ServerProjectUpdateInfo
        • ServerProjectUserInfo
        • ServerProjectUserInfoHeader
        • SetDocumentWorkflowStatusFault
        • SetTranslationDocumentAssignmentsOptions
        • SliceDocumentFault
        • SliceDocumentRequest
        • SlicingMeasurementUnit
        • StatisticsAlgorithm
        • StatisticsOptions
        • StatisticsResultForLang
        • StatisticsResultFormat
        • StatisticsResultInfo
        • StatisticsTaskResult
        • SubvendorAssignDeadlineChangeHistoryItemInfo
        • SubvendorAssignHistoryItemInfo
        • TemplateBasedProjectCreateInfo
        • TemplateBasedProjectCreationFault
        • TemplateBasedProjectCreationInvalidMetaFault
        • TemplateBasedProjectCreationResultInfo
        • TranslationDocExportResultInfo
        • TranslationDocImportResultInfo
        • TranslationDocumentAssigneeInfo
        • TranslationDocumentAssignmentFault
        • TranslationDocumentAssignmentInfo
        • TranslationDocumentAssignmentResultInfo
        • TranslationDocumentAssignments
        • TranslationDocumentAssignmentType
        • TranslationDocumentDetailedAssignmentInfo
        • TranslationDocumentDetailedAssignments
        • TranslationDocumentDetailedFirstAcceptAssignmentInfo
        • TranslationDocumentDetailedGroupSourcingAssignmentInfo
        • TranslationDocumentDetailedRoleAssignmentInfo
        • TranslationDocumentDetailedSingleUserAssignmentInfo
        • TranslationDocumentDetailedSubvendorAssignmentInfo
        • TranslationDocumentFirstAcceptAssignmentInfo
        • TranslationDocumentFirstAcceptUserInfo
        • TranslationDocumentGroupSourcingAssignmentInfo
        • TranslationDocumentGroupSourcingUserInfo
        • TranslationDocumentNoUserAssignmentInfo
        • TranslationDocumentRoleAssignmentInfo
        • TranslationDocumentRoleAssignmentResultInfo
        • TranslationDocumentSingleUserAssignmentInfo
        • TranslationDocumentSubvendorAssignmentInfo
        • TranslationDocumentUserRoleAssignment
        • TranslationDocumentUserRoleAssignmentDetails
        • TwoColumnRtfBilingualExportOptions
        • UnexpectedFault
        • UpdateWithTableRtfOptions
        • UserInfoHeader
        • WorkflowStatus
        • WorkflowStatusChangeHistoryItemInfo
        • WorkingTMsDeletedHistoryItemInfo
        • WrapUpProjectFault
        • XliffBilingualExportOptions
        • XTranslateDocInfo
        • XTranslateDocumentResult
        • XTranslateOptions
        • XTranslateResultInfo
        • XTranslateScenario
        • XTranslateTaskResult
    • Security API
      • Overview
      • Users, groups, permissions
      • Session management
      • ISecurityService
      • API
        • GenericFault
        • GroupInfo
        • ISecurityService
        • ObjectPermission
        • UnexpectedFault
        • UserInfo
        • UserPackageWorkflowType
        • WeakPasswordFault
    • File upload/download API
      • Overview
      • IFileManagerService
      • API
        • GenericFault
        • IFileManagerService
        • UnexpectedFault
    • License (ELM) API
      • Overview
      • IELMService
      • API
        • ELMAssignment
        • ELMAssignmentType
        • ELMFault
        • ELMPermission
        • ELMPoolInfo
        • ELMProduct
        • ELMProjectPermission
        • GenericFault
        • IELMService
        • UnexpectedFault
    • Tasks API
      • Overview
      • ITasksService
      • API
        • GenericFault
        • ITasksService
        • TaskDoesNotExistFault
        • TaskInfo
        • TaskNotFinishedFault
        • TaskResult
        • TaskStatus
        • UnexpectedFault
    • Changelog

    Testing the API configuration

    MemoQServicesClient is a Windows Forms application that is bundled with this documentation in source code form. This tool can be used to test connectivity and certain functions of the WS API, and the source code should provide examples and directions for development. The main window of the application has the following main menu items:

    • TM: It has submenus to test TM functionality (such as listing TMs, creating a TM, importing into a TM and so on);
    • TB: It has submenus to test TB functionality (such as listing TBs, creating a TB, importing into a TB and so on);
    • Security: It has submenus to test Security functionality (such as creating/listing users/groups, assigning users to groups, managing permissions, and so on)

    The results of the operations are logged in a readable format in the main window:

    image

    It is important to remember that if you change the base address of the API services, then you have to change the endpoint addresses in MemoQServicesClient.exe.config for the test client tool.

    If you would like to use https, then you have to use the binding configuration CommonBindingConfig_Secure.

    The MemoQServicesClient tool demonstrates some aspects of the Translation Memory, Term base and Security API. Other APIs are not covered.

    Back to top memoQ Server API documentation