Cheat-sheet - Concepts outlined in this tutorial
Summary of the available methods in the library
To help you get started with web service, here's a little memo of techniques used in this tutorial.
|
|
| Method parameters |
|
|
|
|---|---|---|---|---|---|---|
| REST | Method | url | resource | id | xml |
C | POST | add | X | X |
| X |
R | GET | get | X | X | X |
|
U | UPDATE | edit | X | X | X | X |
D | DELETE | delete | X | X | X |
|
If the URL parameter is specified, no other setting can be used and vice versa.
Options
Key | Value | Description |
|---|---|---|
| output_format | XML, JSON | Change the output format |
| ps_method | GET, POST, PUT, DELETE | Override the HTTP method used for the request |
display | [field1,field2 …] | Only display fields in brackets |
display | full | Display all fields |
Key | Key suffix | prefix | Value | Suffix | Description |
|---|---|---|---|---|---|
filter | [field] |
| [value1 | [value2] | Filter "field" with value between "value1" and "value2" |
filter | [field] |
| [value] |
| Filter field with the value "value" |
filter | [field] |
| [value1,value2…] |
| Filter fields for values specified between brackets |
filter | [field] | % | [value] | % | Filter "columns" for values containing "value" |
Key | Value | Description |
|---|---|---|
sort | [field1_ASC,field2_DESC,field3_ASC] | Sort by field with the suffix _ASC _DESC or in the order |
sort | full | show all fields |
Key | Value | Description |
|---|---|---|
limit | Number | Limit the result to "Number" |
limit | Starting index, Number | Limit the result to "Number" from the "Index" |
Using the library in multistore mode
In order to use web services in when the multistore feature is enabled, you simply have to add the id_shop parameter.
The shops entity enables you to access to the list of shops as well as their associated identifiers.
Key | Value | Description |
|---|---|---|
id_shop | Shop ID | Define the shop to be used as a context for the web service. |
| id_group_shop | Group shop ID | Define the group shop to be used as a context for the web service. |