Getting Started

Generating API Keys

Calling API Functions

JSON or XML

API Call Rate Limits

Affiliate Accounts

Functions

Types

Merchant Accounts

Functions

Types

GET DynamicTools Function

Retrieves an array of dynamic tools, optionally filtered by one or more properties.

---

Syntax

GET https://api.commissionfactory.com/V1/Merchant/DynamicTools?apiKey=[apiKey]&type=[type]&approved=[approved]

Parameters

Name	Type	Description
apiKey Required	String	A valid API key that represents a merchant account.
type Optional	DynamicToolType	If specified, filters results by type.
approved Optional	Boolean	If specified, filters results by the approved flag.

Return Value

Type	Description
DynamicToolArray	Represents zero or more dynamic tools.

Errors

Error	Description
400 Bad Request	One or more parameters could not be parsed correctly.
401 Unauthorised	The API key is missing, invalid, or for a different account type; or the user account has been suspended or closed.
403 Forbidden	This user does not have permission to call this function.
429 Too Many Requests	The API call rate limit for the user account has been exceeded.
500 Internal Server Error	An unexpected error occurred while processing your request.

Remarks

Commission Factory administrators set permissions allowing or denying individual merchants to work with dynamic tools.

Attempting to work with dynamic tools may result in a 403 Forbidden error for some merchants.

JSON XML

Example

Request

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

GET /V1/Merchant/DynamicTools?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": "Dynamic Tool 1",
        "Type": "Flash Banner",
        "Width": 250,
        "Height": 250,
        "ResourceUrl": "https://www.example.com/FlashBanner1.swf",
        "TargetUrl": "https://www.example.com/",
        "Approved": true
    },
    {
        "Id": 2,
        "DateCreated": "2000-01-01T00:00:00.000",
        "DateModified": "2000-01-01T00:00:00.000",
        "Name": "Dynamic Tool 2",
        "Type": "Flash Banner",
        "Width": 250,
        "Height": 250,
        "ResourceUrl": "https://www.example.com/FlashBanner2.swf",
        "TargetUrl": "https://www.example.com/",
        "Approved": true
    },
    {
        "Id": 3,
        "DateCreated": "2000-01-01T00:00:00.000",
        "DateModified": "2000-01-01T00:00:00.000",
        "Name": "Dynamic Tool 3",
        "Type": "Flash Banner",
        "Width": 250,
        "Height": 250,
        "ResourceUrl": "https://www.example.com/FlashBanner3.swf",
        "TargetUrl": "https://www.example.com/",
        "Approved": false
    }
]

<DynamicToolArray xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://api.commissionfactory.com/V1/Merchant">
    <DynamicTool>
        <Id>1</Id>
        <DateCreated>2000-01-01T00:00:00.000</DateCreated>
        <DateModified>2000-01-01T00:00:00.000</DateModified>
        <Name>Dynamic Tool 1</Name>
        <Type>Flash Banner</Type>
        <Width>250</Width>
        <Height>250</Height>
        <ResourceUrl>https://www.example.com/FlashBanner1.swf</ResourceUrl>
        <TargetUrl>https://www.example.com/</TargetUrl>
        <Approved>true</Approved>
    </DynamicTool>
    <DynamicTool>
        <Id>2</Id>
        <DateCreated>2000-01-01T00:00:00.000</DateCreated>
        <DateModified>2000-01-01T00:00:00.000</DateModified>
        <Name>Dynamic Tool 2</Name>
        <Type>Flash Banner</Type>
        <Width>250</Width>
        <Height>250</Height>
        <ResourceUrl>https://www.example.com/FlashBanner2.swf</ResourceUrl>
        <TargetUrl>https://www.example.com/</TargetUrl>
        <Approved>true</Approved>
    </DynamicTool>
    <DynamicTool>
        <Id>3</Id>
        <DateCreated>2000-01-01T00:00:00.000</DateCreated>
        <DateModified>2000-01-01T00:00:00.000</DateModified>
        <Name>Dynamic Tool 3</Name>
        <Type>Flash Banner</Type>
        <Width>250</Width>
        <Height>250</Height>
        <ResourceUrl>https://www.example.com/FlashBanner3.swf</ResourceUrl>
        <TargetUrl>https://www.example.com/</TargetUrl>
        <Approved>false</Approved>
    </DynamicTool>
</DynamicToolArray>

Related Links

• GET DynamicTools/[id] Function
• DynamicTool Type
• DynamicToolArray Type
• DynamicToolType Enumeration