Interface IServerProjectService

This interface has operations for server project management.

Syntax

public interface IServerProjectService

Methods

AddLanguageToProject(Guid, ServerProjectAddLanguageInfo)

Adds a new target language to the server project.

Declaration

void AddLanguageToProject(Guid serverProjectGuid, ServerProjectAddLanguageInfo addLanguageInfo)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
ServerProjectAddLanguageInfo	addLanguageInfo	Encapsulates the parameters of adding the new target language to the server projects.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
AddProjectLanguageFault	Some of the project term bases does not contain all the project languages.

AddTranslatedDocumentToLiveDocsCorpus(Guid, Guid, Guid)

Adds a translated document (from a server project) to an existing LiveDocs corpus (to be used as a reference file).

Declaration

void AddTranslatedDocumentToLiveDocsCorpus(Guid serverProjectGuid, Guid documentGuid, Guid corpusId)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
Guid	documentGuid	The id of the document in the project.
Guid	corpusId	The id of the corpus to add the document to.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
CannotStartOperationFault	The operation cannot be executed due to a concurrent conflicting action in progress.

AsiaOnlineBeginTranslation(Guid, Guid[], AsiaOnlineTranslateOptions)

Submits the specified documents of the server project to Asia Online translation. The translation is an asynchronous operation, this operation submits the documents to Asia Online services, but does not wait for the process to complete. Use AsiaOnlineGetTranslationStatus to query the status of the operation.

Declaration

AsiaOnlineBeginTranslationResultInfo[] AsiaOnlineBeginTranslation(Guid serverProjectGuid, Guid[] documentGuids, AsiaOnlineTranslateOptions options)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
Guid[]	documentGuids	The Guids of the documents to be pretranslated.
AsiaOnlineTranslateOptions	options	The options of the AO translate process.

Returns

Type	Description
AsiaOnlineBeginTranslationResultInfo[]	The AsiaOnlineBeginTranslationResultInfo for each document, providing information about the success or failure of the operation for the particular document.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

AsiaOnlineGetDomainCombinations(Int32)

Gets the supported domain combinations of the specified Asia Online language pair code.

Declaration

AsiaOnlineGetDomainCombinationsResultInfo AsiaOnlineGetDomainCombinations(int languagePairCode)

Parameters

Type	Name	Description
Int32	languagePairCode	The Asia Online language pair code.

Returns

Type	Description
AsiaOnlineGetDomainCombinationsResultInfo	The AsiaOnlineGetDomainCombinationsResultInfo object providing information about the operation. If the operation succeeded, contains the list of supported domain combinations.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

AsiaOnlineGetLanguagePairCode(String, String)

Gets the language pair code, as used by Asia Online, for the specified source and target language pair.

Declaration

AsiaOnlineGetLanguagePairCodeResultInfo AsiaOnlineGetLanguagePairCode(string memoQSourceLangCode, string memoQTargetLangCode)

Parameters

Type	Name	Description
String	memoQSourceLangCode	The source language code, as language codes used by memoQ. The same as the source language of the project.
String	memoQTargetLangCode	The target language code, as language codes used by memoQ. The same as the target language of the project.

Returns

Type	Description
AsiaOnlineGetLanguagePairCodeResultInfo	The AsiaOnlineGetLanguagePairCodeResultInfo object providing information about the operation. If the operation succeeded, contains the Asia Online language pair code.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

AsiaOnlineGetProjectIds()

Gets the project IDs belonging to the current user.

Declaration

AsiaOnlineGetProjectIdsResultInfo AsiaOnlineGetProjectIds()

Returns

Type	Description
AsiaOnlineGetProjectIdsResultInfo	An array of integers contains the project IDs belonging to a user.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

AsiaOnlineGetTranslationStatus(Guid)

Gets the status of Asia Online translation operations for a specific server project. Lists the status for each document that was submitted for translation to Asia Online in the specified server project.

Declaration

AsiaOnlineTranslationResultInfo[] AsiaOnlineGetTranslationStatus(Guid serverProjectGuid)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.

Returns

Type	Description
AsiaOnlineTranslationResultInfo[]	An array or AsiaOnlineTranslationResultInfo objects, for each document in the server project that was submitted for translation to Asia Online.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

ConfirmAndUpdate(String, Guid, Guid[], ConfirmAndUpdateOptions)

OBSOLETE, use ConfirmAndUpdate2(Guid, Guid, Guid[], ConfirmAndUpdateOptions) instead Confirms and updates rows of the specified documents and slices in the specified server project.

Declaration

ConfirmAndUpdateResultInfo ConfirmAndUpdate(string sessionId, Guid serverProjectGuid, Guid[] translationDocGuids, ConfirmAndUpdateOptions options)

Parameters

Type	Name	Description
String	sessionId	The session id belonging to the user who performs the confirm operation. This user's user name is used when the server updates the stauses of the segments. If the UserNameBehavior is UseProjectDefault in the options parameter, the server uses this user's name as creator/modifier when updating the translation memories.
Guid	serverProjectGuid	The guid of the server project.
Guid[]	translationDocGuids	The guids of the documents and slices to confirm and update.
ConfirmAndUpdateOptions	options	The options of the confirm and update process.

Returns

Type	Description
ConfirmAndUpdateResultInfo	The ResultInfo object providing information about the success or failure of the operation.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
CannotStartOperationFault	The operation cannot be executed due to a concurrent conflicting action in progress.

ConfirmAndUpdate2(Guid, Guid, Guid[], ConfirmAndUpdateOptions)

Confirms and updates rows of the specified documents and slices in the specified server project. Also available in an asynchronous task fashion: StartConfirmAndUpdateTask(Guid, Guid, Guid[], ConfirmAndUpdateOptions)

Declaration

ConfirmAndUpdateResultInfo ConfirmAndUpdate2(Guid userGuid, Guid serverProjectGuid, Guid[] translationDocGuids, ConfirmAndUpdateOptions options)

Parameters

Type	Name	Description
Guid	userGuid	The guid of to the user who performs the confirm and update operation. This user's user name is used when the server updates the statuses of the segments. If the UserNameBehavior is UseProjectDefault in the options parameter, the server uses this user's name as creator/modifier when updating the translation memories.
Guid	serverProjectGuid	The guid of the server project.
Guid[]	translationDocGuids	The guids of the documents and slices to confirm and update.
ConfirmAndUpdateOptions	options	The options of the confirm and update process.

Returns

Type	Description
ConfirmAndUpdateResultInfo	The ResultInfo object providing information about the success or failure of the operation.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
CannotStartOperationFault	The operation cannot be executed due to a concurrent conflicting action in progress.

CreateDeliveryPackage(Guid, Guid[], Boolean)

Creates a delivery package from a project that was created from a package. The specified documents are exported as a delivery package.

Declaration

CreateDeliveryResult CreateDeliveryPackage(Guid projectGuid, Guid[] documentGuids, bool returnToPreviousActor)

Parameters

Type	Name	Description
Guid	projectGuid	The identifier of the project.
Guid[]	documentGuids	The identifiers of the documents to include in the delivery.
Boolean	returnToPreviousActor	True to return the documents to the previous actor for review; false to deliver the documents and move them to the next workflow state.

Returns

Type	Description
CreateDeliveryResult	An object describing the results of the operation.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
CannotStartOperationFault	The operation cannot be executed due to a concurrent conflicting action in progress.

CreateImageLocalizationPack(Guid, Guid[])

Creates an image localization package from the image documents of the projects. The package contains the images for localization and the instructions for the localizer. The result of the operation is a downloadable zip file. The localization pack is bilingual, that it, it contains the images in the source language, and is translated to a single target language. Therefore the documents must be of the same target language and all documents must be images (see IsImage property of ServerProjectTranslationDocInfo).

Declaration

FileResultInfo CreateImageLocalizationPack(Guid serverProjectGuid, Guid[] documentGuids)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The identifier of the project.
Guid[]	documentGuids	The documents of the project to create the localization pack from. Must be all images and must be of the same target language.

Returns

Type	Description
FileResultInfo	The FileResultInfo providing information about the result of the operation. In case of success, it holds guid of the resulting file. The file can be downloaded using IFileManagerService and related operations.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
CannotStartOperationFault	The operation cannot be executed due to a concurrent conflicting action in progress.

CreateProject(ServerProjectCreateInfo)

OBSOLETE, identical behavior with CreateProject2(ServerProjectDesktopDocsCreateInfo) Creates a new server project.

Declaration

Guid CreateProject(ServerProjectCreateInfo spInfo)

Parameters

Type	Name	Description
ServerProjectCreateInfo	spInfo	The class encapsulating every information required to create a new server project. If the type of te object is ServerProjectCreateInfo a server project with Server Documents is created, while a Desktop Documents project is created if the type of the object is ServerProjectDesktopDocsCreateInfo. The user identified by the CreatorUser member of the spInfo parameter is automatically added to the project with the Project Manager role.

Returns

Type	Description
Guid	The guid of the newly created server project.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

CreateProject2(ServerProjectDesktopDocsCreateInfo)

Creates a new server project.

Declaration

Guid CreateProject2(ServerProjectDesktopDocsCreateInfo spInfo)

Parameters

Type	Name	Description
ServerProjectDesktopDocsCreateInfo	spInfo	The class encapsulating every information required to create a new server project. The user identified by the CreatorUser member of the spInfo parameter is automatically added to the project with the Project Manager role.

Returns

Type	Description
Guid	The guid of the newly created server project.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

CreateProjectFromPackage(ServerProjectCreateInfo, Guid)

OBSOLETE, will be removed in a future version, use instead. Creates a new project from a package. The documents from the package are imported into the newly created project.

Declaration

Guid CreateProjectFromPackage(ServerProjectCreateInfo createInfo, Guid fileId)

Parameters

Type	Name	Description
ServerProjectCreateInfo	createInfo	The class encapsulating every information required to create a new server project. If the type of te object is ServerProjectCreateInfo a server project with Server Documents is created, while a Desktop Documents project is created if the type of the object is ServerProjectDesktopDocsCreateInfo. The user identified by the CreatorUser member of the spInfo parameter is automatically added to the project with the Project Manager role.
Guid	fileId	The file id of the package to import. Should be uploaded usign FileManagerService. The package must be an initial handoff package and cannot be an update package.

Returns

Type	Description
Guid	The guid of the newly created server project.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

CreateProjectFromPackage2(ServerProjectDesktopDocsCreateInfo, Guid)

OBSOLETE, will be removed in a future version, use instead. Creates a new project from a package. The documents from the package are imported into the newly created project. Resources are not imported from the package (except for linked TMs and TBs, which are always imported).

Declaration

Guid CreateProjectFromPackage2(ServerProjectDesktopDocsCreateInfo createInfo, Guid fileId)

Parameters

Type	Name	Description
ServerProjectDesktopDocsCreateInfo	createInfo	The class encapsulating every information required to create a new server project. These members are ignored (information is taken from the package instead): SourceLanguageCode, TargetLanguageCodes, StrictSubLangMatching, OmitHitsWithNoTargetTerm. The user identified by the CreatorUser member of the spInfo parameter is automatically added to the project with the Project Manager role.
Guid	fileId	The file id of the package to import. Should be uploaded usign FileManagerService. The package must be an initial handoff package and cannot be an update package.

Returns

Type	Description
Guid	The guid of the newly created server project.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

CreateProjectFromPackage3(ServerProjectDesktopDocsCreateInfo, Guid, PackageImportOptions)

Creates a new project from a package. The documents from the package are imported into the newly created project.

Declaration

Guid CreateProjectFromPackage3(ServerProjectDesktopDocsCreateInfo createInfo, Guid fileId, PackageImportOptions importOptions)

Parameters

Type	Name	Description
ServerProjectDesktopDocsCreateInfo	createInfo	The class encapsulating every information required to create a new server project. These members are ignored (information is taken from the package instead): SourceLanguageCode, TargetLanguageCodes, StrictSubLangMatching, OmitHitsWithNoTargetTerm. The user identified by the CreatorUser member of the spInfo parameter is automatically added to the project with the Project Manager role.
Guid	fileId	The file id of the package to import. Should be uploaded usign FileManagerService. The package must be an initial handoff package and cannot be an update package.
PackageImportOptions	importOptions	The class encapsulates options controlling how the package is to be imported.

Returns

Type	Description
Guid	The guid of the newly created server project.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

CreateProjectFromTemplate(TemplateBasedProjectCreateInfo)

Creates a new server project based on a template.

Declaration

TemplateBasedProjectCreationResultInfo CreateProjectFromTemplate(TemplateBasedProjectCreateInfo createInfo)

Parameters

Type	Name	Description
TemplateBasedProjectCreateInfo	createInfo	The class encapsulating every information required to create a new server project based on a template. The user identified by the CreatorUser member of the spInfo parameter is automatically added to the project with the Project Manager role.

Returns

Type	Description
TemplateBasedProjectCreationResultInfo	The guid of the newly created server project.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
TemplateBasedProjectCreationFault	See the errorcode for the specific problem: ProjectNameNotSpecified: The name of the project is not specified. SourceLanguageNotSpecified: The source language of the project is not specified. TargetLanguagesNotSpecified: The target languages of the project are not specified. ProjectNotSpecified: The project meta of the project is not specified. ClientNotSpecified: The client meta of the project is not specified. DomainNotSpecified: The domain meta of the project is not specified. SubjectNotSpecified: The subject meta of the project is not specified. AmbiguousWorkingTMNamingRule: The working TM naming rule is ambiguous. AmbiguousMasterTMNamingRule: The master TM naming rule is ambiguous.
TemplateBasedProjectCreationInvalidMetaFault	ProjectIsNotInThePredefinedSet: The project meta is not in the pre-defined set defined in the template. ClientIsNotInThePredefinedSet: The client meta is not in the pre-defined set defined in the template. DomainIsNotInThePredefinedSet: The domain meta is not in the pre-defined set defined in the template. SubjectIsNotInThePredefinedSet: The subject meta is not in the pre-defined set defined in the template.

DeleteProject(Guid)

Deletes the specified project. Also available in an asynchronous task fashion: StartDeleteProjectTask(Guid)

Declaration

void DeleteProject(Guid serverProjectGuid)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project to be deleted.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
CannotStartOperationFault	The requested operation cannot be executed because there is a concurrent conflicting action in progress.

DeleteTranslationDocument(Guid, Guid)

Deletes the specified translation document.

Declaration

void DeleteTranslationDocument(Guid serverProjectGuid, Guid documentGuid)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
Guid	documentGuid	The Guid of the document, that uniquely identifies a document within a server project.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

DeliverDocument(Guid, DeliverDocumentRequest)

Delivers a document or a slice (returns them to the previous actor or to the next person in the assignment chain) by a user to whom the document is assigned. Delivery requires all segments to be confirmed/ proofread. Throws exception if the document or slice is not assigned to the delivering user or if the document or slice cannot be delivered because not all segments are confirmed/proofread. Also throws exception if there is no previous actor to whom the document or slice is to be returned. Throws if the project's PreventDeliveryOnQAError flag is true and the document or slice contains QA errors.

Declaration

WorkflowStatus DeliverDocument(Guid serverProjectGuid, DeliverDocumentRequest deliveryOption)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
DeliverDocumentRequest	deliveryOption	The delivery options.

Returns

Type	Description
WorkflowStatus	The new workflow status of the document or slice.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
CannotStartOperationFault	The operation cannot be executed due to a concurrent conflicting action in progress.
DeliverDocumentFault	The operation is not valid on a document because it is sliced.

DeliverPackage(Guid)

Delivers a package, processes its content, and reports the result of the delivery. The delivery package must be uploaded using FileManagerService and the identifier of the file returned by FileManagerService given as the fileGuid. The result of the delivery can be failure for various reasons globally, and also on a document level. Detailed report is returned by the operation.

Declaration

PackageDeliveryResultInfo DeliverPackage(Guid fileGuid)

Parameters

Type	Name	Description
Guid	fileGuid	The identifier of the delivery file uploaded using FileManagerService.

Returns

Type	Description
PackageDeliveryResultInfo	A packageDeliveryResultInfo object which describes the result of the delivery in details.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
CannotStartOperationFault	The operation cannot be executed due to a concurrent conflicting action in progress.

DistributeProject(Guid)

Distributes a project and sends out notifications to the members of the project. Also available in an asynchronous task fashion: StartDistributeProjectTask(Guid)

Declaration

void DistributeProject(Guid serverProjectGuid)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
CannotStartOperationFault	The operation cannot be executed due to a concurrent conflicting action in progress.

ExportTranslationDocument(Guid, Guid)

Exports the translation document in its original format.

Declaration

TranslationDocExportResultInfo ExportTranslationDocument(Guid serverProjectGuid, Guid docGuid)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
Guid	docGuid	The unique identifier of the document, the DocumentGuid property of the ServerProjectTranslationDocInfo instance which represents the document.

Returns

Type	Description
TranslationDocExportResultInfo	The TranslationDocExportResultInfo providing information about the result of the operation. In case of success or warning, it holds guid of the resulting file. The file can be downloaded using IFileManagerService.BeginChunkedFileDownload and related operations. Exporting a document which has linked child documents (see ServerProjectTranslationDocInfo.ParentDocumentId) will result in the export of all child documents as well, embedded in the parent document. Exporting a multilingual document (imported using the Multilingual filters) will result in exporting all multilingual siblings into a single result file.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
CannotStartOperationFault	The operation cannot be executed due to a concurrent conflicting action in progress.

ExportTranslationDocument2(Guid, Guid, DocumentExportOptions)

Exports the translation document in its original format.

Declaration

TranslationDocExportResultInfo ExportTranslationDocument2(Guid serverProjectGuid, Guid docGuid, DocumentExportOptions options)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
Guid	docGuid	The unique identifier of the document, the DocumentGuid property of the ServerProjectTranslationDocInfo instance which represents the document.
DocumentExportOptions	options	Options for controlling the export behavor.

Returns

Type	Description
TranslationDocExportResultInfo	The TranslationDocExportResultInfo providing information about the result of the operation. In case of success or warning, it holds guid of the resulting file. The file can be downloaded using IFileManagerService.BeginChunkedFileDownload and related operations. Exporting a document which has linked child documents (see ServerProjectTranslationDocInfo.ParentDocumentId) will result in the export of all child documents as well, embedded in the parent document.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
CannotStartOperationFault	The operation cannot be executed due to a concurrent conflicting action in progress.

ExportTranslationDocumentAsRtfBilingual(Guid, Guid, RtfBilingualExportOptions)

Exports the translation document as Trados-like RTF bilingual.

Declaration

FileResultInfo ExportTranslationDocumentAsRtfBilingual(Guid serverProjectGuid, Guid docGuid, RtfBilingualExportOptions options)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
Guid	docGuid	The unique identifier of the document, the DocumentGuid property of the ServerProjectTranslationDocInfo instance which represents the document.
RtfBilingualExportOptions	options	The options of the export.

Returns

Type	Description
FileResultInfo	The FileResultInfo providing information about the result of the operation. In case of success or warning, it holds guid of the resulting file. The file can be downloaded using IFileManagerService.BeginChunkedFileDownload and related operations.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
CannotStartOperationFault	The operation cannot be executed due to a concurrent conflicting action in progress.

ExportTranslationDocumentAsTwoColumnRtf(Guid, Guid, TwoColumnRtfBilingualExportOptions)

Exports the translation document as two-column RTF bilingual.

Declaration

FileResultInfo ExportTranslationDocumentAsTwoColumnRtf(Guid serverProjectGuid, Guid docGuid, TwoColumnRtfBilingualExportOptions options)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
Guid	docGuid	The unique identifier of the document, the DocumentGuid property of the ServerProjectTranslationDocInfo instance which represents the document.
TwoColumnRtfBilingualExportOptions	options	The options of the export.

Returns

Type	Description
FileResultInfo	The FileResultInfo providing information about the result of the operation. In case of success or warning, it holds guid of the resulting file. The file can be downloaded using IFileManagerService.BeginChunkedFileDownload and related operations.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
CannotStartOperationFault	The operation cannot be executed due to a concurrent conflicting action in progress.

ExportTranslationDocumentAsXliffBilingual(Guid, Guid, XliffBilingualExportOptions)

Exports the translation document as XLIFF bilingual.

Declaration

FileResultInfo ExportTranslationDocumentAsXliffBilingual(Guid serverProjectGuid, Guid docGuid, XliffBilingualExportOptions options)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
Guid	docGuid	The unique identifier of the document, the DocumentGuid property of the ServerProjectTranslationDocInfo instance which represents the document.
XliffBilingualExportOptions	options	The options of the export.

Returns

Type	Description
FileResultInfo	The FileResultInfo providing information about the result of the operation. In case of success or warning, it holds guid of the resulting file. The file can be downloaded using IFileManagerService.BeginChunkedFileDownload and related operations.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
CannotStartOperationFault	The operation cannot be executed due to a concurrent conflicting action in progress.

ExportTranslationDocumentsAsSingleTwoColumnRtf(Guid, Guid[], TwoColumnRtfBilingualExportOptions)

Exports the translation documents as a single two-column RTF bilingual file. (The result is a single RTF file; all specified documents are exported into this file.)

Declaration

FileResultInfo ExportTranslationDocumentsAsSingleTwoColumnRtf(Guid serverProjectGuid, Guid[] docGuids, TwoColumnRtfBilingualExportOptions options)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
Guid[]	docGuids
TwoColumnRtfBilingualExportOptions	options	The options of the export.

Returns

Type	Description
FileResultInfo	The FileResultInfo providing information about the result of the operation. In case of success or warning, it holds guid of the resulting file. The file can be downloaded using IFileManagerService.BeginChunkedFileDownload and related operations.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
CannotStartOperationFault	The operation cannot be executed due to a concurrent conflicting action in progress.

GetAnalysisReportAsCSV(Guid, Guid)

Exports an analysis report as a CSV and gets the results.

Declaration

AnalysisAsCSVResult GetAnalysisReportAsCSV(Guid serverProjectGuid, Guid reportId)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
Guid	reportId	The unique identifier of the report.

Returns

Type	Description
AnalysisAsCSVResult	An object that contains the exported report data for each language the report contains.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

GetAnalysisReportData(Guid, Guid)

Gets an analysis report.

Declaration

AnalysisResultInfo GetAnalysisReportData(Guid serverProjectGuid, Guid reportId)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
Guid	reportId	The unique identifier of the report.

Returns

Type	Description
AnalysisResultInfo	An object that encapsulates the report itself. The report is decomposed into per-language data, for each language the report was created for.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

GetApiVersion()

Gets the version of the API (that is the version of the MemoQ Server) in the following format (an example): 5.0.12 It is possible that the number increases even if the API does not have any change (when a new server is released with an unchanged API).

Declaration

string GetApiVersion()

Returns

Type	Description
String

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

GetDocumentHistory(Guid, DocumentHistoryRequest)

Returns the document history items related to the documents or slices in the specified project. The function returns the history information for all of the project documents or slices if the DocumentGuids parameter of the request parameter is null. Otherwise the function gives back only the history items related to the specified documents or slices.

Declaration

DocumentHistoryItemInfo[] GetDocumentHistory(Guid serverProjectGuid, DocumentHistoryRequest request)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
DocumentHistoryRequest	request	The document history details.

Returns

Type	Description
DocumentHistoryItemInfo[]	The history items related to the specified documents or slices.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

GetEditDistanceReportAsCsv(Guid, Guid)

Exports an edit distance report as a CSV and gets the results.

Declaration

EditDistanceCsvResult GetEditDistanceReportAsCsv(Guid projectGuid, Guid reportId)

Parameters

Type	Name	Description
Guid	projectGuid	The guid of the server project.
Guid	reportId	The unique identifier of the report.

Returns

Type	Description
EditDistanceCsvResult	An object that contains the exported report data.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

GetFuzzyEditDistanceReport(Guid, Guid)

Gets an edit distance report that were created with fuzzy distance measurement mode.

Declaration

FuzzyEditDistanceReport GetFuzzyEditDistanceReport(Guid projectGuid, Guid reportId)

Parameters

Type	Name	Description
Guid	projectGuid	The guid of the server project.
Guid	reportId	The unique identifier of the report.

Returns

Type	Description
FuzzyEditDistanceReport	An object that encapsulates the report itself. The report is decomposed into per-language data, for each language the report was created for.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

GetLevenshteinEditDistanceReport(Guid, Guid)

Gets an edit distance report that were created with levenshtein distance measurement mode.

Declaration

LevenshteinEditDistanceReport GetLevenshteinEditDistanceReport(Guid projectGuid, Guid reportId)

Parameters

Type	Name	Description
Guid	projectGuid	The guid of the server project.
Guid	reportId	The unique identifier of the report.

Returns

Type	Description
LevenshteinEditDistanceReport	An object that encapsulates the report itself. The report is decomposed into per-language data, for each language the report was created for.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

GetPackageDeliveryOptions(Guid)

Gets the package delivery options of the specified project. Retruns with null if the package creation is not allowed in the project.

Declaration

PackageDeliveryOptions GetPackageDeliveryOptions(Guid serverProjectGuid)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.

Returns

Type	Description
PackageDeliveryOptions	The package delivery options.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
PackageCreationNotAllowedFault	The projetc does not allow package creation.

GetPostTranslationAnalysisReportAsCSV(Guid, Guid)

Exports a post translation analysis report as a CSV and gets the results.

Declaration

PostTranslationAnalysisAsCSVResult GetPostTranslationAnalysisReportAsCSV(Guid serverProjectGuid, Guid reportId)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
Guid	reportId	The unique identifier of the report.

Returns

Type	Description
PostTranslationAnalysisAsCSVResult	An object that contains the exported report data for each language the report contains.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
CannotStartOperationFault	The operation cannot be executed due to a concurrent conflicting action in progress.

GetPostTranslationAnalysisReportData(Guid, Guid)

Gets a post-translation analysis report.

Declaration

PostTranslationAnalysisResultInfo GetPostTranslationAnalysisReportData(Guid serverProjectGuid, Guid reportId)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
Guid	reportId	The unique identifier of the report.

Returns

Type	Description
PostTranslationAnalysisResultInfo	An object that encapsulates the report itself. The report is decomposed into per-language data, for each language the report was created for.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
CannotStartOperationFault	The operation cannot be executed due to a concurrent conflicting action in progress.

GetProject(Guid)

Gets information about the specified project.

Declaration

ServerProjectInfo GetProject(Guid spGuid)

Parameters

Type	Name	Description
Guid	spGuid

Returns

Type	Description
ServerProjectInfo	The ServerProjectInfo object describing the server project.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

GetStatisticsOnProject(Guid, String[], StatisticsOptions, StatisticsResultFormat)

OBSOLETE - The generated report does not contain Machine translated segments, use GetStatisticsOnProject2(CreateStatisticsOnProjectRequest). Creates the statistics on the whole server project (includes all documents). Also available in an asynchronous task fashion: StartStatisticsOnProjectTask(Guid, String[], StatisticsOptions, StatisticsResultFormat)

Declaration

StatisticsResultInfo GetStatisticsOnProject(Guid serverProjectGuid, string[] targetLangCodes, StatisticsOptions options, StatisticsResultFormat resultFormat)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
String[]	targetLangCodes	The three+(two) letter codes of target languages for which project level statistics is to be created. If null, the statistics is created for all target languages.
StatisticsOptions	options	The options of the statistics.
StatisticsResultFormat	resultFormat	The requested result format.

Returns

Type	Description
StatisticsResultInfo	The result in the requested format. Important note: the returned StatisticsResultInfo.ResultsForTargetLangs does not inlude items for which target language no document exists in the project.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
CannotStartOperationFault	The operation cannot be executed due to a concurrent conflicting action in progress.

GetStatisticsOnProject2(CreateStatisticsOnProjectRequest)

Creates the statistics on the whole server project (includes all documents). Includes Machine translated segments if available. Also available in an asynchronous task fashion: StartStatisticsOnProjectTask2(CreateStatisticsOnProjectRequest)

Declaration

StatisticsResultInfo GetStatisticsOnProject2(CreateStatisticsOnProjectRequest request)

Parameters

Type	Name	Description
CreateStatisticsOnProjectRequest	request

Returns

Type	Description
StatisticsResultInfo	The result in the requested format. Important note: the returned StatisticsResultInfo.ResultsForTargetLangs does not inlude items for which target language no document exists in the project.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
CannotStartOperationFault	The operation cannot be executed due to a concurrent conflicting action in progress.

GetStatisticsOnTranslationDocuments(Guid, Guid[], StatisticsOptions, StatisticsResultFormat)

OBSOLETE - The generated report does not contain Machine translated segments, use GetStatisticsOnTranslationDocuments2(CreateStatisticsOnDocumentsRequest) Creates the statistics on specified documents or slices of the server project. Also available in an asynchronous task fashion: StartStatisticsOnTranslationDocumentsTask(Guid, Guid[], StatisticsOptions, StatisticsResultFormat)

Declaration

StatisticsResultInfo GetStatisticsOnTranslationDocuments(Guid serverProjectGuid, Guid[] translationDocGuids, StatisticsOptions options, StatisticsResultFormat resultFormat)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
Guid[]	translationDocGuids	The guids of the documents and slices on which statistics is to be created. Each document or slice included has to have the same target language.
StatisticsOptions	options	The options of the statistics.
StatisticsResultFormat	resultFormat	The requested result format.

Returns

Type	Description
StatisticsResultInfo	The result in the requested format. Result is returned only for one target language.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
CannotStartOperationFault	The operation cannot be executed due to a concurrent conflicting action in progress.

GetStatisticsOnTranslationDocuments2(CreateStatisticsOnDocumentsRequest)

Creates the statistics on specified documents or slices of the server. Also includes MT translated segments where it is available. project. Also available in an asynchronous task fashion: StartStatisticsOnTranslationDocumentsTask2(CreateStatisticsOnDocumentsRequest)

Declaration

StatisticsResultInfo GetStatisticsOnTranslationDocuments2(CreateStatisticsOnDocumentsRequest request)

Parameters

Type	Name	Description
CreateStatisticsOnDocumentsRequest	request

Returns

Type	Description
StatisticsResultInfo	The result in the requested format. Result is returned only for one target language.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
CannotStartOperationFault	The operation cannot be executed due to a concurrent conflicting action in progress.

ImportBilingualTranslationDocument(Guid, Guid, BilingualDocFormat, String[])

Imports the bilingual translation document that can be in memoQ bilingual or XLIFF bilingual format (TwoColumnRTF is not supported). If the document with the same document Guid is already part of the project an exception is thrown (call UpdateTranslationDocumentFromBilingual instead).

Declaration

TranslationDocImportResultInfo[] ImportBilingualTranslationDocument(Guid serverProjectGuid, Guid fileGuid, BilingualDocFormat docFormat, string[] targetLangCodes)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
Guid	fileGuid	The guid of the bilingual file to be imported. The file has to be uploaded before calling this operation by IFileManagerService.BeginChunkedFileUpload and related operations. This guid is retuned by IFileManagerService.BeginChunkedFileUpload.
BilingualDocFormat	docFormat	The format of the bilingual document to be imported.
String[]	targetLangCodes	The three+(two) letter codes of the target languages the document is to be imported into. If the document is in memoQ bilingual format (mbd), then: If targetLangCodes is null, the document is imported to all target languages of the project. Otherwise, it is imported to the target languages defined by targetLangCodes. If the document is XLIFF, the targetlangcode can only be null, or can contain only the xliff's target language. In both case the document is imported into one target language (the one defined by the document itself. If the XLIFF document contains more than one document, all have to have the same source and target language.

Returns

Type	Description
TranslationDocImportResultInfo[]	The TranslationDocImportResultInfo objects providing information about the success or failure of the operation. This array has one item unless an XLIFF document containing more than one doument is imported. If a document is imported into more than one language, the DocumentGuids member of the TranslationDocImportResultInfo object has more than one item (one for each target language).

Remarks

Bilingual documents exported by pre 4.0 versions of memoQ are not supported.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

ImportImageLocalizationPack(Guid, Guid)

Imports and image localization package and saves the localized images in the package into the server project.

Declaration

ImportImageLocalizationPackResultInfo ImportImageLocalizationPack(Guid serverProjectGuid, Guid uploadedPackageFileId)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The identifier of the project.
Guid	uploadedPackageFileId	The identifer of the package file that was uploaded using IFileManagerService before.

Returns

Type	Description
ImportImageLocalizationPackResultInfo	The ResultInfo providing information about the result of the operation including any errors and warnings that may have occurred.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

ImportTranslationDocument(Guid, Guid, String[], String)

Imports the translation document, that can be of the file formats supported by memoQ.

Declaration

TranslationDocImportResultInfo ImportTranslationDocument(Guid serverProjectGuid, Guid fileGuid, string[] targetLangCodes, string importSettingsXML)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
Guid	fileGuid	The guid of the file to be imported. The file has to be uploaded before calling this operation by IFileManagerService.BeginChunkedFileUpload and related operations. This guid is returned by IFileManagerService.BeginChunkedFileUpload.
String[]	targetLangCodes	The three+(two) letter code of the target languages the document is to be imported into. If null, the document is imported into all target languages of the project. If not null, only target languages that are subset of the target languages of the project can be specified.
String	importSettingsXML	The settings of the import in memoQ import filter XML format. This setting also determines the filter (txt, doc, etc.) to be used. If null, the extension of the file is used to determine the import filter. The format of the file has slightly changed in memoQ version 4.2: it is the new export format of filter configuration resources (you can create one by exporting a memoQ filter configuration resource using memoQ client).

Returns

Type	Description
TranslationDocImportResultInfo	The TranslationDocImportResultInfo object providing information about the success or failure of the operation, and holding the Guid(s) of the newly imported document(s).

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

ImportTranslationDocuments(Guid, Guid[], String[], String)

Imports multiple translation documents with the same import settings, The documents can be of the file formats supported by memoQ.

Declaration

TranslationDocImportResultInfo[] ImportTranslationDocuments(Guid serverProjectGuid, Guid[] fileGuids, string[] targetLangCodes, string importSettingsXML)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
Guid[]	fileGuids	The guids of the files to be imported. The files have to be uploaded before calling this operation by IFileManagerService.BeginChunkedFileUpload and related operations. Each guid is retuned by IFileManagerService.BeginChunkedFileUpload.
String[]	targetLangCodes	The three+(two) letter code of the target languages the document is to be imported into. If null, the document is imported into all target languages of the project. If not null, only target languages that are subset of the target languages of the project can be specified.
String	importSettingsXML	The settings of the import in memoQ import filter XML format. This setting also determines the filter (txt, doc, etc.) to be used. If null, the extension of the file is used to determine the import filter. The format of the file has slightly changed in memoQ version 4.2: it is the new export format of filter configuration resources (you can create one by exporting a memoQ filter configuration resource using memoQ client).

Returns

Type	Description
TranslationDocImportResultInfo[]	The TranslationDocImportResultInfo objects providing information about the success or failure of the operation, and holding the Guids of the newly imported documents. This array has one matching item for each item in the fileGuids array (in the same order).

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

ImportTranslationDocumentsWithFilterConfigResource(Guid, Guid[], String[], Guid)

Imports multiple translation documents with the import settings (filter configuration) defined by the guid of an existing filter configuration resource. Documents can be of the file formats supported by memoQ.

Declaration

TranslationDocImportResultInfo[] ImportTranslationDocumentsWithFilterConfigResource(Guid serverProjectGuid, Guid[] fileGuids, string[] targetLangCodes, Guid filterConfigResGuid)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
Guid[]	fileGuids	The guids of the files to be imported. The files have to be uploaded before calling this operation by IFileManagerService.BeginChunkedFileUpload and related operations. Each guid is retuned by IFileManagerService.BeginChunkedFileUpload.
String[]	targetLangCodes	The three+(two) letter code of the target languages the document is to be imported into. If null, the document is imported into all target languages of the project. If not null, only target languages that are subset of the target languages of the project can be specified.
Guid	filterConfigResGuid	The guid of the filter configuration resource to be used during the import. The selected filter configuration resource defines the settings of the import. This setting also determines the filter (txt, doc, etc.) to be used.

Returns

Type	Description
TranslationDocImportResultInfo[]	The TranslationDocImportResultInfo objects providing information about the success or failure of the operation, and holding the Guids of the newly imported documents. This array has one matching item for each item in the fileGuids array (in the same order).

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

ImportTranslationDocumentsWithOptions(Guid, ImportTranslationDocumentOptions[])

Imports multiple translation documents into a server project. The options of the import are configured for each file separately using an instance of ImportTranslationDocumentOptions.

Declaration

TranslationDocImportResultInfo[] ImportTranslationDocumentsWithOptions(Guid serverProjectGuid, ImportTranslationDocumentOptions[] importDocOptions)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
ImportTranslationDocumentOptions[]	importDocOptions	The files to import and their respecive settings. Each item in the array corresponds to a file to import.

Returns

Type	Description
TranslationDocImportResultInfo[]	The TranslationDocImportResultInfo objects providing information about the success or failure of the operation, and holding the Guids of the newly imported documents. This array has one matching item for each item in the importDocOptions array (in the same order).

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

ImportTranslationDocumentWithFilterConfigResource(Guid, Guid, String[], Guid)

Imports a translation document with the import settings (filter configuration) defined by the guid of an existing filter configuration resource. Documents can be of the file formats supported by memoQ.

Declaration

TranslationDocImportResultInfo ImportTranslationDocumentWithFilterConfigResource(Guid serverProjectGuid, Guid fileGuid, string[] targetLangCodes, Guid filterConfigResGuid)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
Guid	fileGuid	The guid of the file to be imported. The file has to be uploaded before calling this operation by IFileManagerService.BeginChunkedFileUpload and related operations. This guid is returned by IFileManagerService.BeginChunkedFileUpload.
String[]	targetLangCodes	The three+(two) letter code of the target languages the document is to be imported into. If null, the document is imported into all target languages of the project. If not null, only target languages that are subset of the target languages of the project can be specified.
Guid	filterConfigResGuid	The guid of the filter configuration resource to be used during the import. The selected filter configuration resource defines the settings of the import. This setting also determines the filter (txt, doc, etc.) to be used.

Returns

Type	Description
TranslationDocImportResultInfo	The TranslationDocImportResultInfo object providing information about the success or failure of the operation, and holding the Guid(s) of the newly imported document(s).

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

ListAnalysisReports(Guid)

Lists analysis reports created earlier.

Declaration

AnalysisReportInfo[] ListAnalysisReports(Guid serverProjectGuid)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.

Returns

Type	Description
AnalysisReportInfo[]	An array of AnalysisReportInfo objects where each item describes a separate report and its metadata, including the unique identifier of the report which can be used to identify the report (e.g. for downloading). If the project contains no analysis reports, an empty array is returned.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

ListContentOfPackages(Guid[])

Gets the content of a package. Includes the list of documents (new or changed) and the deleted documents.

Declaration

PackageContentInfo[] ListContentOfPackages(Guid[] packageIds)

Parameters

Type	Name	Description
Guid[]	packageIds	The list of package identifiers for which to get the content.

Returns

Type	Description
PackageContentInfo[]	A a PackageContentInfo object for each package.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

ListEditDistanceReports(Guid)

Lists edit distance reports created earlier.

Declaration

EditDistanceReportInfo[] ListEditDistanceReports(Guid projectGuid)

Parameters

Type	Name	Description
Guid	projectGuid	The guid of the server project.

Returns

Type	Description
EditDistanceReportInfo[]	An array of EditDistanceReportInfo objects where each item describes a separate report and its metadata, including the unique identifier of the report which can be used to identify the report (e.g. for downloading). If the project contains no edit distance reports, an empty array is returned.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

ListPackagesForProject(Guid)

Lists all packages available for download in the specified server project. The project must support package creation, otherwise an exception is thrown. Does not list any packages until the project has been launched.

Declaration

PackageInfo[] ListPackagesForProject(Guid projectGuid)

Parameters

Type	Name	Description
Guid	projectGuid	The identifier of the project.

Returns

Type	Description
PackageInfo[]	The list of all packages in the project.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

ListPackagesForProjectAndUser(Guid, Guid)

Lists all packages available for download in the specified server project created for the specified user. The project must support package creation, otherwise an exception is thrown. Does not list any packages until the project has been launched.

Declaration

PackageInfo[] ListPackagesForProjectAndUser(Guid projectGuid, Guid userGuid)

Parameters

Type	Name	Description
Guid	projectGuid	The identifier of the project.
Guid	userGuid	The identifier of the user to list the packages for.

Returns

Type	Description
PackageInfo[]	The list of packages in the project for the user.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

ListPostTranslationAnalysisReports(Guid)

Lists post translation analysis reports created earlier.

Declaration

PostTranslationAnalysisReportInfo[] ListPostTranslationAnalysisReports(Guid serverProjectGuid)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.

Returns

Type	Description
PostTranslationAnalysisReportInfo[]	An array of PostTranslationAnalysisReportInfo objects where each item describes a separate report and its metadata, including the unique identifier of the report which can be used to idenrify the report (e.g. for downloading). If the project contains no post translation analysis reports, an empty array is returned.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
CannotStartOperationFault	The operation cannot be executed due to a concurrent conflicting action in progress.

ListProjectCorpora(Guid)

Returns the current corpora assignments of the specified project.

Declaration

ServerProjectCorporaAssignments ListProjectCorpora(Guid serverProjectGuid)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.

Returns

Type	Description
ServerProjectCorporaAssignments	The current corpora assignments.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

ListProjectResourceAssignments(Guid, ResourceType)

Lists the project (light) resource assignments for the specified resource type. If you would like to get the list of resource assignments for more than one resource types in one step you can use ListProjectResourceAssignmentsForMultipleTypes instead.

Declaration

ServerProjectResourceAssignmentDetails[] ListProjectResourceAssignments(Guid serverProjectGuid, ResourceType resourceType)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
ResourceType	resourceType	The type of the resource.

Returns

Type	Description
ServerProjectResourceAssignmentDetails[]	The current resource assignments for the specified resource type.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

ListProjectResourceAssignmentsForMultipleTypes(Guid, ResourceType[])

Lists the project (light) resource assignments for the specified resource types.

Declaration

ServerProjectResourceAssignmentDetails[][] ListProjectResourceAssignmentsForMultipleTypes(Guid serverProjectGuid, ResourceType[] resourceTypes)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
ResourceType[]	resourceTypes	An array of resource types for which the assignments are to be returned.

Returns

Type	Description
ServerProjectResourceAssignmentDetails[][]	The current resource assignments for the specified resource types. An array of ServerProjectResourceAssignmentDetails objects is returned for each resource type requested in the resourceTypes parameter in the same order as requested.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

ListProjects(ServerProjectListFilter)

Returns the list of server projects.

Declaration

ServerProjectInfo[] ListProjects(ServerProjectListFilter filter)

Parameters

Type	Name	Description
ServerProjectListFilter	filter	The filter object. If null, the returned list is not filtered, it will contain the live projects and the projects from the recycle bin as well. Please note that the project archives will not be listed.

Returns

Type	Description
ServerProjectInfo[]	An array of ServerProjectInfo objects each describing one server project.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

ListProjectTBs(Guid)

OBSOLETE, PLEASE USE FUNCTION ListProjectTBs3(Guid, String[]) INSTEAD

This method returns all term bases of the project with no regards to which target language a term base is assigned to. memoQ offers per-target language term base assignment, which this method is not able to represent. To retrieve per language results use ListProjectTBs3.

Returns the current term base assignments of the specified project.

Declaration

ServerProjectTBAssignments ListProjectTBs(Guid serverProjectGuid)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.

Returns

Type	Description
ServerProjectTBAssignments	The current term base assignments.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

ListProjectTBs3(Guid, String[])

Returns the current term base assignments of the specified project for the given target languages.

Declaration

ServerProjectTBsForTargetLang[] ListProjectTBs3(Guid serverProjectGuid, string[] targetLanguages)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
String[]	targetLanguages

Returns

Type	Description
ServerProjectTBsForTargetLang[]	The current term base assignments for the requested target languages.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

ListProjectTMs2(Guid, String[])

Returns the current translation memory assignments of the specified project.

Declaration

ServerProjectTMAssignmentDetails[] ListProjectTMs2(Guid serverProjectGuid, string[] targetLangCodes)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
String[]	targetLangCodes	The target language codes for which the translation memory assignments are to be returned. If null, assignments for all target languages are returned.

Returns

Type	Description
ServerProjectTMAssignmentDetails[]	The current translation memory assignments for the requested target languages.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

ListProjectTranslationDocuments(Guid)

Returns the current translation documents of the specified project.

Declaration

ServerProjectTranslationDocInfo[] ListProjectTranslationDocuments(Guid serverProjectGuid)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.

Returns

Type	Description
ServerProjectTranslationDocInfo[]	The translation documents of the project.

Remarks

The result does not contain assignment information about any documents that were assigned through the FirstAccept, GroupSourcing and subvendor assignment modes (even after the documents have been claimed via FirstAccept and delivered). You can use the ListProjectTranslationDocuments2(Guid, ListServerProjectTranslationDocument2Options) or ListTranslationDocumentAssignments(Guid, ListTranslationDocumentAssignmentsOptions) functions if you would like to get this information.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

ListProjectTranslationDocuments2(Guid, ListServerProjectTranslationDocument2Options)

Returns the current translation documents of the specified project. The result contains the details of the assignments if the field FillInAssignmentInformation is true in the options parameter. Setting this to false has better performance. It is possible to query the assignments in a separate step using the ListTranslationDocumentAssignments(Guid, ListTranslationDocumentAssignmentsOptions) operation.

Declaration

ServerProjectTranslationDocInfo2[] ListProjectTranslationDocuments2(Guid serverProjectGuid, ListServerProjectTranslationDocument2Options options)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
ListServerProjectTranslationDocument2Options	options	The listing options.

Returns

Type	Description
ServerProjectTranslationDocInfo2[]	The translation documents of the project.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

ListProjectTranslationDocumentsGroupedBySourceFile(Guid)

Importing files into projects may yield documents that are grouped. An example for such a group is the so-called multilingual file format, where one source file yields multiple documents in various languages, and the translation of such documents in "united" in the export process. This operation provies an overview of the document groups in the project.

Declaration

ServerProjectTranslationDocumentsFromSameSourceFile[] ListProjectTranslationDocumentsGroupedBySourceFile(Guid serverProjectGuid)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.

Returns

Type	Description
ServerProjectTranslationDocumentsFromSameSourceFile[]	An array in which each item represents a multilingual group, a set of documents that are the result of importing a multilingual document.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

ListProjectTranslationDocumentSlices(Guid, Guid, ListServerProjectTranslationDocumentSliceOptions)

Returns the slices of the specified translation documents of the specified project. The return value is an empty array if the document is not sliced. The result contains the details of the assignments if the field FillInAssignmentInformation is true in the options parameter. Setting this to false has better performance. It is possible to query the assignments in a separate step using the ListTranslationDocumentAssignments(Guid, ListTranslationDocumentAssignmentsOptions) operation.

Declaration

ServerProjectTranslationDocSliceInfo[] ListProjectTranslationDocumentSlices(Guid serverProjectGuid, Guid documentGuid, ListServerProjectTranslationDocumentSliceOptions options)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
Guid	documentGuid	The guid of the document.
ListServerProjectTranslationDocumentSliceOptions	options	The listing options.

Returns

Type	Description
ServerProjectTranslationDocSliceInfo[]	The slices of the document.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

ListProjectUsers(Guid)

Returns the current user assignments of the specified project.

Declaration

ServerProjectUserInfoHeader[] ListProjectUsers(Guid serverProjectGuid)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.

Returns

Type	Description
ServerProjectUserInfoHeader[]	The current user assignments.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

ListTranslationDocumentAssignments(Guid, ListTranslationDocumentAssignmentsOptions)

Lists the assignment information of the specified documents and slices in the specified project.

Declaration

TranslationDocumentDetailedAssignments[] ListTranslationDocumentAssignments(Guid serverProjectGuid, ListTranslationDocumentAssignmentsOptions options)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
ListTranslationDocumentAssignmentsOptions	options	The listing options.

Returns

Type	Description
TranslationDocumentDetailedAssignments[]	The translation documents' assignment information.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

PreparePackageForDownload(Guid)

Prepares a package for download. The result contains the identifier of the package which can be downloaded using FileManagerService. The result of the preparation can be that no package is created (in case there has been some changes in the project that were undone in the meantime and there is no change for the user). In this case no file is available for download. The package should be downloaded separately if this operation succeeds and reports that the package is available.

Declaration

PreparePackageResultInfo PreparePackageForDownload(Guid packageId)

Parameters

Type	Name	Description
Guid	packageId	The identifier of the package.

Returns

Type	Description
PreparePackageResultInfo	A result info which signals if there is a package available for download, and if so, contains its identifier.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
CannotStartOperationFault	The operation cannot be executed due to a concurrent conflicting action in progress.

PretranslateDocuments(Guid, Guid[], PretranslateOptions)

Pre-translates the specified documents and slices of the server project. Also available in an asynchronous task fashion: StartPretranslateDocumentsTask(Guid, Guid[], PretranslateOptions)

Declaration

ResultInfo PretranslateDocuments(Guid serverProjectGuid, Guid[] translationDocGuids, PretranslateOptions options)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
Guid[]	translationDocGuids	The guids of the documents and slices to be pre-translated.
PretranslateOptions	options	The options of the pre-translate process.

Returns

Type	Description
ResultInfo	The ResultInfo object providing information about the success or failure of the operation.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
CannotStartOperationFault	The operation cannot be executed due to a concurrent conflicting action in progress.

PretranslateProject(Guid, String[], PretranslateOptions)

Pre-translates the whole server project (includes all documents for the specified target languages). Also available in an asynchronous task fashion: StartPretranslateProjectTask(Guid, String[], PretranslateOptions)

Declaration

ResultInfo PretranslateProject(Guid serverProjectGuid, string[] targetLangCodes, PretranslateOptions options)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
String[]	targetLangCodes	The three+(two) letter codes of target languages for which project level pretranslate is to be performed. If null, the pretranslate is performed for all target languages.
PretranslateOptions	options	The options of the pre-translate process.

Returns

Type	Description
ResultInfo	The ResultInfo object providing information about the success or failure of the operation.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
CannotStartOperationFault	The operation cannot be executed due to a concurrent conflicting action in progress.

ReconsolidateDocument(Guid, Guid)

Reconsolidates a sliced document.

Declaration

void ReconsolidateDocument(Guid serverProjectGuid, Guid documentGuid)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
Guid	documentGuid	The guid of the document.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
ReconsolidateDocumentFault	The specified document is not sliced.

ReImportTranslationDocuments(Guid, ReimportDocumentOptions[], String)

Re-imports translation documents overwriting existing documents in the server project.

Declaration

TranslationDocImportResultInfo[] ReImportTranslationDocuments(Guid serverProjectGuid, ReimportDocumentOptions[] reimportActions, string importSettingsXML)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
ReimportDocumentOptions[]	reimportActions	The reimport actions for each import file. Each reimported file replaces one or more documents in the server project. The document(s) replaced by a single reimported file correspond to different target languages. The documents to overwrite are identified by their unique identifier DocumentGuid property of the ServerProjectTranslationDocInfo instance which represents the document. This array must contain as many items as many files are reimported.
String	importSettingsXML	The settings of the import in memoQ import filter XML format. This setting also determines the filter (txt, doc, etc.) to be used. If null, the extension of the file is used to determine the import filter. The format of the file has slightly changed in memoQ version 4.2: it is the new export format of filter configuration resources (you can create one by exporting a memoQ filter configuration resource using memoQ client).

Returns

Type	Description
TranslationDocImportResultInfo[]	The TranslationDocImportResultInfo objects providing information about the success or failure of the operation, and holding the Guids of the newly imported documents. This array has one matching item for each item in the fileGuids array (in the same order).

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
CannotStartOperationFault	The operation cannot be executed due to a concurrent conflicting action in progress.

ReImportTranslationDocumentsWithFilterConfigResource(Guid, ReimportDocumentOptions[], Guid)

Re-imports translation documents overwriting existing documents in the server project.

Declaration

TranslationDocImportResultInfo[] ReImportTranslationDocumentsWithFilterConfigResource(Guid serverProjectGuid, ReimportDocumentOptions[] reimportActions, Guid filterConfigResGuid)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
ReimportDocumentOptions[]	reimportActions	The reimport actions for each import file. Each reimported file replaces one or more documents in the server project. The document(s) replaced by a single reimported file correspond to different target languages. The documents to overwrite are identified by their unique identifier DocumentGuid property of the ServerProjectTranslationDocInfo instance which represents the document. This array must contain as many items as many files are reimported.
Guid	filterConfigResGuid	The guid of the filter configuration resource to be used during the import. The selected filter configuration resource defines the settings of the import. This setting also determines the filter (txt, doc, etc.) to be used.

Returns

Type	Description
TranslationDocImportResultInfo[]	The TranslationDocImportResultInfo objects providing information about the success or failure of the operation, and holding the Guids of the newly imported documents. This array has one matching item for each item in the fileGuids array (in the same order).

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
CannotStartOperationFault	The operation cannot be executed due to a concurrent conflicting action in progress.

RenameProject(Guid, String)

Renames the specified project.

Declaration

void RenameProject(Guid serverProjectGuid, string newName)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project to be renamed.
String	newName	The new name of the project. Cannot be null or empty. The name cannot contain characters that are invalid in file names (e.g.: ",:,/,,tab, ...).

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
RenameProjectFault	A project with the same name already exists.

ResetProject(Guid)

Resets a project back to not distributed state (including deleting notification history and created packages).

Declaration

void ResetProject(Guid serverProjectGuid)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
CannotStartOperationFault	The operation cannot be executed due to a concurrent conflicting action in progress.

RestoreArchive(Guid)

Restores an archive file that has been previously uploaded to the server.

Declaration

Guid RestoreArchive(Guid archiveFileID)

Parameters

Type	Name	Description
Guid	archiveFileID	The Guid of the uploaded archive file.

Returns

Type	Description
Guid	The Guid of the restored project.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

RunAnalysis(Guid, AnalysisOptions)

Runs analysis on a project and get the resulting report.

Declaration

AnalysisResultInfo RunAnalysis(Guid serverProjectGuid, AnalysisOptions options)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
AnalysisOptions	options	An object that describes the options of creating the report.

Returns

Type	Description
AnalysisResultInfo	An object that describes the result of the operation and contains the report data.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
CannotStartOperationFault	The operation cannot be executed due to a concurrent conflicting action in progress.

RunFuzzyEditDistance(Guid, EditDistanceStatisticsOptions)

Runs fuzzy edit distance statistics on a project and get the resulting report. Also available in an asynchronous task fashion: StartFuzzyEditDistanceTask(Guid, EditDistanceStatisticsOptions)

Declaration

FuzzyEditDistanceReport RunFuzzyEditDistance(Guid projectGuid, EditDistanceStatisticsOptions options)

Parameters

Type	Name	Description
Guid	projectGuid	The guid of the server project.
EditDistanceStatisticsOptions	options	An object that describes the options of creating the report.

Returns

Type	Description
FuzzyEditDistanceReport	An object that describes the result of the operation and contains the report data.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
CannotStartOperationFault	The operation cannot be executed due to a concurrent conflicting action in progress.

RunLevenshteinEditDistance(Guid, EditDistanceStatisticsOptions)

Runs levenshtein edit distance statistics on a project and get the resulting report. Also available in an asynchronous task fashion: StartLevenshteinEditDistanceTask(Guid, EditDistanceStatisticsOptions)

Declaration

LevenshteinEditDistanceReport RunLevenshteinEditDistance(Guid projectGuid, EditDistanceStatisticsOptions options)

Parameters

Type	Name	Description
Guid	projectGuid	The guid of the server project.
EditDistanceStatisticsOptions	options	An object that describes the options of creating the report.

Returns

Type	Description
LevenshteinEditDistanceReport	An object that describes the result of the operation and contains the report data.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
CannotStartOperationFault	The operation cannot be executed due to a concurrent conflicting action in progress.

RunLqaRejectedSegmentsCollection(Guid, LqaRejectedSegmentsOptions)

Executes collecting rejections from LQA findings into a report.

Declaration

LqaRejectedSegmentsTaskResult RunLqaRejectedSegmentsCollection(Guid serverProjectGuid, LqaRejectedSegmentsOptions options)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The GUID of the server project to generate report on.
LqaRejectedSegmentsOptions	options	Options and additional data for running LQA and getting the errors.

Returns

Type	Description
LqaRejectedSegmentsTaskResult	LQA error collection report.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

RunLqaStatisticsGeneration(Guid, LqaStatisticsGenerationOptions)

Executes statistics report generation from LQA findings.

Declaration

LqaStatisticsTaskResult RunLqaStatisticsGeneration(Guid serverProjectGuid, LqaStatisticsGenerationOptions options)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The GUID of the server project to generate report on.
LqaStatisticsGenerationOptions	options	Options and additional data for running LQA and getting a report.

Returns

Type	Description
LqaStatisticsTaskResult	LQA statistics report.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

RunPostTranslationAnalysis(Guid, PostTranslationAnalysisOptions)

Runs post-translation analysis on a project and get the resulting report. Also available in an asynchronous task fashion: StartPostTranslationAnalysisTask(Guid, PostTranslationAnalysisOptions)

Declaration

PostTranslationAnalysisResultInfo RunPostTranslationAnalysis(Guid serverProjectGuid, PostTranslationAnalysisOptions options)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
PostTranslationAnalysisOptions	options	An object that describes the options of creating the report.

Returns

Type	Description
PostTranslationAnalysisResultInfo	An object that describes the result of the operation and contains the report data.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
CannotStartOperationFault	The operation cannot be executed due to a concurrent conflicting action in progress.

RunQAGetReport(Guid, RunQAGetReportOptions)

Executed QA checks on the specified scope, collects errors and warnings, and returns a report of the errors and warnings present in the specified scope. Also available in an asynchronous task fashion: StartQAReportTask(Guid, RunQAGetReportOptions)

Declaration

QAReport RunQAGetReport(Guid serverProjectGuid, RunQAGetReportOptions options)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The unique identifier of the project.
RunQAGetReportOptions	options	Detailed options of the operation.

Returns

Type	Description
QAReport	An object that contains an overview report for each document in the scope, and optionally a detailed report in the requested format (e.g. HTML report).

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
CannotStartOperationFault	The operation cannot be executed due to a concurrent conflicting action in progress.

SetClosedStatusOfProject(Guid, Boolean)

Sets the closed status of project.

Declaration

void SetClosedStatusOfProject(Guid serverProjectGuid, bool isClosed)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
Boolean	isClosed	The new closed status of the project.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

SetDocumentWorkflowStatus(Guid, ServerProjectTranslationDocumentWorkflowStatusChange[])

Changes the workflow status of documents or slices in the server project.

Declaration

void SetDocumentWorkflowStatus(Guid serverProjectGuid, ServerProjectTranslationDocumentWorkflowStatusChange[] workflowChanges)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
ServerProjectTranslationDocumentWorkflowStatusChange[]	workflowChanges	The workflow status changes to apply. Each item represents a change for a single document or slice. Workflow status of documents and slices not listed in this list are not changed.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
CannotStartOperationFault	The operation cannot be executed due to a concurrent conflicting action in progress.
SetDocumentWorkflowStatusFault	The operation is not valid on a document because it is sliced.

SetPackageDeliveryOptions(Guid, PackageDeliveryOptions)

Sets the package delivery options of the specified project.

Declaration

void SetPackageDeliveryOptions(Guid serverProjectGuid, PackageDeliveryOptions options)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the project.
PackageDeliveryOptions	options	The package delivery options.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
PackageCreationNotAllowedFault	The project does not allow package creation.

SetProjectCorpora(Guid, Guid[])

Assigns the corpora identifed by the corporaGuids parameter to the specified project. All existing corpora assignments are deleted. Only those corpora can be assigned to the project, whose languages include the source language of the project.

Declaration

void SetProjectCorpora(Guid serverProjectGuid, Guid[] corporaGuids)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
Guid[]	corporaGuids	The guids of the corpora to be assigned to the project.

Remarks

Corpora can be created, published and deleted by the operations of the ILiveDocsService service interface.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

SetProjectResourceAssignments(Guid, ServerProjectResourceAssignmentForResourceType[])

Sets the new light resource assignments for the project for the specified resource types. See the documentation of the ServerProjectResourceAssignment member of class ServerProjectResourceAssignmentForResourceType to find out what rules apply to the assignment of different resource types.

Declaration

void SetProjectResourceAssignments(Guid serverProjectGuid, ServerProjectResourceAssignmentForResourceType[] assignments)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
ServerProjectResourceAssignmentForResourceType[]	assignments	Defines the light resource assignments for the project. Each object in this array defines the new assignment for one resource type. Resource assignment for resource types for which no ServerProjectResourceAssignmentForResourceType object is included in the array is not changed.

Remarks

Light resources can be created, imported and deleted by the operations of the IResourceService service interface.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

SetProjectTBs(Guid, Guid[], Guid)

OBSOLETE, PLEASE USE FUNCTION SetProjectTBs3(Guid, ServerProjectTBsForTargetLang[]) INSTEAD

This method assigns the same TBs to all target languages of the project deleting existing assignments. Per-language assignment is available through using SetProjectTBs3.

Assigns the term bases identifed by the tbGuids parameter to the specified project. Also sets the primary term base of the project. All existing term base assignments are deleted. The existing primary term base assignment is also deleted. Only those term bases can be assigned to the project, whose languages include the source and all target languages of the project. When matching languages lazy match is performed (e.g. a term base including language "eng" but not including "eng-US" can also be used with a project with language "eng-US"). However, if the TB and project languages do not match exactly, translators will not be able to add new entries to the TB working in the project). Remark: pre 6.2.15 versions of the API required exact language match: this has been changed to make the API more consistent with the memoQ application behavior).

Declaration

void SetProjectTBs(Guid serverProjectGuid, Guid[] tbGuids, Guid primaryTB)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
Guid[]	tbGuids	The guids of the term bases to be assigned to the project.
Guid	primaryTB	The guid of the primary term base to be set for the project. This guid have to be included in the guid array of the tbGuids parameter. If tbGuids array is empty, set this to an empty Guid (Guid of full zeros).

Remarks

Term bases can be created, published and deleted by the operations of the ITBService service interface.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

SetProjectTBs2(Guid, Guid[])

OBSOLETE, PLEASE USE FUNCTION SetProjectTBs3(Guid, ServerProjectTBsForTargetLang[]) INSTEAD

This method assigns the same TBs to all target languages of the project deleting existing assignments. Per-language assignment is available through using SetProjectTBs3.

Assigns the term bases identified by the tbGuids parameter to the specified project. Also sets the ranks of term bases of the project based on the order of the TB guids. The TB with rank 1 will be the primary term base. All existing term base assignments are deleted. Only those term bases can be assigned to the project, whose languages include the source and all target languages of the project. When matching languages lazy match is performed (e.g. a term base including language "eng" but not including "eng-US" can also be used with a project with language "eng-US"). However, if the TB and project languages do not match exactly, translators will not be able to add new entries to the TB working in the project). Remark: pre 6.2.15 versions of the API required exact language match: this has been changed to make the API more consistent with the memoQ application behavior).

Declaration

void SetProjectTBs2(Guid serverProjectGuid, Guid[] tbGuids)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
Guid[]	tbGuids

Remarks

Term bases can be created, published and deleted by the operations of the ITBService service interface.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

SetProjectTBs3(Guid, ServerProjectTBsForTargetLang[])

Sets the new term base assignments for the project (for a subset of the target languages of the project). Also sets the target for new terms term base for these target languages.

Declaration

void SetProjectTBs3(Guid serverProjectGuid, ServerProjectTBsForTargetLang[] tbAssignments)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
ServerProjectTBsForTargetLang[]	tbAssignments	Defines the new TB assignments for the project. Each object in this array defines the new assignment for one target language. TB assignment for project target languages for which no ServerProjectTBsForTargetLang object is included in the array is not changed.

Remarks

Term bases can be created, published and deleted by the operations of the ITBService service interface.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

SetProjectTMs2(Guid, ServerProjectTMAssignmentsForTargetLang[])

Sets the new translation memory assignments for the project (for a subset of the target languages of the project). Also sets the primary translation memories for these target languages.

Declaration

void SetProjectTMs2(Guid serverProjectGuid, ServerProjectTMAssignmentsForTargetLang[] tmAssignments)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
ServerProjectTMAssignmentsForTargetLang[]	tmAssignments	Defines the new TM assignments for the project. Each object in this array defines the new assignment and primary TM for one target language. TM assignment for project target languages for which no ServerProjectTMAssignments object is included in the array is not changed.

Remarks

Translation memories can be created, published and deleted by the operations of the ITMService service interface.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

SetProjectTranslationDocumentUserAssignments(Guid, ServerProjectTranslationDocumentUserAssignments[])

Sets the translation document to user assignments.

Declaration

void SetProjectTranslationDocumentUserAssignments(Guid serverProjectGuid, ServerProjectTranslationDocumentUserAssignments[] assignments)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
ServerProjectTranslationDocumentUserAssignments[]	assignments	The assignments to be set. Each item represents the assignment of users to one document. Existing assignments for the documents included are deleted and then set to the new values. Assignments of documents not included in the "assignments" array are not deleted.

Remarks

This method does not support the first accept, group sourcing and the subvendor group assignment. Use the SetTranslationDocumentAssignments(Guid, SetTranslationDocumentAssignmentsOptions) instead of this.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

SetProjectUsers(Guid, ServerProjectUserInfo[])

Assigns the users identifed by the userInfos parameter to the specified project. The ServerProjectUserInfo objects identify the user and his/her role in the server project. All existing user assignments are deleted.

Declaration

void SetProjectUsers(Guid serverProjectGuid, ServerProjectUserInfo[] userInfos)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
ServerProjectUserInfo[]	userInfos	The new list of server project user assignments.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

SetTranslationDocumentAssignments(Guid, SetTranslationDocumentAssignmentsOptions)

Assigns the translation document or slice to user/group of users/subvendor. This is the advanced version of the SetProjectTranslationDocumentUserAssignments operation, as it enables advanced scenarios for assigning users to documents (first accept, group sourcing, subvendor group assignment).

Declaration

TranslationDocumentAssignmentResultInfo[] SetTranslationDocumentAssignments(Guid serverProjectGuid, SetTranslationDocumentAssignmentsOptions options)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
SetTranslationDocumentAssignmentsOptions	options	The assignments to be set. Each item represents the assignment of user/group of users/subvendor to one document. Assignments of documents not included in the "assignments" array are untouched (are not deleted).

Returns

Type	Description
TranslationDocumentAssignmentResultInfo[]

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
TranslationDocumentAssignmentFault	See the errorcode for specific issue: DocDoesNotExist: The document does not exist in the project. DocIsDivided: The document is sliced. DocDivisionIsGroupAssigned: In case of document slices only single user assignments are allowed. DocIsGroupAssignedInLTConnectedProject: In LT-connected projects only single user and FirstAccept assignments are allowed. RoleAssignmentProblem: Document assignment failed due to role assignment error. UserIsNotInTheProject: The user is not assigned to the project. SVGroupDoesNotExist: The subvendor group does not exsit anymore. NormalGroupInSVAssignment: Can not assign document to normal group with subvendor assignment. SVUserOrManagerInNormalAssignment: Can not assign document to subvendor user or manager with single user assignment, FirstAccept or GroupSourcing.

SliceDocument(Guid, SliceDocumentRequest)

Slices a document based on the specified options. The already existing user assignments will be removed.

Declaration

ServerProjectTranslationDocSliceInfo[] SliceDocument(Guid serverProjectGuid, SliceDocumentRequest options)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
SliceDocumentRequest	options	The slicing options.

Returns

Type	Description
ServerProjectTranslationDocSliceInfo[]	The slices of the document.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
SliceDocumentFault	The specified document is already sliced.

StartConfirmAndUpdateTask(Guid, Guid, Guid[], ConfirmAndUpdateOptions)

Confirms and updates rows of the specified documents and slices in the specified server project. Starts an asynchronous task that is executed in order per each project. The result of the operation can be queried using the TasksService interface operations. The result object of the finished task is of type ConfirmAndUpdateTaskResult.

Declaration

TaskInfo StartConfirmAndUpdateTask(Guid userGuid, Guid serverProjectGuid, Guid[] translationDocGuids, ConfirmAndUpdateOptions options)

Parameters

Type	Name	Description
Guid	userGuid	The guid of to the user who performs the confirm and update operation. This user's user name is used when the server updates the statuses of the segments. If the UserNameBehavior is UseProjectDefault in the options parameter, the server uses this user's name as creator/modifier when updating the translation memories.
Guid	serverProjectGuid	The guid of the server project.
Guid[]	translationDocGuids	The guids of the documents and slices to confirm and update.
ConfirmAndUpdateOptions	options	The options of the confirm and update process.

Returns

Type	Description
TaskInfo	A task descriptor to use to query the tasks status using TasksService operations.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

StartDeleteProjectTask(Guid)

Deletes the specified project. Starts an asynchronous task that is executed in order per each project. The result of the operation can be queried using the TasksService interface operations. The task does not have a result.

Declaration

TaskInfo StartDeleteProjectTask(Guid serverProjectGuid)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project to be deleted.

Returns

Type	Description
TaskInfo	A task descriptor to use to query the tasks status using TasksService operations.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

StartDistributeProjectTask(Guid)

Distributes a project and sends out notifications to the members of the project. Starts an asynchronous task that is executed in order per each project. The result of the operation can be queried using the TasksService interface operations. The task does not have a result.

Declaration

TaskInfo StartDistributeProjectTask(Guid serverProjectGuid)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid if the server project.

Returns

Type	Description
TaskInfo	A task descriptor to use to query the tasks status using TasksService operations.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

StartFuzzyEditDistanceTask(Guid, EditDistanceStatisticsOptions)

Runs fuzzy edit distance statistics on a project and get the resulting report. Starts an asynchronous task that is executed in order per each project. The result of the operation can be queried using the TasksService interface operations. The result object of the finished task is of type FuzzyEditDistanceTaskResult.

Declaration

TaskInfo StartFuzzyEditDistanceTask(Guid projectGuid, EditDistanceStatisticsOptions options)

Parameters

Type	Name	Description
Guid	projectGuid	The guid of the server project.
EditDistanceStatisticsOptions	options	An object that describes the options of creating the report.

Returns

Type	Description
TaskInfo	A task descriptor to use to query the tasks status using TasksService operations.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

StartLevenshteinEditDistanceTask(Guid, EditDistanceStatisticsOptions)

Runs levenshtein edit distance statistics on a project and get the resulting report. Starts an asynchronous task that is executed in order per each project. The result of the operation can be queried using the TasksService interface operations. The result object of the finished task is of type LevenshteinEditDistanceTaskResult.

Declaration

TaskInfo StartLevenshteinEditDistanceTask(Guid projectGuid, EditDistanceStatisticsOptions options)

Parameters

Type	Name	Description
Guid	projectGuid	The guid of the server project.
EditDistanceStatisticsOptions	options	An object that describes the options of creating the report.

Returns

Type	Description
TaskInfo	A task descriptor to use to query the tasks status using TasksService operations.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

StartLockUnlockSegmentsDocumentsTask(Guid, Guid[], LockUnlockSegmentsOptions)

Locks or unlocks the matching segments of specified documents of the server project (excluding the slices of the documents). Starts an asynchronous task that is executed in order per each project. The result of the operation can be queried using the TasksService interface operations. The task does not have a result.

Declaration

TaskInfo StartLockUnlockSegmentsDocumentsTask(Guid serverProjectGuid, Guid[] translationDocGuids, LockUnlockSegmentsOptions options)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
Guid[]	translationDocGuids	The guids of the documents of which segments to be locked/unlocked.
LockUnlockSegmentsOptions	options	The options of the locking/unlocking process.

Returns

Type	Description
TaskInfo	A task descriptor to use to query the tasks status using TasksService operations.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

StartLockUnlockSegmentsProjectTask(Guid, String[], LockUnlockSegmentsOptions)

Locks or unlocks the matching segments of documents from the whole server project (includes all documents for the specified target languages). Starts an asynchronous task that is executed in order per each project. The result of the operation can be queried using the TasksService interface operations. The task does not have a result.

Declaration

TaskInfo StartLockUnlockSegmentsProjectTask(Guid serverProjectGuid, string[] targetLangCodes, LockUnlockSegmentsOptions options)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
String[]	targetLangCodes	The three+(two) letter codes of target languages for which project level locking/unlocking is to be performed. If null, the locking/unlocking is performed for all target languages.
LockUnlockSegmentsOptions	options	The options of the locking/unlocking process.

Returns

Type	Description
TaskInfo	A task descriptor to use to query the tasks status using TasksService operations.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

StartLqaRejectedSegmentsCollectionTask(Guid, LqaRejectedSegmentsOptions)

Starts the execution of collecting rejections from LQA findings into a report.

Declaration

TaskInfo StartLqaRejectedSegmentsCollectionTask(Guid serverProjectGuid, LqaRejectedSegmentsOptions options)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The GUID of the server project to generate report on.
LqaRejectedSegmentsOptions	options	Options and additional data for running LQA and getting a report.

Returns

Type	Description
TaskInfo	A task descriptor to use to query the tasks status using TasksService operations.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

StartLqaStatisticsGenerationTask(Guid, LqaStatisticsGenerationOptions)

Starts generating a statistics report from LQA findings.

Declaration

TaskInfo StartLqaStatisticsGenerationTask(Guid serverProjectGuid, LqaStatisticsGenerationOptions options)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The GUID of the server project to generate report on.
LqaStatisticsGenerationOptions	options	Options and additional data for running LQA and getting a report.

Returns

Type	Description
TaskInfo	A task descriptor to use to query the tasks status using TasksService operations.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

StartPostTranslationAnalysisTask(Guid, PostTranslationAnalysisOptions)

Runs post-translation analysis on a project and get the resulting report. Starts an asynchronous task that is executed in order per each project. The result of the operation can be queried using the TasksService interface operations. The result object of the finished task is of type PostTranslationAnalysisTaskResult.

Declaration

TaskInfo StartPostTranslationAnalysisTask(Guid serverProjectGuid, PostTranslationAnalysisOptions options)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
PostTranslationAnalysisOptions	options	An object that describes the options of creating the report.

Returns

Type	Description
TaskInfo	A task descriptor to use to query the tasks status using TasksService operations.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

StartPretranslateDocumentsTask(Guid, Guid[], PretranslateOptions)

Pre-translates the specified documents and slices of the server project. Starts an asynchronous task that is executed in order per each project. The result of the operation can be queried using the TasksService interface operations. The task does not have a result.

Declaration

TaskInfo StartPretranslateDocumentsTask(Guid serverProjectGuid, Guid[] translationDocGuids, PretranslateOptions options)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
Guid[]	translationDocGuids	The guids of the documents and slices to be pre-translated.
PretranslateOptions	options	The options of the pre-translate process.

Returns

Type	Description
TaskInfo	A task descriptor to use to query the tasks status using TasksService operations.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

StartPretranslateProjectTask(Guid, String[], PretranslateOptions)

Pre-translates the whole server project (includes all documents for the specified target languages). Starts an asynchronous task that is executed in order per each project. The result of the operation can be queried using the TasksService interface operations. The task does not have a result.

Declaration

TaskInfo StartPretranslateProjectTask(Guid serverProjectGuid, string[] targetLangCodes, PretranslateOptions options)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
String[]	targetLangCodes	The three+(two) letter codes of target languages for which project level pretranslate is to be performed. If null, the pretranslate is performed for all target languages.
PretranslateOptions	options	The options of the pre-translate process.

Returns

Type	Description
TaskInfo	A task descriptor to use to query the tasks status using TasksService operations.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

StartQAReportTask(Guid, RunQAGetReportOptions)

Executed QA checks on the specified scope, collects errors and warnings, and returns a report of the errors and warnings present in the specified scope. Starts an asynchronous task that is executed in order per each project. The result of the operation can be queried using the TasksService interface operations. The result object of the finished task is of type RunQATaskResult.

Declaration

TaskInfo StartQAReportTask(Guid serverProjectGuid, RunQAGetReportOptions options)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The unique identifier of the project.
RunQAGetReportOptions	options	Detailed options of the operation.

Returns

Type	Description
TaskInfo	A task descriptor to use to query the tasks status using TasksService operations.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

StartStatisticsOnProjectTask(Guid, String[], StatisticsOptions, StatisticsResultFormat)

OBSOLETE - The generated report does not contain Machine translated segments, use StartStatisticsOnProjectTask2(CreateStatisticsOnProjectRequest). Creates the statistics on the whole server project (includes all documents). Starts an asynchronous task that is executed in order per each project. The result of the operation can be queried using the TasksService interface operations. The result object is of type StatisticsTaskResult.

Declaration

TaskInfo StartStatisticsOnProjectTask(Guid serverProjectGuid, string[] targetLangCodes, StatisticsOptions options, StatisticsResultFormat resultFormat)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
String[]	targetLangCodes	The three+(two) letter codes of target languages for which project level statistics is to be created. If null, the statistics is created for all target languages.
StatisticsOptions	options	The options of the statistics.
StatisticsResultFormat	resultFormat	The requested result format.

Returns

Type	Description
TaskInfo	A task descriptor; use TasksService to check for the tasks status.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

StartStatisticsOnProjectTask2(CreateStatisticsOnProjectRequest)

Creates the statistics on the whole server project (includes all documents). Includes also machine translated segments. Starts an asynchronous task that is executed in order per each project. The result of the operation can be queried using the TasksService interface operations. The result object is of type StatisticsTaskResult.

Declaration

TaskInfo StartStatisticsOnProjectTask2(CreateStatisticsOnProjectRequest request)

Parameters

Type	Name	Description
CreateStatisticsOnProjectRequest	request

Returns

Type	Description
TaskInfo	A task descriptor; use TasksService to check for the tasks status.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

StartStatisticsOnTranslationDocumentsTask(Guid, Guid[], StatisticsOptions, StatisticsResultFormat)

OBSOLETE - The generated report does not contain Machine translated segments, use StartStatisticsOnTranslationDocumentsTask2(CreateStatisticsOnDocumentsRequest). Creates the statistics on specified documents or slices of the server project. Starts an asynchronous task that is executed in order per each project. The result of the operation can be queried using the TasksService interface operations. The result object of the finished task is of type StatisticsTaskResult.

Declaration

TaskInfo StartStatisticsOnTranslationDocumentsTask(Guid serverProjectGuid, Guid[] translationDocGuids, StatisticsOptions options, StatisticsResultFormat resultFormat)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
Guid[]	translationDocGuids	The guids of the documents and slices on which statistics is to be created. Each document or slice included has to have the same target language.
StatisticsOptions	options	The options of the statistics.
StatisticsResultFormat	resultFormat	The requested result format.

Returns

Type	Description
TaskInfo	A task descriptor; use TasksService to check for the tasks status.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

StartStatisticsOnTranslationDocumentsTask2(CreateStatisticsOnDocumentsRequest)

Creates the statistics on specified documents or slices of the server project. Includes also Machine translated segments. Starts an asynchronous task that is executed in order per each project. The result of the operation can be queried using the TasksService interface operations. The result object of the finished task is of type StatisticsTaskResult.

Declaration

TaskInfo StartStatisticsOnTranslationDocumentsTask2(CreateStatisticsOnDocumentsRequest request)

Parameters

Type	Name	Description
CreateStatisticsOnDocumentsRequest	request

Returns

Type	Description
TaskInfo	A task descriptor; use TasksService to check for the tasks status.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

StartXTranslateTask(Guid, XTranslateOptions)

X-translates the rows of the specified documents of the specified server project. Starts an asynchronous task that is executed in order per each project. The result of the operation can be queried using the TasksService interface operations. The result object of the finished task is of type XTranslateTaskResult.

Declaration

TaskInfo StartXTranslateTask(Guid serverProjectGuid, XTranslateOptions options)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
XTranslateOptions	options	The X-translate options.

Returns

Type	Description
TaskInfo	A task descriptor to use to query the tasks status using TasksService operations.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

TurnOffAutoPilot(Guid)

Turns off AutoPilot mode.

Declaration

void TurnOffAutoPilot(Guid serverProjectGuid)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
TurnOffAutoPilotFault	See the errorcode for specific issue: AutoPilotAlreadyTurnedOff: The AutoPilot mode is already turned off. CalledOnNonTemplateBasedProject: Only template-based projects have AutoPilot feature. The function cannot be called on a non-template based projects.

UpdateProject(ServerProjectUpdateInfo)

Updates the header information (such as description, deadline) of an existing server project.

Declaration

void UpdateProject(ServerProjectUpdateInfo spInfo)

Parameters

Type	Name	Description
ServerProjectUpdateInfo	spInfo	A ServerProjectInfo object holding information about the server project to be updated. Can not be null.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

UpdateProjectFromPackage(Guid, Guid)

Import an update package and updates an existing project. The update package must match the project (the project must have been created from a package for which this update refers to).

Declaration

void UpdateProjectFromPackage(Guid projectGuid, Guid fileId)

Parameters

Type	Name	Description
Guid	projectGuid	The identifier of the project to update.
Guid	fileId	The file id of the update package to import. Should be uploaded usign FileManagerService.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
CannotStartOperationFault	The operation cannot be executed due to a concurrent conflicting action in progress.

UpdateTranslationDocumentFromBilingual(Guid, Guid, BilingualDocFormat)

Updates an existing translation translation document based on the bilingual document specified by fileGuid. The bilingual document can be XLIFF bilingual format or TwoColumnRTF, memoQ Bilingual (mbd) is not supported. If the document to be updated is not part of the project, an exception is thrown (call ImportBilingualTranslationDocument instead).

Declaration

TranslationDocImportResultInfo[] UpdateTranslationDocumentFromBilingual(Guid serverProjectGuid, Guid fileGuid, BilingualDocFormat docFormat)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
Guid	fileGuid	The guid of the bilingual file to be imported. The file has to be uploaded before calling this operation by IFileManagerService.BeginChunkedFileUpload and related operations. This guid is retuned by IFileManagerService.BeginChunkedFileUpload.
BilingualDocFormat	docFormat	The format of the bilingual document to be imported.

Returns

Type	Description
TranslationDocImportResultInfo[]	The TranslationDocImportResultInfo objects providing information about the success or failure of the operation. This array has one item unless an XLIFF document containing more than one doucment is imported. If a document is updated into more than one language, the DocumentGuids member of the TranslationDocImportResultInfo object has more than one item (one for each target language). The Guid of the document is preserved during the update (so the document Guid found in the document is returned).

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
CannotStartOperationFault	The operation cannot be executed due to a concurrent conflicting action in progress.

UpdateTranslationDocumentFromTableRtf(Guid, Guid, UpdateWithTableRtfOptions)

Updates an existing translation translation document based on the table rtf (two-column rtf) document specified by fileGuid. This operation allows more control over the update process then UpdateTranslationDocumentFromBilingual. If the document to be updated is not part of the project, an exception is thrown (call ImportBilingualTranslationDocument instead).

Declaration

TranslationDocImportResultInfo[] UpdateTranslationDocumentFromTableRtf(Guid serverProjectGuid, Guid fileGuid, UpdateWithTableRtfOptions opt)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
Guid	fileGuid	The guid of the bilingual file to be imported. The file has to be uploaded before calling this operation by IFileManagerService.BeginChunkedFileUpload and related operations. This guid is retuned by IFileManagerService.BeginChunkedFileUpload.
UpdateWithTableRtfOptions	opt	Options of the update process.

Returns

Type	Description
TranslationDocImportResultInfo[]	The TranslationDocImportResultInfo objects providing information about the success or failure of the operation. If a document is updated into more than one language, the DocumentGuids member of the TranslationDocImportResultInfo object has more than one item (one for each target language). The Guid of the document is preserved during the update (so the document Guid found in the document is returned).

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
CannotStartOperationFault	The operation cannot be executed due to a concurrent conflicting action in progress.

WrapUpProject(Guid)

Wraps up the project.

Declaration

void WrapUpProject(Guid serverProjectGuid)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
WrapUpProjectFault	The project is already wrapped up.

XTranslate(Guid, XTranslateOptions)

X-translates the rows of the specified documents of the specified server project. Also available in an asynchronous task fashion: StartXTranslateTask(Guid, XTranslateOptions)

Declaration

XTranslateResultInfo XTranslate(Guid serverProjectGuid, XTranslateOptions options)

Parameters

Type	Name	Description
Guid	serverProjectGuid	The guid of the server project.
XTranslateOptions	options	The X-translate options.

Returns

Type	Description
XTranslateResultInfo	The XTranslateResultInfo object providing information about the candidates and about the X-translated rows.

Exceptions

Type	Condition
UnexpectedFault	An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault	The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.
CannotStartOperationFault	The operation cannot be executed due to a concurrent conflicting action in progress.