Edit

[POST] .../v1/docsetprice/edit

Updates a price setting document. Update price setting document header fields before posting, for example price_type_id, description or the responsible user. The request body must contain id; optional fields update only when their change marker is present: price_type_id 0 means no change, description null means no change, attached_user_id null means no change and attached_user_id 0 clears the responsible user. The document must exist, be unlocked for this caller's change, not be posted and not be deleted; the response returns row_affected for the updated header. The current request user must have price setting document edit permission; missing body, invalid id, missing update fields, denied access, lock conflicts, posted documents or storage failures are returned as HTTP 200 ErrorResult.

Request Parameters

Name Type Required Description
attached_user_id Int64 Optional Responsible user ID. Null means no change, 0 clears the responsible user and a positive value assigns that user.
description String Optional Additional description. Maximum length is 300 characters; null means no change.
id Int64 Required Price setting document ID.
price_type_id Int64 Optional Price type ID. If 0, the stored price type is not changed.

Request Example

{
  "id": 6101,
  "price_type_id": 3,
  "attached_user_id": 5,
  "description": "Updated January retail prices"
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Update Update operation result.

Response Example

{
  "ok": true,
  "result": {
    "row_affected": 1
  }
}