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.
Key |
Key suffix |
|
prefix |
Value |
Suffix |
Description |
||
|---|---|---|---|---|---|---|---|---|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="b1c9b2c4-8650-4fce-866c-30a6b5147b31"><ac:plain-text-body><![CDATA[ |
display |
|
|
|
[field1,field2 …] |
|
Only display fields in brackets |
]]></ac:plain-text-body></ac:structured-macro> |
display |
|
|
|
full |
|
Display all fields |
Key |
Key suffix |
|
prefix |
Value |
Suffix |
Description |
||
|---|---|---|---|---|---|---|---|---|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="6a846602-5fdd-47bd-898c-93c38b3b4453"><ac:plain-text-body><![CDATA[ |
filter |
[field] |
|
|
[value1 |
[value2] |
Filter "field" with value between "value1" and "value2" |
]]></ac:plain-text-body></ac:structured-macro> |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="d7ba56c0-b99e-4089-9300-0c05597fc9ac"><ac:plain-text-body><![CDATA[ |
filter |
[field] |
|
|
[value] |
|
Filter field with the value "value" |
]]></ac:plain-text-body></ac:structured-macro> |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="05da55c3-ef6e-49f1-aa9a-54e68815d2ef"><ac:plain-text-body><![CDATA[ |
filter |
[field] |
|
|
[value1,value2…] |
|
Filter fields for values specified between brackets |
]]></ac:plain-text-body></ac:structured-macro> |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="fe1375db-3a06-4b40-806a-ea56799c3877"><ac:plain-text-body><![CDATA[ |
filter |
[field] |
|
% |
[value] |
% |
Filter "columns" for values containing "value" |
]]></ac:plain-text-body></ac:structured-macro> |
Key |
Key suffix |
|
prefix |
Value |
Suffix |
Description |
||
|---|---|---|---|---|---|---|---|---|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="5cd08c48-d551-4170-a1b0-c5dc65c21acf"><ac:plain-text-body><![CDATA[ |
sort |
|
|
|
[field1_ASC,field2_DESC,field3_ASC] |
|
Sort by field with the suffix _ASC _DESC or in the order |
]]></ac:plain-text-body></ac:structured-macro> |
sort |
|
|
|
full |
|
show all fields |
Key |
Key suffix |
|
prefix |
Value |
Suffix |
Description |
|---|---|---|---|---|---|---|
limit |
|
|
|
Number |
|
Limit the result to "Number" |
limit |
|
|
|
Starting index, Number |
|
Limit the result to "Number" from the "Index" |
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. |