Getting Started

Generating API Keys

Calling API Functions

JSON or XML

API Call Rate Limits

Affiliate Accounts

Functions

Types

Merchant Accounts

Functions

Types

GET BannerGroups Function

Retrieves an array of banner groups.


Syntax

GET https://api.commissionfactory.com/V1/Merchant/BannerGroups?apiKey=[apiKey]

Parameters

Name Type Description
apiKey
Required
String A valid API key that represents a merchant account.

Return Value

Type Description
BannerGroupArray Represents zero or more banner groups.

Errors

Error Description
401 Unauthorised The API key is missing, invalid, or for a different account type; or the user account has been suspended or closed.
500 Internal Server Error An unexpected error occured while processing your request.
503 Service Unavailable The API call rate limit for the user account has been exceeded.
NOTE: As of 2019-02-01, the response from the server will change:
429 Too Many Requests

JSON XML

Example

Request

GET /V1/Merchant/BannerGroups?apiKey=ABC123 HTTP/1.1
Accept: application/json
Host: api.commissionfactory.com
GET /V1/Merchant/BannerGroups?apiKey=ABC123 HTTP/1.1
Accept: application/xml
Host: api.commissionfactory.com

Response

[
    {
        "Id": 1,
        "DateCreated": "2000-01-01T00:00:00.000",
        "DateModified": "2000-01-01T00:00:00.000",
        "Name": " Default Group",
        "TargetUrl": "https://www.example.com/",
        "ExpiryDate": null
    },
    {
        "Id": 2,
        "DateCreated": "2000-01-01T00:00:00.000",
        "DateModified": "2000-01-01T00:00:00.000",
        "Name": "Summer Sale Banners",
        "TargetUrl": "https://www.example.com/",
        "ExpiryDate": "2000-04-01T00:00:00.000"
    },
    {
        "Id": 3,
        "DateCreated": "2000-01-01T00:00:00.000",
        "DateModified": "2000-01-01T00:00:00.000",
        "Name": "Winter Sale Banners",
        "TargetUrl": "https://www.example.com/",
        "ExpiryDate": null
    }
]
<BannerGroupArray xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://api.commissionfactory.com/V1/Merchant">
    <BannerGroup>
        <Id>1</Id>
        <DateCreated>2000-01-01T00:00:00.000</DateCreated>
        <DateModified>2000-01-01T00:00:00.000</DateModified>
        <Name> Default Group</Name>
        <TargetUrl>https://www.example.com/</TargetUrl>
        <ExpiryDate i:nil="true" />
    </BannerGroup>
    <BannerGroup>
        <Id>2</Id>
        <DateCreated>2000-01-01T00:00:00.000</DateCreated>
        <DateModified>2000-01-01T00:00:00.000</DateModified>
        <Name>Summer Sale Banners</Name>
        <TargetUrl>https://www.example.com/</TargetUrl>
        <ExpiryDate>2000-04-01T00:00:00.000</ExpiryDate>
    </BannerGroup>
    <BannerGroup>
        <Id>3</Id>
        <DateCreated>2000-01-01T00:00:00.000</DateCreated>
        <DateModified>2000-01-01T00:00:00.000</DateModified>
        <Name>Winter Sale Banners</Name>
        <TargetUrl>https://www.example.com/</TargetUrl>
        <ExpiryDate i:nil="true" />
    </BannerGroup>
</BannerGroupArray>

Related Links