• Introduction
  • Web Service API
  • Callback service
Search Results for

    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
        • TmxImportSettings
        • 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
        • AggregatedLqaStatistics
        • AnalysisAsCSVResult
        • AnalysisAsCSVResultForLang
        • AnalysisOptions
        • AnalysisReportCounts
        • AnalysisReportForDocument
        • AnalysisReportInfo
        • AnalysisReportItem
        • AnalysisResultForLang
        • AnalysisResultInfo
        • AsiaOnlineBeginTranslationResultInfo
        • AsiaOnlineDomainCombination
        • AsiaOnlineGetDomainCombinationsResultInfo
        • AsiaOnlineGetLanguagePairCodeResultInfo
        • AsiaOnlineGetProjectIdsResultInfo
        • AsiaOnlineTranslateOptions
        • AsiaOnlineTranslationResultInfo
        • AsiaOnlineTranslationStatus
        • AssignmentChangeHistoryItemInfo
        • AutomatedActionStartedHistoryItemInfo
        • AutomatedActionStartedHistoryItemInfo.AutomatedActionTypes
        • AutoSplitJoinSettings
        • BilingualDocFormat
        • CannotStartOperationFault
        • ConfirmAndUpdateDocError
        • ConfirmAndUpdateOptions
        • ConfirmAndUpdateResultInfo
        • ConfirmAndUpdateSegmentStatuses
        • ConfirmAndUpdateTaskResult
        • ConfirmAndUpdateTMBehaviors
        • ConfirmAndUpdateUserNameBehaviors
        • CorpusLanguagePair
        • CreateDeliveryResult
        • CreateStatisticsOnDocumentsRequest
        • CreateStatisticsOnProjectRequest
        • CreateStatisticsRequestBase
        • CsvSeparator
        • CustomPreTranslateParameter
        • DeadlineChangeHistoryItemInfo
        • DeliverDocumentFault
        • DeliverDocumentRequest
        • DistanceMeasurementMode
        • DocDeliveryResult
        • DocDeliveryResultInfo
        • DocumentAssignmentRoleId
        • DocumentBilingualImportHistoryItemInfo
        • DocumentDeliverHistoryItemInfo
        • DocumentExportOptions
        • DocumentHistoryItemInfo
        • DocumentHistoryItemType
        • DocumentHistoryRequest
        • DocumentImportHistoryItemInfo
        • DocumentLqaRejectedSegments
        • DocumentLqaStatistics
        • DocumentReturnHistoryItemInfo
        • DocumentRowsLockedHistoryItemInfo
        • DocumentRowsLockedHistoryItemInfo.LockModes
        • DocumentSlicingHistoryItemInfo
        • DocumentSnapshotCreatedHistoryItemInfo
        • DocumentStatus
        • DocumentXTranslationHistoryItemInfo
        • EditDistanceCsvResult
        • EditDistanceReportInfo
        • EditDistanceStatisticsOptions
        • ExpectedFinalStateAfterXTranslate
        • ExpectedSourceStateBeforeXTranslate
        • FileResultInfo
        • FirstAcceptAcceptHistoryItemInfo
        • FirstAcceptAssignHistoryItemInfo
        • FirstAcceptDeclineHistoryItemInfo
        • FirstAcceptFailedHistoryItemInfo
        • FirstAcceptStatus
        • FirstAcceptUserDecision
        • FragmentAssemblySettings
        • FuzzyEditDistanceReport
        • FuzzyEditDistanceResult
        • FuzzyEditDistanceResultForDocument
        • FuzzyEditDistanceResultForLang
        • FuzzyEditDistanceTaskResult
        • GenericFault
        • GroupSourcingAssignHistoryItemInfo
        • GroupSourcingDocumentDeliverHistoryItemInfo
        • ImportImageLocalizationPackResultInfo
        • ImportTranslationDocumentOptions
        • IServerProjectService
        • LevenshteinEditDistanceReport
        • LevenshteinEditDistanceResult
        • LevenshteinEditDistanceResultForDocument
        • LevenshteinEditDistanceResultForLang
        • LevenshteinEditDistanceTaskResult
        • ListServerProjectTranslationDocument2Options
        • ListServerProjectTranslationDocumentSliceOptions
        • ListTranslationDocumentAssignmentsOptions
        • LockUnlockSegmentsAction
        • LockUnlockSegmentsCondition
        • LockUnlockSegmentsOptions
        • LqaCorrection
        • LqaModelBaseInfo
        • LqaModelStatisticsSummary
        • LqaRejectedSegment
        • LqaRejectedSegmentsOptions
        • LqaRejectedSegmentsReport
        • LqaRejectedSegmentsTaskResult
        • LqaRejection
        • LqaRejectionType
        • LQAResult
        • LqaStatisticsExportFormat
        • LqaStatisticsGenerationOptions
        • LqaStatisticsReport
        • LqaStatisticsTaskResult
        • MatchCoverageType
        • NewRevisionScenarioOptions
        • NumberOfErrorsForSeverity
        • NumberOfErrorsPerSeveritiesForCategory
        • OptionsForAllRowsThatMatchACertainCondition
        • OptionsForRowsInDifferentLanguage
        • PackageContentDocument
        • PackageContentInfo
        • PackageCreationNotAllowedFault
        • PackageDeliveryOptions
        • PackageDeliveryResult
        • PackageDeliveryResultInfo
        • PackageImportOptions
        • PackageInfo
        • PackageType
        • PenaltyPointsForCategory
        • PostTransAnalysisReportForDocument
        • PostTransAnalysisReportForUser
        • PostTransAnalysisReportItem
        • PostTranslationAnalysisAsCSVResult
        • PostTranslationAnalysisAsCSVResultForLang
        • PostTranslationAnalysisOptions
        • PostTranslationAnalysisReportInfo
        • PostTranslationAnalysisResultInfo
        • PostTranslationAnalysisTaskResult
        • PostTranslationReportCounts
        • PostTranslationResultForLang
        • PreparePackageResultInfo
        • PreTransFilter
        • PretranslateCopySourceToTargetBehavior
        • PretranslateCopySourceToTargetConditions
        • PretranslateExpectedFinalTranslationState
        • PretranslateLookupBehavior
        • PretranslateOptions
        • PreTranslateProblem
        • PretranslateStateToConfirmAndLock
        • PreTranslateTaskResult
        • PreviewCreation
        • ProjectLaunchedHistoryItemInfo
        • ProjectLqaStatistics
        • QAReport
        • QAReportForDocument
        • QAReportTypes
        • ReconsolidateDocumentFault
        • ReimportDocumentOptions
        • RenameProjectFault
        • ResultInfo
        • ResultStatus
        • RtfBilingualExportOptions
        • RunQAGetReportOptions
        • RunQATaskResult
        • SegmentStatuses
        • ServerProjectAddLanguageInfo
        • ServerProjectCommunicationSettings
        • ServerProjectConfidentialitySettings
        • ServerProjectCorporaAssignments
        • ServerProjectCreateInfo
        • ServerProjectDesktopDocsCreateInfo
        • ServerProjectInfo
        • ServerProjectListFilter
        • ServerProjectNotificationSettings
        • ServerProjectPackageDetails
        • 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
        • TMLanguagePair
        • 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
        • TurnOffAutoPilotFault
        • TwoColumnRtfBilingualExportOptions
        • UnexpectedFault
        • UpdateWithTableRtfOptions
        • UserInfoHeader
        • WordCountMode
        • 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
    • ICR configuration API
      • Overview
      • IIcrConfigService
      • API
        • DefaultDisplayConfig
        • GenericFault
        • IcrConfig
        • IcrConfigCreate
        • IcrConfigMeta
        • IcrResources
        • IcrSettings
        • IIcrConfigService
        • NoLicenseFault
        • QACategoriesConfig
        • QAConfig
        • UnexpectedFault
    • Changelog

    Class ServerProjectTranslationDocInfo

    Represents information about a server project translation document.

    Inheritance
    System.Object
    ServerProjectTranslationDocInfo
    Syntax
    public class ServerProjectTranslationDocInfo
    Remarks

    It does not contain detailed information about the FirstAccept, GroupSourcing and subvendor assignments. These information is covered by the ServerProjectTranslationDocInfo2 class.

    Fields

    ConfirmedCharacterCount

    The total number of characters in confirmed segments of the document.

    Declaration
    public int ConfirmedCharacterCount
    Type
    System.Int32

    ConfirmedSegmentCount

    The total number of confirmed segments in the document.

    Declaration
    public int ConfirmedSegmentCount
    Type
    System.Int32

    ConfirmedWordCount

    The total number of words in confirmed segments of the document.

    Declaration
    public int ConfirmedWordCount
    Type
    System.Int32

    DocumentGuid

    The Guid of the document that uniquely identifies the document within a server project. Two documents within two separate projects can have the same Guid: e.g. exporting a bilingual doc from projectA, and then importing it into projectB the two documents will have the same Guid (it is preserved during a bilingual export/import).

    Declaration
    public Guid DocumentGuid
    Type
    System.Guid

    DocumentName

    The name of the document. Unique within a project for a specific target language. This is the name of the uploaded file without the extension. E.g.: "mydoc" for the uploaded doc "mydoc.txt". If a file is imported into a project with a name that conflicts with the name of an existing project document, then a number is appended to the name of the newly imported document. E.g. if documents with name "mydoc" and "mydoc1" exist within a project, then the importing of a file with name "mydoc.rtf" will have the "mydoc2" name.

    Declaration
    public string DocumentName
    Type
    System.String

    DocumentStatus

    The status of the document.

    Declaration
    public DocumentStatus DocumentStatus
    Type
    DocumentStatus

    ExportPath

    The default export path of the document. The path is determined by the Export Path rules associated to the project at the time of document import. The value is null if the document was imported through the webservice.

    Declaration
    public string ExportPath
    Type
    System.String

    ExternalDocumentId

    An identifier of this document which was provided by the caller when importing the document. The value is not created by memoQ; it comes from the caller of the WS API import. Null when not specified during import, or document not imported via the WS API.

    Declaration
    public string ExternalDocumentId
    Type
    System.String

    ImportPath

    The path the document was imported from.

    Declaration
    public string ImportPath
    Type
    System.String

    IsImage

    True if the document is an image file, false otherwise. Images can be imported into projects and translated, but they require a transcription first. Images are exported into an image localization package and after localization the package is imported back (see ServerProjectService. CreateImageLocalizationPack).

    Declaration
    public bool IsImage
    Type
    System.Boolean

    LockedCharacterCount

    The total number of characters in locked segments of the document.

    Declaration
    public int LockedCharacterCount
    Type
    System.Int32

    LockedSegmentCount

    The total number of locked segments in the document.

    Declaration
    public int LockedSegmentCount
    Type
    System.Int32

    LockedWordCount

    The total number of words in locked segments of the document.

    Declaration
    public int LockedWordCount
    Type
    System.Int32

    MajorVersion

    The documents current major version number if the document has recorded version history; -1 otherwise.

    Declaration
    public int MajorVersion
    Type
    System.Int32

    MinorVersion

    The documents current minor version number if the document has recorded version history; -1 otherwise.

    Declaration
    public int MinorVersion
    Type
    System.Int32

    ParentDocumentId

    Contains the unique identifier of the document which is the "parent" document of this one. When embedded objects are imported (e.g. an Excel spreadsheet embedded in a Word file), these documents are losely connected. Embedded objects are treated as separate documents, but certain operations link them to their parent (e.g. removing a document will remove all of its "children" too). This member contains the id of the parent document for child documents; e.g. the id of the Word document if this document is the embedded spreadsheet in it. Value is empty Guid (all zeros) for documents without a parent (most documents which are not embedded objects).

    Declaration
    public Guid ParentDocumentId
    Type
    System.Guid

    ProofreadCharacterCount

    The total number of characters in proofred segments of the document.

    Declaration
    public int ProofreadCharacterCount
    Type
    System.Int32

    ProofreadSegmentCount

    The total number of proofred segments in the document.

    Declaration
    public int ProofreadSegmentCount
    Type
    System.Int32

    ProofreadWordCount

    The total number of words in proofred segments of the document.

    Declaration
    public int ProofreadWordCount
    Type
    System.Int32

    Reviewer1ConfirmedCharacterCount

    The total number of characters in reviewer 1 confirmed segments of the document.

    Declaration
    public int Reviewer1ConfirmedCharacterCount
    Type
    System.Int32

    Reviewer1ConfirmedSegmentCount

    The total number of reviewer1 confirmed segments in the document.

    Declaration
    public int Reviewer1ConfirmedSegmentCount
    Type
    System.Int32

    Reviewer1ConfirmedWordCount

    The total number of words in reviewer 1 confirmed segments of the document.

    Declaration
    public int Reviewer1ConfirmedWordCount
    Type
    System.Int32

    TargetLangCode

    The three+(two) letter code of the target language of the document. (such as fre, eng, eng-US).

    Declaration
    public string TargetLangCode
    Type
    System.String

    TotalCharacterCount

    The total number of characters in the document, including the number of characters in locked segments.

    Declaration
    public int TotalCharacterCount
    Type
    System.Int32

    TotalSegmentCount

    The total number of segments in the document, including the number of locked segments.

    Declaration
    public int TotalSegmentCount
    Type
    System.Int32

    TotalWordCount

    The total number of words in the document, including the number of words in locked segments.

    Declaration
    public int TotalWordCount
    Type
    System.Int32

    UserAssignments

    The users assigned to the translation document with their document assignment role and deadline.

    Declaration
    public TranslationDocumentUserRoleAssignmentDetails[] UserAssignments
    Type
    TranslationDocumentUserRoleAssignmentDetails[]
    Remarks

    It does not contain information about the FirstAccept, GroupSourcing and subvendor group assignments. It is covered by the.ServerProjectTranslationDocInfo2 class.

    WebTransUrl

    The memoQWebTrans URL to open and edit this document. This URL is filled only when (1) the server has webTrans license, (2) memoQWebTrans URL is set in memoQ Server, and (3) the project is enabled for web access. The value is null or empty string otherwise.

    Declaration
    public string WebTransUrl
    Type
    System.String

    WeightedChars

    The weighted character count of the document. The value may not be available (if there is no analysis available for the document), in which case the value is -1.

    Declaration
    public float WeightedChars
    Type
    System.Single

    WeightedWords

    The weighted word count of the document. The value may not be available (if there is no analysis available for the document), in which case the value is -1.

    Declaration
    public float WeightedWords
    Type
    System.Single

    WorkflowStatus

    The workflow status of the document.

    Declaration
    public WorkflowStatus WorkflowStatus
    Type
    WorkflowStatus
    In This Article
    Back to top WS API documentation