API Measure.md

API Measure

• Back API Introdution
• GET measure by ID
• GET list measure
• ADD measure
• UPDATE measue
• 🆕 DELETE measue

Measure by id

Resource URL

https://storencash.com/api/v1_measure.json

Resource Information

• Response formats JSON
• Requires authentication? Yes

Parameters

Name	Require	Type	Description
id	yes	int(10)	default = null. Identifier measure. Primary key.

Example Request

GET /api/v1_measure.json/101 HTTP/1.1
Host: storencash.com
token: 15da7169ee5272b97692ff680cab97f5
Cache-Control: no-cache
Content-Type: application/x-www-form-urlencoded

Example Result

{
    "status": "success",
    "data": {
        "model": {
            "id": 101,
            "measure_short_name": "ШТ",
            "measure_full_name": "ШТУКА",
            "localization_key_short_name": "MEASURES_PCS_SHORT",
            "localization_key_full_name": "MEASURES_PCS_FULL",
            "fraction_digits_number": 3
        }
    }
}

List measure

Resource URL

https://storencash.com/api/v1_measure.json

Resource Information

• Response formats JSON
• Requires authentication? Yes

Parameters

Name	Require	Type	Description
page	no	int(10)	default = 0. Page.
count	no	int(10)	default = 1000. Count models in page. Limit max 1000 models in one request!

Example Request

GET /api/v1_measure.json?page=0&count=2 HTTP/1.1
Host: storencash.com
token: 15da7169ee5272b97692ff680cab97f5
Cache-Control: no-cache
Content-Type: application/x-www-form-urlencoded

Example Result

{
    "status": "success",
    "data": {
        "collection": [
            {
                "id": 101,
                "measure_short_name": "ШТ",
                "measure_full_name": "ШТУКА",
                "localization_key_short_name": "MEASURES_PCS_SHORT",
                "localization_key_full_name": "MEASURES_PCS_FULL",
                "fraction_digits_number": 3
            },
            {
                "id": 102,
                "measure_short_name": "БЛО",
                "measure_full_name": "БЛОК",
                "localization_key_short_name": "MEASURES_BLOCK_SHORT",
                "localization_key_full_name": "MEASURES_BLOCK_FULL",
                "fraction_digits_number": 3
            }
        ],
        "total": 61,
        "count": 2
    }
}

Add measure

Resource URL

https://storencash.com/api/v1_measure.json

Resource Information

• Response formats JSON
• Requires authentication? Yes

Parameters

Name	Require	Type	Description
measure_short_name	no	varchar(3)	default = null. measure short name.
measure_full_name	no	varchar(15)	default = null. measure full name.

Example Request

POST /api/v1_measure.json HTTP/1.1
Host: storencash.com
token: 15da7169ee5272b97692ff680cab97f5
Cache-Control: no-cache
Content-Type: application/x-www-form-urlencoded

measure_full_name=%D0%A6%D0%B8%D1%81%D1%82%D0%B5%D1%80%D0%BD%D0%B0&measure_short_name=%D0%A6%D0%98%D0%A1

Example Result

{
    "status": "success",
    "data": {
        "id": 814
    }
}

Update measure

Resource URL

https://storencash.com/api/v1_measure.json

Resource Information

• Response formats JSON
• Requires authentication? Yes

Parameters

Name	Require	Type	Description
id	yes	int(10)	default = null. Store&Cash Measure identifier.
measure_short_name	no	varchar(3)	default = null. measure short name.
measure_full_name	no	varchar(15)	default = null. measure full name.
localization_key_short_name	no	varchar(40)	default = ''. Ключ локализации для короткого наимеования.
localization_key_full_name	no	varchar(40)	default = ''. Ключ локализации для полного наимеования.
fraction_digits_number	no	int	default = 3. количество знаков дробной части.

Example Request

PUT /api/v1_measure.json/814 HTTP/1.1
Host: storencash.com
token: 61e76bf664a0597144194eeee660cdc9
Cache-Control: no-cache
Content-Type: application/x-www-form-urlencoded

measure_full_name=%D0%A6%D0%B8%D1%81%D1%82%D0%B5%D1%80%D0%BD%D1%8B&measure_short_name=%D0%A6%D0%A1

Example Result

{
    "status": "success",
    "data": {
        "id": 814
    }
}

DELETE measure

Уделение единицы измерения. Проверяется наличие единицы измерения в остатках и номенклатуре, если все условия выполнены - единица измерения удаляется, если нет - выдается соответсвующее сообщение.

Resource URL

https://storencash.com/api/v1_measure.json

Resource Information

• Response formats JSON
• Requires authentication? Yes

Parameters

Name	Require	Type	Description
id	yes	bigint(10)	default = null. Идентификатор удаляемой единицы измерения.

Example Request

DELETE /api/v1_measure.json/101 HTTP/1.1
Host: storencash.com
token: e1ec049b388fbc7f2f9dca44dcbfde06
Cache-Control: no-cache

Example Result

{
    "status": "success",
        "data": {
           "message": "ID:101 deleted"
        }
}

Error codes

Code	Description
'06001'	Единицы измерения с таким ID не существует
'06002'	Единица измерения с таким ID присутсвует в номенклатуре