Developer

Page tree

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 13 Next »

Get presets list

RequestGET /editor/plugins_matchanalysis_pricingpreset
Paramsno params needed
Response 
{
    "total": 3,
    "rows": [
        {
            "id": "1",
            "customerId": null,
            "name": "Translate5-Standard",
            "unitType": "word",
            "description": "",
            "priceAdjustment": "0.00",
            "isDefault": "0"
        },
        {
            "id": "2",
            "customerId": null,
            "name": "Some preset",
            "unitType": "word",
            "description": null,
            "priceAdjustment": "0.00",
            "isDefault": "1"
        }
    ],
    ...
}

Create preset

RequestPOST /editor/plugins_matchanalysis_pricingpreset
Params

name Required. Name for the preset, it should be unique across the all presets


customerId Optional. ID of customer. This param should be provided if you want new preset to be customer-specific one
Response 
{
    "success": true,
    "created": {
        "id": "6",
        "customerId": null,
        "name": "Some preset",
        "unitType": "word",
        "description": null,
        "priceAdjustment": "0.00",
        "isDefault": "0"
    }
}

Clone preset

RequestPOST /editor/plugins_matchanalysis_pricingpreset/clone
Params

presetId Required. ID of preset to be cloned


name Required. Name for the clone, it should be unique across the all presets

customerId Optional. ID of customer. This param should be provided if you want new preset to be customer-specific one

Response 
{
    "success": true,
    "clone": {
        "id": "5",
        "customerId": null,
        "name": "Some preset",
        "unitType": "word",
        "description": null,
        "priceAdjustment": "0.00",
        "isDefault": "0"
    }
}

Edit preset

RequestPUT /editor/plugins_matchanalysis_pricingpreset
Params

presetId Required. ID of preset to be edited


name Optional. Name for the preset, it should be unique across the all presets, should be either not empty or not mentioned among the params

unitType=(word|character) 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


priceAdjustment Optional. Value to be appended to final price. Should be a decimal value with up to 2 digits after floating point.

Response 
{
    "success": true,
    "updated": {
        "id": "5",
        "customerId": null,
        "name": "Some preset",
        "unitType": "word",
        "description": "Some description",
        "priceAdjustment": "0.00",
        "isDefault": "0"
    }
}

Set to be default

RequestPUT /editor/plugins_matchanalysis_pricingpreset/setdefault
ParamspresetId Required. ID of preset to be set as default one for it's customer, if it's a customer-specific preset, or to be set as the global default
Response 
{
    "wasDefault": 6 // Id of preset that was the previous default
}

Delete preset

RequestDELETE /editor/plugins_matchanalysis_pricingpreset
ParamspresetId Required. ID of preset to be deleted
Response 
{
    "success": true
}
  • No labels