Program field settings¶

Parameters¶

HTTP method	Access rights	URL	Note
GET	broker_application	`https://api.admitad.com/broker/campaign_settings/{c_id}/`	List of required application fields and their validation, where с_id is the affiliate program ID.*

Example of use¶

Example of a request with utility ``curl``:

curl -L -H 'Authorization: Bearer access_token' -X GET 'https://api.admitad.com/broker/campaign_settings/{c_id}/'

Example of the response from the API server in the JSON format:

{
    "results": [
        {
            "field_name": "first_name",
            "regexp": "^[a-zA-Z]+$",
            "required": true,
            "description": ""
        },
        {
            "field_name": "last_name",
            "regexp": "^[a-zA-Z]+$",
            "required": true,
            "description": ""
        },
        {
            "field_name": "middle_name",
            "regexp": "",
            "required": true,
            "description": ""
        },
        {
            "field_name": "product_type",
            "regexp": "^[1,3,7,8]{1}$",
            "required": true,
            "description": "1-credit; 3-card; 7-gold-card; 8-platinum-card"
        }
    ]
}

Description of API server response fields¶

Name	Description
field_name	List of request parameters
regexp	Regular value for validation, if empty, then is validated by default value from the list.
required	Mandatory
description	Detailed description