Child pages
  • Cheat-sheet - Concepts outlined in this tutorial
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

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

Key suffix

 

prefix

Value

Suffix

Description

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="2377a109-22e7-4c64-9c22-71832eb371a6"><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="2dce8f47-1b33-4036-a725-5cf74b8ef9e6"><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="c60598d0-120b-4e96-bb37-ff565f55d818"><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="0f05bc97-38d5-4d47-9f92-8510c3b4e815"><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="75f16ba0-3a51-4d03-a9d4-70bae1e642b9"><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="de4e5204-6723-41a3-9855-d4627c45ef2a"><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"

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.

  • No labels