Common Parameters - ABO - Reference Guides

Back Office Integration Guide

Product
ABO
Platform
7.8
Category
Reference Guides
Language
English
Target Audience
public

Some parameters are used in several AFS Back Office web services. They are explained hereafter.

  • afs:filter allows to filter the output result on several parameters. By default, request without filter trigger all available data.

Example:

...&afs:filter=keyword like "%afs%" or label like "%afs%"

  • afs:sort allows to sort the output result on several parameters.

Example:

...&afs:sort=name,ASC;id,DESC

If necessary (because not supported by Web Client used to do the HTTP requests for example), the following parameters are available.

  • afs:output allows to choose the format of data returned by the API. The possible values are application/xml and application/json.

Example:

... &afs:output=application/json

  • afs:method allows to force HTTP method to use. The possible values are POST, PUT, GET, and DELETE.

Example:

... &afs:method=PUT

It is strongly recommended to use a powerful Web Client such as CURL and avoid usage of these parameters. All usage examples of this guide use CURL.