iRetail PRO hub 1.0.0-m5: organization
2 operations
← All documentation · Source: contracts openapi/hub-v1.yaml at 8000474.
The chain.
Operations
GET
/v1/organization
The chain this hub serves.
operationId
getOrganization · Permission store.read
Parameters
| Name | In | Type | Description |
|---|---|---|---|
IRetail-App
|
header | string |
Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking). |
Responses
-
200OKOrganization -
401Error (spec/API.md).Error -
403Error (spec/API.md).Error
PATCH
/v1/organization
Change the chain's name or default language.
operationId
patchOrganization · Permission store.manage
Parameters
| Name | In | Type | Description |
|---|---|---|---|
IRetail-App
|
header | string |
Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking). |
If-Match
|
header | string |
The version the change is based on. |
Request body required
application/jsonOrganizationPatch
Responses
-
200OKOrganization -
400Error (spec/API.md).Error -
401Error (spec/API.md).Error -
403Error (spec/API.md).Error -
412Error (spec/API.md).Error
Schemas
Organization object
id required
|
string (uuid) |
|
name required
|
LocalizedText |
|
default_language required
|
string |
|
version required
|
integer (int64) |
OrganizationPatch object
name
|
LocalizedText |
|
default_language
|
string |