Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The purpose of this method is to retrieve the parser file. In chapter API - Get available parsers users can get a list of all available parsers. This method is created to retrieve specific parser data.

URL

Code Block
(GET) /api/utility/parserpresets?token={token}&category={category}&index={index}

PARAMETERS

Parameters are:

token

The session token obtained when connecting.

category

Can be general or cms

index

It’s an index from API - Get available parsers Lest imagine that parser called INCOPY in on the second position than you should provide index=2

 

RESULTS

The method returns JSON and HTTP status 200. Other HTTP status values indicate an error.

EXAMPLE

A typical result may look like:

Code Block
{
    "xml": "<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n<!-- Exchange format for text extraction rules -->\r\n<ParserConfigurations xmlns=\"http://www.wordbee.com/config\">\r\n\r\n<!-- Rule -->\r\n<ParserConfiguration xmlns=\"http://www.wordbee.com/config\">\r\n  <Name>Adobe InDesign</Name>\r\n  <Description></Description>\r\n  <ParserDomain>INDESIGN</ParserDomain>\r\n  <EParser>11</EParser>\r\n  <Implementation />\r\n  <SegmentationRulesEnabled>true</SegmentationRulesEnabled>\r\n  <SegmentationSplitAtNewlines>true</SegmentationSplitAtNewlines>\r\n  <SegmentationSplitAtInlineTags>true</SegmentationSplitAtInlineTags>\r\n  <VersionPretranslation>CompareTexts</VersionPretranslation>\r\n  <CompactingOption xmlns=\"\">0</CompactingOption>\r\n  <ModulesVersion />\r\n  <QA />\r\n  <TrimAsianSpacesOnBuild>false</TrimAsianSpacesOnBuild>\r\n  <AppendSpacesOnBuild>false</AppendSpacesOnBuild>\r\n  <InDesignConfiguration xmlns=\"http://www.wordbee.com/config/indesign\">\r\n    <TrimWhitespaces>true</TrimWhitespaces>\r\n    <TrimNoLetterDigit>true</TrimNoLetterDigit>\r\n    <RemoveFormatWhitespaces>true</RemoveFormatWhitespaces>\r\n    <RemoveFormatNoLetterDigit>false</RemoveFormatNoLetterDigit>\r\n    <TextPatterns />\r\n    <TranslateDocProperties>true</TranslateDocProperties>\r\n    <SkipComments>false</SkipComments>\r\n    <IncludeSmartTagFields>false</IncludeSmartTagFields>\r\n    <DoNotTranslateStyles />\r\n    <ExtractHiddenLayers>false</ExtractHiddenLayers>\r\n    <ExtractLockedLayers>true</ExtractLockedLayers>\r\n    <ExtractMasterPages>true</ExtractMasterPages>\r\n    <AsianFontName />\r\n    <AsianFontStyle />\r\n    <DefaultComplexScriptFontName />\r\n    <DefaultComplexScriptFontStyle />\r\n  </InDesignConfiguration>\r\n</ParserConfiguration>\r\n\r\n</ParserConfigurations>\r\n"
}