Developer

Page tree

Versions Compared

Old Version 4

changes.mady.by.user Pavel Perminov

Saved on

compared with

New Version 5

changes.mady.by.user Pavel Perminov

Saved on

Key

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

...

Create pricelist(s)

RequestPOST /editor/plugins_matchanalysis_pricingpreset
Params

presetId Required. ID of preset for which you want to create new pricelist(s)


sourceLanguageIds Required. Comma-separated list of IDs of source and target languages to create the pricelist for each possible combinations of, except the ones for which the pricelist do already exist.

targetLanguageIds Required. 


Code Block
languagejs
titleResponse
collapsetrue
{
    "success": true,
    "append": [
        {
            "id": "3",
            "presetId": "2",
            "sourceLanguageId": "273",
            "targetLanguageId": "339",
            "currency": "€",
            "pricesByRangeIds": "{\"11\":0, \"12\":0, \"13\":0, \"14\":0, \"15\":0, \"16\":0, \"17\":0, \"18\":0, \"19\":0}",
            "noMatch": "0.0000",
            "range11": 0,
            "range12": 0,
            "range13": 0,
            "range14": 0,
            "range15": 0,
            "range16": 0,
            "range17": 0,
            "range18": 0,
            "range19": 0
        },
        {
            "id": "4",
            "presetId": "2",
            "sourceLanguageId": "273",
            "targetLanguageId": "340",
            "currency": "€",
            "pricesByRangeIds": "{\"11\":0, \"12\":0, \"13\":0, \"14\":0, \"15\":0, \"16\":0, \"17\":0, \"18\":0, \"19\":0}",
            "noMatch": "0.0000",
            "range11": 0,
            "range12": 0,
            "range13": 0,
            "range14": 0,
            "range15": 0,
            "range16": 0,
            "range17": 0,
            "range18": 0,
            "range19": 0
        },
        {
            "id": "5",
            "presetId": "2",
            "sourceLanguageId": "330",
            "targetLanguageId": "339",
            "currency": "€",
            "pricesByRangeIds": "{\"11\":0, \"12\":0, \"13\":0, \"14\":0, \"15\":0, \"16\":0, \"17\":0, \"18\":0, \"19\":0}",
            "noMatch": "0.0000",
            "range11": 0,
            "range12": 0,
            "range13": 0,
            "range14": 0,
            "range15": 0,
            "range16": 0,
            "range17": 0,
            "range18": 0,
            "range19": 0
        },
        {
            "id": "6",
            "presetId": "2",
            "sourceLanguageId": "330",
            "targetLanguageId": "340",
            "currency": "€",
            "pricesByRangeIds": "{\"11\":0, \"12\":0, \"13\":0, \"14\":0, \"15\":0, \"16\":0, \"17\":0, \"18\":0, \"19\":0}",
            "noMatch": "0.0000",
            "range11": 0,
            "range12": 0,
            "range13": 0,
            "range14": 0,
            "range15": 0,
            "range16": 0,
            "range17": 0,
            "range18": 0,
            "range19": 0
        }
    ]
}



Clone pricelist

RequestPOST /editor/plugins_matchanalysis_pricingpreset
Params

priceId Required. ID of preset pricelist which you want to clone


sourceLanguageIds Required. Comma-separated list of IDs of source and target languages to clone the certain pricelist for each possible combinations of, except the ones for which the pricelist do already exist.

targetLanguageIds Required. 


Code Block
languagejs
titleResponse
collapsetrue
{
    "success": true,
    "append": [
        {
            "id": "3",
            "presetId": "2",
            "sourceLanguageId": "273",
            "targetLanguageId": "339",
            "currency": "€",
            "pricesByRangeIds": "{\"11\":0, \"12\":0, \"13\":0, \"14\":0, \"15\":0, \"16\":0, \"17\":0, \"18\":0, \"19\":0}",
            "noMatch": "0.0000",
            "range11": 0,
            "range12": 0,
            "range13": 0,
            "range14": 0,
            "range15": 0,
            "range16": 0,
            "range17": 0,
            "range18": 0,
            "range19": 0
        },
        {
            "id": "4",
            "presetId": "2",
            "sourceLanguageId": "273",
            "targetLanguageId": "340",
            "currency": "€",
            "pricesByRangeIds": "{\"11\":0, \"12\":0, \"13\":0, \"14\":0, \"15\":0, \"16\":0, \"17\":0, \"18\":0, \"19\":0}",
            "noMatch": "0.0000",
            "range11": 0,
            "range12": 0,
            "range13": 0,
            "range14": 0,
            "range15": 0,
            "range16": 0,
            "range17": 0,
            "range18": 0,
            "range19": 0
        },
        {
            "id": "5",
            "presetId": "2",
            "sourceLanguageId": "330",
            "targetLanguageId": "339",
            "currency": "€",
            "pricesByRangeIds": "{\"11\":0, \"12\":0, \"13\":0, \"14\":0, \"15\":0, \"16\":0, \"17\":0, \"18\":0, \"19\":0}",
            "noMatch": "0.0000",
            "range11": 0,
            "range12": 0,
            "range13": 0,
            "range14": 0,
            "range15": 0,
            "range16": 0,
            "range17": 0,
            "range18": 0,
            "range19": 0
        },
        {
            "id": "6",
            "presetId": "2",
            "sourceLanguageId": "330",
            "targetLanguageId": "340",
            "currency": "€",
            "pricesByRangeIds": "{\"11\":0, \"12\":0, \"13\":0, \"14\":0, \"15\":0, \"16\":0, \"17\":0, \"18\":0, \"19\":0}",
            "noMatch": "0.0000",
            "range11": 0,
            "range12": 0,
            "range13": 0,
            "range14": 0,
            "range15": 0,
            "range16": 0,
            "range17": 0,
            "range18": 0,
            "range19": 0
        }
    ]
}



Edit

preset

pricelist

RequestPUT /editor/plugins_matchanalysis_pricingpresetpricingpresetprices
Params

presetIdpricesId Required. ID of preset pricelist to be edited


name currency Optional. Name for the clone, it should be unique across the all presets, should Currency of prices. Must be not longer than 3 alphanumeric or $€£¥ characters. Should be either not empty or not mentioned among the params

unitType=(word|character)noMatch Optional. Type of units that the preset should be based on, i.e. word-based or character-based

description Optional. Short description for the preset up to 255 characters long

Price for match-rates that do not belong to any range. Should be a decimal value with up to 4 digits after floating point.


range123 Optional. Price for match-rates within the range having ID=123priceAdjustment Optional. Value to be appended to final price. Should be a decimal value with up to 2 4 digits after floating point.

isDefault=(0|1) Optional. Set this preset to be the default one for it's customer, if it's a customer-specific preset, or the generally default


Code Block
languagejs
titleResponse
collapsetrue
{
    "success": true,
	"id": "6",
    "presetId": "2",
    "sourceLanguageId": "330",
    "targetLanguageId": "340",
    "currency": "€",
    "pricesByRangeIds": "{\"11\":0, \"12\":0, \"13\":0, \"14\":0, \"15\":0, \"16\":0, \"17\":0, \"18\":0, \"19\":0}"
Code Block
languagejs
titleResponse
collapsetrue
{
    "success": true,
    "updatednoMatch": {"0.0000",
    "range11": 0,
    "idrange12": "5"0,
        "customerIdrange13": null0,
        "namerange14": "Some preset"0,
        "unitTyperange15": "word"0,
        "descriptionrange16": "asd"0,
        "priceAdjustmentrange17": "0.00",
        "isDefaultrange18": "0",
    }"range19": 0
}



Delete preset

RequestDELETE /editor/plugins_matchanalysis_pricingpreset
ParamspresetId Required. ID of preset to be deleted


Code Block
languagejs
titleResponse
collapsetrue
{
    "success": true
}


...