List Zone layouts

GET /zone-layouts
Copied
Arrow
                https://api.ocamba.com/v2/adex/zone-layouts

Returns a list of Zone layouts

query Parameters
Arrow
Name
Description
fieldsstring
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /VERSION/adex/RESOURCE_NAME?fields=id,name

See "Tips" for the list of filterable parameters.


Example: fields=field1,field2,field3
q_fieldsstring
Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /VERSION/adex/RESOURCE_NAME?q=sou&q_fields=lname → API retuns a certain resource whose lname contains string 'sou'.
GET /VERSION/adex/RESOURCE_NAME?q=sou&q_fields=fname,lname,email → API returns a certain resource that contain string 'sou' in any of the specified fields.

See tips for the list of searchable parameters.
qstring
Set the q parameter value to search for a keyword or search term.

Example:
GET /VERSION/adex/RESOURCE_NAME?q=sou → returns a certain resource that contain string 'sou'

See tips for the list of searchable parameters.
Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ zone-layout ]
An array of all created items.
Zone Layout
Name
Description
contentstring
Layout content.


Example: Content goes here.
create_timestring
Timezone: GMT.


Example: 2021-10-29 12:47:23
descriptionstring
More detailed info about Layout.


Example: Example goes here.
idstring
Layout unique identificator.


Example: banner
layoutstring
Layout unique identificator.


Example: banner
namestring
Layout name.


Example: Banner layout
typestring
Type of the layout.


Example: system
update_timestring
Timezone: GMT.


Example: 2021-10-30 14:27:26
totalinteger
A total number of items.


Example: 8
tip
1 Searchable fields are name and layout.
2 Sortable fields are: name, layout, type, create_time and update_time.
3 Filterable fields are: id, name, layout, type, create_time and update_time.
Response examples
Copied
Arrow
200 Arrow
  • 200
{
  "total": 8,
  "items": [
    {
      "id": "banner",
      "layout": "banner",
      "type": "system",
      "name": "Banner layout",
      "content": "Content goes here.",
      "description": "Example goes here.",
      "create_time": "2021-10-29 12:47:23",
      "update_time": "2021-10-30 14:27:26"
    }
  ]
}