GET /programapplications

API Overview
Updated on
 
Returns a list of programApplicationItems.  See programApplicationItem element definition in WSDL/XSD. 
This resource requires connectid, nonce, date and signature for authentication. See Authentication documentation for REST and SOAP. Passing authentication information as query parameters for REST is supported.

Notes

Program applications are still returned even after the advertiser program has been paused discontinued. The attribute "active" in the "program" element, indicates whether the program is still active.

Resource URL

XML:   http://api.zanox.com/xml/2011-03-01/programapplications
JSON: http://api.zanox.com/json/2011-03-01/programapplications

Parameters

program
optional

Limits results to a particular program.

Value Type: 
Example Value: 

adspace
optional

Limits results to incentives that have tracking links associated with this ad space.

Value Type: 
Example Value: 

status
optional

Restrict results to program applications with one of the following statuses

Value Type: String

Example Value: "open", "confirmed", "rejected", "deferred", "waiting",
"blocked", "terminated", "canceled", "called", "declined", "deleted"

items
optional

See Paging.

Value Type: 
Example Value: 

page
optional

See Paging.

Value Type: 

Example Value: 

Example Request

REST authentication information must be included in request headers or added as query parameters

https://api.zanox.com/xml/2011-03-01/programapplications?items=1

Example Response


<GetProgramApplicationsResponse xmlns="http://api.zanox.com/namespace/2011-03-01/">
	<page>0</page>
	<items>1</items>
	<total>3</total>
	<programApplicationItems>
		<programApplicationItem id="8203734">
			<program active="true" id="2243">zanox Professional Publisher</program>
			<adspace id="1455403">ZAnox</adspace>
			<status>confirmed</status>
			<createDate>2010-07-07T15:26:19.883+02:00</createDate>
			<allowTpv>false</allowTpv>
		</programApplicationItem>
	</programApplicationItems>
</GetProgramApplicationsResponse>

 

Resource Information

Rate Limited? No
Authentication Requires signature. See
REST Authentication
SOAP Authentication
Response Formats json, xml
HTTP Methods GET
Resource family ProgramApplications
Response Object programApplicationItems
API Version 2011-03-01