ADDEDIT Advertiser API Version 1

Updated on 2014-05-01
Current Version: Version 1
Deprecated Version: NA
Requests Allowed: GET&SOAP

 

Summary:

Returns "Advertiser ### Created" or "Advertiser ### Updated"


Resource/WSDL Page:

http://<your_domain_here>/api/1/addedit.asmx?op=Advertiser


Parameters

api_key
Required
Type: STRING
Length (Max/Min): 50

Must be a valid API key (existing and NOT expired)

Example Values: Fo35NRAqvFLXoZxqB4aVMhh

advertiser_id
Required
Type: INT
Length (Max/Min): NA

0 creates, > 0 edits.  Advertiser ID [Existing ID = Edit Advertiser / "0" = Create Advertiser]

Example Values: 1234

advertiser_name
Required
Type: STRING
Length (Max/Min): 50

Advertiser Name

Example Values: Advertier Name

third_party_name
Required
Type: STRING
Length (Max/Min): 50

Third Party Name

Example Values: Third Party Name

account_status_id
Required
Type: BYTE
Length (Max/Min): NA

Account Status ID {See get.asmx > AccountStatuses}

Example Values: 1

online_signup
Required
Type: BOOL
Length (Max/Min): NA

Was this an online signup? ["TRUE", "FALSE"]

Example Values: True

signup_ip_address
Required
Type: STRING
Length (Max/Min): 15

IP Address this signup originated from. Required only if online_signup is TRUE.

Example Values: 12.34.789.12

website
Required
Type: STRING
Length (Max/Min): 100

Website

Example Values: www.website.com

billing_cycle_id
Required
Type: BYTE
Length (Max/Min): NA

Billing Cycle ID {See get.asmx > BillingCycles} 0 Skips this field

Example Values: 

account_manager_id
Required
Type: INT
Length (Max/Min): NA

Contact ID from system.  0 skips this field and auto assigns an account manager

Example Values: 123456

address_street
Required
Type: STRING
Length (Max/Min): 60

Street Address.  Only used if all address fields are non-NULL and non-empty

Example Values: 20411 Birch St.

address_street2
Required
Type: STRING
Length (Max/Min): 60

Second street address. Only used if all address fields are non-NULL and non-empty

Example Values: 123 Pacific Coast Highway

address_city
Required
Type: STRING
Length (Max/Min): 30

City of Address.  Only used if all address fields are non-NULL and non-empty

Example Values: Newport Beach

address_state
Required
Type: STRING
Length (Max/Min): 20

State of Address.  Only used if all address fields are non-NULL and non-empty

Example Values: California

address_zip_code
Required
Type: STRING
Length (Max/Min): 10

Zipcode of Address.  Only used if all address fields are non-NULL and non-empty

Example Values: 92657

address_country
Required
Type: STRING
Length (Max/Min): 30

Country of Address.  Only used if all address fields are non-NULL and non-empty

Example Values: United States

notes
Required
Type: STRING
Length (Max/Min): NA

Notes.

Example Values: These are example notes

tags
Required
Type: STRING
Length (Max/Min): NA

This should be a comma separated list of tag names, each tag name cannot exceed 50 characters

Example Values: This is a tag name

 

**Note all optional parameters still need to be passed through in the actual call. These parameters do not need a value (therefore you can use a null value). 

 

Example GET Request


http://demo.cakemarketing.com/api/1/addedit.asmx/Advertiser?api_key=dNJFmId9rI&advertiser_id=0&advertiser_name=Brads%20Example%20Advertiser&third_party_name=Integrate%20an%20external%20system&account_status_id=1&online_signup=FALSE&signup_ip_address=&website=http://google.com&billing_cycle_id=3&account_manager_id=3186&address_street=123%20main%20street&address_street2=&address_city=Fullerton&address_state=CA&address_zip_code=92831&address_country=US&notes=Open%20Text%20&tags=API%20IMported%20Advertiser,value2,%20value3,value4,etc

 

Sample XML Response:

<advertiser_addedit_response>
<success>true</success>
<message>Advertiser 900124 Created</message>
<advertiser_id>900124</advertiser_id>
</advertiser_addedit_response>


Example Error Messages:  

Error Message

Likely Cause

Invalid API Key

API key does not exist or is expired

Invalid Advertiser Name

advertiser_name is NULL or empty or exceeds 50 characters

Invalid Third Party Name

third_party_name exceeds 50 characters

Invalid Account Status

account_status_id is equal to 0 or is not valid

Invalid Signup IP Address

online_signup is true and signup_ip_address is NULL or empty or exceeds 15 characters

Invalid Website

website exceeds 100 characters

Invalid Billing Cycle

billing_cycle_id is not valid

Invalid Account Manager ID

account_manager_id is not valid

Invalid Address Street

address_street exceeds 50 characters

Invalid Address Street 2

address_street2 exceeds 50 characters

Invalid Address City

address_city exceeds 30 characters

Invalid Address State

address_state exceeds 20 characters

Invalid Address Zip Code

address_zip_code exceeds 10 characters

Invalid Address Country

address_country exceeds 30 characters