Child pages
  • Cheat-sheet - Concepts outlined in this tutorial

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

If the URL parameter is specified, no other setting can be used and vice versa.

Options

KeyKey suffix

Value

prefixDescription

Value

Suffix

Description

display

 

 

output_formatXML, JSONChange the output format
ps_methodGET, POST, PUT, DELETEOverride 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

Key suffix

prefix

Value

Suffix

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

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"

...

Key

Value

Description

id_shop

Shop ID

Define the shop to be used as a context for the web service.

id_group_shopGroup shop IDDefine the group shop to be used as a context for the web service.