Child pages
  • Chapter 8 - Advanced Use

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

Table of contents

Table of Contents
maxLevel3

Advanced Use

Rendering Options

Include all fields from the "products" resource.

URL:
« Store URL » (Store URL)/api/products/?display=full PHP 

PHP:

Code Block
$opt = array( 'resource' => 'products', 
              'display'  => 'full' );

Include only the ID of all carriers "carriers"

URL :
« Store URL  » URL: (Store URL)/api/products/ PHP 

PHP :

Code Block
$opt = array( 'resource' => 'products' );

...


Only include the "name"

...

and

...

"value"

...

fields

...

from

...

the

...

"configurations"

...

resource.

...

URL: (Store URL)/api/configurations/?display=\[enEN:name,value\] Wiki Markup\\ \\ PHP :

PHP:

Code Block
$opt = array( 'resource' => 'configurations', 
              'display'  => '

...

[

...

name,value

...

]');

...


Rendering Filters

Only include the first and last names of customers "customers" whose ids are between 1 and 5

URL: (Store URL)/api/customers/?display=\[enEN:firstname,lastname\]&filter\[enEN:id\]=\[1|enEN:5\] \\ \\ PHP : ]

PHP:

Code Block
$opt = array( 'resource'   => 'customers', 
              'display'    => '

...

[

...

firstname,lastname

...

]', 
              'filter

...

[

...

id

...

]' => '

...

[1|

...

5

...

]' );

...


Only include the first and last names of customers "customers"

...

whose

...

ids

...

are

...

between

...

1

...

and

...

10

URL: (Store URL)/api/customers/?display=\[enEN:lastname\]&filter\[enEN:id\]=\[enEN:1,10\] \\ \\ \\ PHP : ]

PHP:

Code Block
$opt = array( 'resource'   =>'customers', 
              'display'    => '

...

[

...

lastname

...

]', 
              'filter

...

[

...

id

...

]' => '

...

[

...

1,10

...

]');

...


Only include the birthday of clients whose name is "John" and whose last name is "Doe"

URL: (Store URL)/api/customers/?display=\[enEN:birthday\]&filter\[enEN:firstname\]=\[enEN:John\]&filter\[enEN:lastname\]=\[enEN:DOE\] \\ \\ \\

PHP:

Code Block
$opt = array( 'resource'     

...

 

...

 

...

 

...

  =>'customers', 
              'display'           => '

...

[

...

birthday

...

]', 
			  'filter

...

[

...

firstname

...

]' => '

...

[

...

John

...

]', 
			  'filter

...

[

...

lastname

...

]'  => '

...

[

...

DOE

...

]' );

...


Only include the names of manufacturers "manufacturers"

...

whose

...

name

...

begins

...

with

...

"Appl"

...

URL: (Store URL)/api/manufacturers/?display=\[enEN:name\]&filter\[enEN:name\]=\[enEN:appl\]% \\ \\ \\ PHP :

PHP:

Code Block
$opt = array( 'resource'     => 'manufacturers', 
              'display'      => '

...

[

...

name

...

]', 
              'filter

...

[

...

name

...

]' => '

...

[

...

appl

...

]%');

...


Sorting Filters

Filter the customers "customers" in alphabetical order according to last name

URL: Store URL/api/customers?display=full&sort=\[enEN:lastname_ASC\] \\ \\ PHP : ]

PHP:

Code Block
$opt = array( 'resource' => 'customers', 
              'display'  => 'full', 
              'sort'     => '

...

[

...

lastname_ASC

...

]' );

Filters to limit rendering

Only include the first 5 states "states"

« Store URL » URL: (Store URL)/api/states/?display=full&limit=5 PHP 

PHP:

Code Block
$opt = array( 'resource' => 'states', 
              'display'  => 'full', 
              'limit'    => '5' );

Only include the first 5 elements starting from the 10th element from the states resource "states"

« Store URL » URL: (Store URL)/api/states/?display=full&limit=9,5 PHP 

PHP:

Code Block
$opt = array( 'resource' => 'states', 
              'display'  => 'full', 
              'limit'    => '9,5' );