Developer

Page tree

Get pricelists

RequestGET /editor/plugins_matchanalysis_pricingpresetprices
ParamspresetId Required. ID of preset for which you want to get the pricelists
Response 
{
     "metaData": [                // Match rate ranges defined for the preset
        {
            "id": "11",
            "from": "104",
            "till": "104"
        },
        ...
        {
            "id": "15",
            "from": "100",
            "till": "100"
        },
        {
            "id": "16",
            "from": "90",
            "till": "99"
        },
        ...
        {
            "id": "19",
            "from": "60",
            "till": "69"
        }
    ],
    "rows": [

        // Each item in "rows" array is a pricelist for a certain pair of source and target languages
        {
            "id": "1",
            "presetId": "2",
            "sourceLanguageId": "273",
            "targetLanguageId": "274",
            "currency": "\u20ac", // Euro character, i.e €
            "pricesByRangeIds": "{\"11\":0.2,\"12\":0.1,\"13\":0.05,\"14\":0,\"15\":0,\"16\":0,\"17\":0,\"18\":0,\"19\":0}",
            "noMatch": "0.0000",
            "range11": 0.2,
            "range12": 0.1,
            "range13": 0.05,
            "range14": 0,
            "range15": 0,
            "range16": 0,
            "range17": 0,
            "range18": 0,
            "range19": 0
        }
    ],

    // Total quantity of pricelists for the given preset
    "total": 1
}

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. 
Response 
{
    "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_pricingpresetprices/clone
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 current pricelist for each possible combinations of, except the ones for which the pricelist do already exist.

targetLanguageIds Required. 
Response 
{
    "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 pricelist

RequestPUT /editor/plugins_matchanalysis_pricingpresetprices
Params

pricesId Required. ID of pricelist to be edited


currency Optional. Currency of prices. Must be not longer than 3 alphanumeric or $€£¥ characters. Should be either not empty or not mentioned among the params

noMatch Optional. 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=123. Should be a decimal value with up to 4 digits after floating point.

Response 
{
    "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}",
    "noMatch": "0.0000",
    "range11": 0,
    "range12": 0,
    "range13": 0,
    "range14": 0.0010,
    "range15": 0,
    "range16": 0,
    "range17": 0,
    "range18": 0,
    "range19": 0
}

Delete pricelist

RequestDELETE /editor/plugins_matchanalysis_pricingpresetprices
ParamspricesId Required. ID of pricelist to be deleted
Response 
{
    "success": true
}
  • No labels