Get Content List

The format of the expected response. 

• "application/json"
• "application/xml"

If no parameter is set, JSON is the default response given.

The format of the provided content.

• "application/json"
• "application/xml"

If no parameter is set, JSON is the expected content by default.

Super admin, system admin, campaign admin, internal system admin, channel admin and editor can access the API.

API Token of user other than System Admin with user parameter

Not allowed and results in below with response code 400

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
    <ref>108</ref>
    <summary>The requested user does not exist</summary>
</error>

user

User email on behalf of whom the api called. 

 "user": "ua@mi.com"

limit

Maximum number of results to fetch. Default value is 30.

 "limit": "7"

offset

Page number. Default value is 0.

 "offset": "0"

search

Search content titles by this keyword

 "search": "Home"

sort

Allow ascending and descending sorting for a single field.

•  +/-recent: will sort based on the date the content was last modified.
•  +/-mostviewed: will sort based on the number of views of content.
• +/-alphabetical: will sort based on content title.
• +/-recentbydevdate : will sort based on the development date of content.

 "sort": "+alphabetical"

Will return publication content in the given language. If language code is not provided, then results will be shown in the user's language set in their user preferences.

 "language": "en_US"

contenttypes

Filter results by their content type

• Publications = will display publications only.
• Videos = will display videos only.
• Events = will display events only.

"contenttypes" :["Publications","Videos"]

date

"date":{
            "from" : "20180101",
            "to" : "20180101"
        }

usedevelopmentdate

"usedevelopmentdate" : "true"

modules

"modules" : ["HighQ Module"]

keywords

keywords" : ["Mkt", "IT"]

respectpreference

Below are the possible values for this parameter

• Absence of the parameter means - no preference
• 1/user- User Preference and
• 2/channel- Channel Preference (channel id/name must be provided in 'respectpreferencechannel' parameter)

"respectpreference":"2"
"respectpreference":"user"

respectpreferencechannel

When 'offset' is negative or not a number.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
    <ref>106</ref>
    <summary>Invalid parameter: offset</summary>
</error>

When 'limit' is not a positive number.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
    <ref>107</ref>
    <summary>Invalid parameter: limit</summary>
</error>

When  user email passed in 'user' parameter that does not exists

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
    <ref>108</ref>
    <summary>The requested user does not exist</summary>
</error>

When  invalid 'language' parameter is passed

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
    <ref>144</ref>
    <summary>Invalid parameter: language</summary>
</error>

When  invalid 'sort' parameter is passed

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
    <ref>79</ref>
    <summary>Invalid parameter: sort</summary>
</error>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
    <ref>194</ref>
    <summary>Invalid parameter: respectpreference</summary>
</error>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
    <ref>149</ref>
    <summary>From and to date is required</summary>
</error>

When 'to' date is invalid

When 'respectpreference' is set to 'channel' but channel id or name provided in 'respectpreferencechannel' does not exists.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
    <ref>196</ref>
    <summary>Channel does not exist</summary>
</error>

When invalid metadata provided

{
        "contentquery":{
                "limit" : "10",
                "metadata" : {
                        "or" : [
                                        {"name" : "Countrie"}
                        ]
                        
                }
        }        
}

When category is invalid

{
    "contentquery":{
            "limit" : "10",
            "metadata" : {
                "or" : [
                    {
                        "name" : "Countries",
                        "categories" : [
                                {
                                        "name" : "Afri"
                                }        
                        ]
                    }
                ]                    
            }
    }        
}

When label is invalid

{
    "contentquery":{
        "limit" : "10",
        "metadata" : {
            "or" : [
                {
                    "name" : "Countries",
                    "categories" : [
                        {
                                "name" : "Africa",
                                "labels" : [
                                        {
                                                "name" : "Nigeri"
                                        }
                                ]
                        }        
                    ]
                }
            ]
        }
    }        
}

When both and and or list is present under the metadata node

{
    "contentquery":{
        "limit" : "10",
        "metadata" : {
            "or" : [],
            "and" : []
        }
    }        
}

When and/or nesting is more than 2 level

{
    "contentquery":{
        "limit" : "10",
        "metadata" : {
            "or" : [
                {
                    "or" :[
                        {
                            "or" :[
                                    {
                                    }
                            ]                                
                        }
                    ]                
                }
            ]
        }
    }        
}

Metadata queries can not be structured as an 'and' within an 'or'

{
    "contentquery":{
        "limit" : "10",
        "metadata" : {
            "or" : [
                {
                    "and" :[
                        {
                            "name" : "Countries"
                        }
                    ]                
                }
            ]
        }
    }        
}