APIs

GET Tags List

Returns the tags list

Call URL

GET api.commander1.com/api/1.0/manage/container/tags/list?id_site=X&access_token=Y&id_container=Z

Call parameters

URL PARAMETER

TYPE

MANDATORY

DESCRIPTION

id_site

Integer

Yes

Client site identifier

access_token

Alphanum

Yes

Caller’s security identifier

id_container

Integer

No

Container identifier

Return code:

HTTP CODE

MESSAGE

DESCRIPTION

200

OK

The request went through, the result is in the answer’s body

400

Bad Request

The parameters are not ok or mandatory parameters are missing

401

Unauthorized

The security token does not match the site_id or the container_id

404

Not Found

A container identifier for the site_id parameter was not found

500

Internal Server Error

Internal server error

Response format :

The response is in JSON format.

FIELD

TYPE

ALWAYS PRESENT ?

DESCRIPTION

idSite

Integer

Yes

Site identifier

containers

Array

Yes

Array containing the container list and their label

containers/id

Integer

Yes

Container identifier

containers/label

String

Yes

Container label

containers/is_active

Boolean

Yes

Container status (active=true, deleted=false)

tags

Array

Yes

Array containing the tag list and container label

tags/id

Integer

No

Tag identifier

tags/label

String

No

Tag label

GET

Response example

{  
    "idSite":26,
    "containers":[  
        {  
            "id":1,
            "label":"Container1",
            "is_active": true,
            "tags":[  
                {  
                    "id":1,
                    "label":"Click&Site Tracking"
                },
                {  
                    "id":3,
                    "label":"Tagcommander"
                }
            ]
        }
    ]

Last updated