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="940cc2ff-29c7-481d-84e2-c33e54f31454"><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="727c046b-fb2f-4b11-b005-32f6661d66f6"><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="1c92cf28-4a55-43b8-8930-3663381c88ba"><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="d5293d90-b6a0-4da2-8283-a35c4f0d3291"><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="a72c79c6-cfcc-4f56-8c65-937004ab27a8"><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="3961b207-b765-44b0-a998-cbc385ba6d10"><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. |