Overview
Description
This document contains Web Service descriptions for the following services.
Web Services
| Name | Description |
|---|---|
| Boingnet API | The core API services to allow for pURL and campaign management |
| Boinget Reporting API | The reporting API services allowing for summary, detail, daily and click reports |
Boingnet API Web Service
Description
The core API services to allow for pURL and campaign management
Type
SOAP
Style
Document
See Also
Methods: Boingnet API
Methods
| Name | Description |
|---|---|
| addPurlToCampaign | Add a new pURL to the given campaign |
| deletePurlFromCampaign | Delete a pURL from the given campaign |
| getCampaigns | Get all campaigns for this API key. Use campaigns ids for various reports, getting pURls or getting pages within the campaign |
| getPagesByCampaign | Get all pages that in in the microsite assigned to this campaign. Use the returned page ids for various report functions that require a page id |
| getPurlsFromCampaign | Get all pURL for a given campaign |
| updatePurlToCampaign | Update an existing pURL by providing the new pURL data and pURL id of the recurd you are updating |
Method: addPurlToCampaign
Description
Add a new pURL to the given campaign
Action
http://boingnet.com/addPurlToCampaign
Style
Document
Input (Literal)
The input of this method is the document element tns:addPurlToCampaign having the structure defined by the following table.
| Element | Type | Description |
|---|---|---|
| tns:Key | s:string | API Key |
| tns:CampaignId | s:int | CampaignId to add this pURL to. Use getCampaigns for a list of campaigns associated with this API key |
| tns:FirstName | s:string | First Name |
| tns:LastName | s:string | Last Name |
| tns:City | s:string | City |
| tns:State | s:string | State |
| tns:Zip | s:string | Zip |
| tns:Address | s:string | Street Address |
| tns:Address2 | s:string | Street Address 2 |
| tns:EmailId | s:string | Email address |
| tns:Company | s:string | Company |
| tns:Occupation | s:string | Occupation |
| tns:VarField1 | s:string | Variable Field 1 |
| tns:VarField2 | s:string | Variable Field 2 |
| tns:VarField3 | s:string | Variable Field 3 |
| tns:VarField4 | s:string | Variable Field 4 |
| tns:VarField5 | s:string | Variable Field 5 |
| tns:VarField6 | s:string | Variable Field 6 |
| tns:VarField7 | s:string | Variable Field 7 |
| tns:VarField8 | s:string | Variable Field 8 |
| tns:VarField9 | s:string | Variable Field 9 |
| tns:VarField10 | s:string | Variable Field 10 |
| tns:VarField11 | s:string | Variable Field 11 |
| tns:VarField12 | s:string | Variable Field 12 |
| tns:VarField13 | s:string | Variable Field 13 |
| tns:VarField14 | s:string | Variable Field 14 |
| tns:VarField15 | s:string | Variable Field 15 |
| tns:VarField16 | s:string | Variable Field 16 |
| tns:VarField17 | s:string | Variable Field 17 |
| tns:VarField18 | s:string | Variable Field 18 |
| tns:VarField19 | s:string | Variable Field 19 |
| tns:VarField20 | s:string | Variable Field 20 |
| tns:VarField21 | s:string | Variable Field 21 |
| tns:VarField22 | s:string | Variable Field 22 |
| tns:VarField23 | s:string | Variable Field 23 |
| tns:VarField24 | s:string | Variable Field 24 |
| tns:VarField25 | s:string | Variable Field 25 |
| tns:VarField26 | s:string | Variable Field 26 |
| tns:VarField27 | s:string | Variable Field 27 |
| tns:VarField28 | s:string | Variable Field 28 |
| tns:VarField29 | s:string | Variable Field 29 |
| tns:VarField30 | s:string | Variable Field 30 |
| tns:VarField31 | s:string | Variable Field 31 |
| tns:VarField32 | s:string | Variable Field 32 |
| tns:VarField33 | s:string | Variable Field 33 |
| tns:VarField34 | s:string | Variable Field 34 |
| tns:VarField35 | s:string | Variable Field 35 |
| tns:pURL | s:string | Personal URL to be added to the campaign. The value must be unique to the campaign |
Output (Literal)
The output of this method is the document element tns:addPurlToCampaignResponse having the structure defined by the following table.
| Element | Type | Description |
|---|---|---|
| tns:addPurlToCampaignResult | s:int | |
Method: deletePurlFromCampaign
Description
Delete a pURL from the given campaign
Action
http://boingnet.com/deletePurlFromCampaign
Style
Document
Input (Literal)
The input of this method is the document element tns:deletePurlFromCampaign having the structure defined by the following table.
| Element | Type | Description |
|---|---|---|
| tns:Key | s:string | API Key |
| tns:CampaignId | s:int | Campaign ID to delete this pURL from. Use getCampaigns for a list of campaigns associated with this API key |
| tns:DataId | s:int | DataId of the pURL record to delete from the campaign |
Output (Literal)
The output of this method is the document element tns:deletePurlFromCampaignResponse having the structure defined by the following table.
| Element | Type | Description |
|---|---|---|
| tns:deletePurlFromCampaignResult | s:int | |
Method: getCampaigns
Description
Get all campaigns for this API key. Use campaigns ids for various reports, getting pURls or getting pages within the campaign
Action
http://boingnet.com/getCampaigns
Style
Document
Input (Literal)
The input of this method is the document element tns:getCampaigns having the structure defined by the following table.
| Element | Type | Description |
|---|---|---|
| tns:Key | s:string | API Key |
Output (Literal)
The output of this method is the document element tns:getCampaignsResponse having the structure defined by the following table.
| Element | Type | Description |
|---|---|---|
| tns:getCampaignsResult | s:anyType (restriction) | <xs:element name=”CampaignId” type=”xs:long” minOccurs=”0″/> <xs:element name=”CampaignName” type=”xs:string” minOccurs=”0″/> <xs:element name=”StartDate” type=”xs:dateTime” minOccurs=”0″/> <xs:element name=”MailingListFileName” type=”xs:string” minOccurs=”0″/> <xs:element name=”MyAdspURL” type=”xs:string” minOccurs=”0″/> <xs:element name=”HostedpURL” type=”xs:string” minOccurs=”0″/> <xs:element name=”MicrositeId” type=”xs:long” minOccurs=”0″/> <xs:element name=”ConflictResolutionId” type=”xs:int” minOccurs=”0″/> <xs:element name=”CreateDate” type=”xs:dateTime” minOccurs=”0″/> <xs:element name=”LastUpdateDate” type=”xs:dateTime” minOccurs=”0″/> <xs:element name=”MailingListFolderName” type=”xs:string” minOccurs=”0″/> <xs:element name=”UserId” type=”xs:int” minOccurs=”0″/> <xs:element name=”EmailNotification” type=”xs:int” minOccurs=”0″/> <xs:element name=”SubDomain” type=”xs:string” minOccurs=”0″/> <xs:element name=”DomainType” type=”xs:string” minOccurs=”0″/> <xs:element name=”Status” type=”xs:int” minOccurs=”0″/> <xs:element name=”alertEmail1″ type=”xs:string” minOccurs=”0″/> <xs:element name=”alertEmail2″ type=”xs:string” minOccurs=”0″/> <xs:element name=”SubUserId” type=”xs:int” minOccurs=”0″/> <xs:element name=”SubUserId2″ type=”xs:int” minOccurs=”0″/> <xs:element name=”NightlyEmail” type=”xs:int” minOccurs=”0″/> <xs:element name=”NightlyEmailTo” type=”xs:string” minOccurs=”0″/> <xs:element name=”QRCode” type=”xs:int” minOccurs=”0″/> |
Method: getPagesByCampaign
Description
Get all pages that in in the microsite assigned to this campaign. Use the returned page ids for various report functions that require a page id
Action
http://boingnet.com/getPagesByCampaign
Style
Document
Input (Literal)
The input of this method is the document element tns:getPagesByCampaign having the structure defined by the following table.
| Element | Type | Description |
|---|---|---|
| tns:Key | s:string | API Key |
| tns:CampaignId | s:int | CampaignId to show all microsite pages for. Use getCampaigns for a list of campaigns associated with this API key |
Output (Literal)
The output of this method is the document element tns:getPagesByCampaignResponse having the structure defined by the following table.
| Element | Type | Description |
|---|---|---|
| tns:getPagesByCampaignResult | s:anyType (restriction) | <xs:element name=”PageSrNo” type=”xs:int” minOccurs=”0″/> <xs:element name=”PageName” type=”xs:string” minOccurs=”0″/> |
Method: getPurlsFromCampaign
Description
Get all pURL for a given campaign
Action
http://boingnet.com/getPurlsFromCampaign
Style
Document
Input (Literal)
The input of this method is the document element tns:getPurlsFromCampaign having the structure defined by the following table.
| Element | Type | Description |
|---|---|---|
| tns:Key | s:string | API Key |
| tns:CampaignId | s:int | CampaignId to get all pURLs for. Use getCampaigns for a list of campaigns associated with this API key |
Output (Literal)
The output of this method is the document element tns:getPurlsFromCampaignResponse having the structure defined by the following table.
| Element | Type | Description |
|---|---|---|
| tns:getPurlsFromCampaignResult | s:anyType (restriction) | <xs:element name=”DataId” type=”xs:long” minOccurs=”0″/> <xs:element name=”DataGUID” type=”xs:string” minOccurs=”0″/> <xs:element name=”CampaignId” type=”xs:long” minOccurs=”0″/> <xs:element name=”FirstName” type=”xs:string” minOccurs=”0″/> <xs:element name=”LastName” type=”xs:string” minOccurs=”0″/> <xs:element name=”City” type=”xs:string” minOccurs=”0″/> <xs:element name=”State” type=”xs:string” minOccurs=”0″/> <xs:element name=”Zip” type=”xs:string” minOccurs=”0″/> <xs:element name=”Address” type=”xs:string” minOccurs=”0″/> <xs:element name=”Address2″ type=”xs:string” minOccurs=”0″/> <xs:element name=”EmailId” type=”xs:string” minOccurs=”0″/> <xs:element name=”Company” type=”xs:string” minOccurs=”0″/> <xs:element name=”Occupation” type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField1″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField2″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField3″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField4″ type=”xs:string” minOccurs=”0″/> <xs:element name=”pURL” type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField5″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField6″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField7″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField8″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField9″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField10″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField11″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField12″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField13″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField14″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField15″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField16″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField17″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField18″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField19″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField20″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField21″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField22″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField23″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField24″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField25″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField26″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField27″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField28″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField29″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField30″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField31″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField32″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField33″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField34″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField35″ type=”xs:string” minOccurs=”0″/> <xs:element name=”LastVisited” type=”xs:dateTime” minOccurs=”0″/> |
Method: updatePurlToCampaign
Description
Update an existing pURL by providing the new pURL data and pURL id of the recurd you are updating
Action
http://boingnet.com/updatePurlToCampaign
Style
Document
Input (Literal)
The input of this method is the document element tns:updatePurlToCampaign having the structure defined by the following table.
| Element | Type | Description |
|---|---|---|
| tns:Key | s:string | API Key |
| tns:CampaignId | s:int | CampaignId to update this pURL to. Use getCampaigns for a list of campaigns associated with this API key |
| tns:DataId | s:int | DataId of the pURL record to update to the campaign |
| tns:FirstName | s:string | First Name |
| tns:LastName | s:string | Last Name |
| tns:City | s:string | City |
| tns:State | s:string | State |
| tns:Zip | s:string | Zip |
| tns:Address | s:string | Streeet Address |
| tns:Address2 | s:string | Street Address 2 |
| tns:EmailId | s:string | Email address |
| tns:Company | s:string | Company |
| tns:Occupation | s:string | Occupation |
| tns:VarField1 | s:string | Variable Field 1 |
| tns:VarField2 | s:string | Variable Field 2 |
| tns:VarField3 | s:string | Variable Field 3 |
| tns:VarField4 | s:string | Variable Field 4 |
| tns:VarField5 | s:string | Variable Field 5 |
| tns:VarField6 | s:string | Variable Field 6 |
| tns:VarField7 | s:string | Variable Field 7 |
| tns:VarField8 | s:string | Variable Field 8 |
| tns:VarField9 | s:string | Variable Field 9 |
| tns:VarField10 | s:string | Variable Field 10 |
| tns:VarField11 | s:string | Variable Field 11 |
| tns:VarField12 | s:string | Variable Field 12 |
| tns:VarField13 | s:string | Variable Field 13 |
| tns:VarField14 | s:string | Variable Field 14 |
| tns:VarField15 | s:string | Variable Field 15 |
| tns:VarField16 | s:string | Variable Field 16 |
| tns:VarField17 | s:string | Variable Field 17 |
| tns:VarField18 | s:string | Variable Field 18 |
| tns:VarField19 | s:string | Variable Field 19 |
| tns:VarField20 | s:string | Variable Field 20 |
| tns:VarField21 | s:string | Variable Field 21 |
| tns:VarField22 | s:string | Variable Field 22 |
| tns:VarField23 | s:string | Variable Field 23 |
| tns:VarField24 | s:string | Variable Field 24 |
| tns:VarField25 | s:string | Variable Field 25 |
| tns:VarField26 | s:string | Variable Field 26 |
| tns:VarField27 | s:string | Variable Field 27 |
| tns:VarField28 | s:string | Variable Field 28 |
| tns:VarField29 | s:string | Variable Field 29 |
| tns:VarField30 | s:string | Variable Field 30 |
| tns:VarField31 | s:string | Variable Field 31 |
| tns:VarField32 | s:string | Variable Field 32 |
| tns:VarField33 | s:string | Variable Field 33 |
| tns:VarField34 | s:string | Variable Field 34 |
| tns:VarField35 | s:string | Variable Field 35 |
| tns:pURL | s:string | Personal URL to be updated in the campaign. The value must be unique to the campaign |
Output (Literal)
The output of this method is the document element tns:updatePurlToCampaignResponse having the structure defined by the following table.
| Element | Type | Description |
|---|---|---|
| tns:updatePurlToCampaignResult | s:string | |
Elements: Boingnet API
Elements
| Name | Description |
|---|---|
| tns:addPurlToCampaign | Add a new pURL to the given campaign |
| tns:addPurlToCampaignResponse | On success, returns the number of reords added to the campaign. The result should be 1 |
| tns:addPurlToCampaignResult [element addPurlToCampaignResponse] | |
| tns:Address [element addPurlToCampaign] | Street Address |
| tns:Address [element updatePurlToCampaign] | Streeet Address |
| tns:Address2 [element addPurlToCampaign] | Street Address 2 |
| tns:Address2 [element updatePurlToCampaign] | Street Address 2 |
| tns:CampaignId [element addPurlToCampaign] | CampaignId to add this pURL to. Use getCampaigns for a list of campaigns associated with this API key |
| tns:CampaignId [element deletePurlFromCampaign] | Campaign ID to delete this pURL from. Use getCampaigns for a list of campaigns associated with this API key |
| tns:CampaignId [element getPagesByCampaign] | CampaignId to show all microsite pages for. Use getCampaigns for a list of campaigns associated with this API key |
| tns:CampaignId [element getPurlsFromCampaign] | CampaignId to get all pURLs for. Use getCampaigns for a list of campaigns associated with this API key |
| tns:CampaignId [element updatePurlToCampaign] | CampaignId to update this pURL to. Use getCampaigns for a list of campaigns associated with this API key |
| tns:City [element addPurlToCampaign] | City |
| tns:City [element updatePurlToCampaign] | City |
| tns:Company [element addPurlToCampaign] | Company |
| tns:Company [element updatePurlToCampaign] | Company |
| tns:DataId [element deletePurlFromCampaign] | DataId of the pURL record to delete from the campaign |
| tns:DataId [element updatePurlToCampaign] | DataId of the pURL record to update to the campaign |
| tns:deletePurlFromCampaign | Delete a pURL from the given campaign |
| tns:deletePurlFromCampaignResponse | On success, return value should be 1 |
| tns:deletePurlFromCampaignResult [element deletePurlFromCampaignResponse] | |
| tns:EmailId [element addPurlToCampaign] | Email address |
| tns:EmailId [element updatePurlToCampaign] | Email address |
| tns:FirstName [element addPurlToCampaign] | First Name |
| tns:FirstName [element updatePurlToCampaign] | First Name |
| tns:getCampaigns | Get all campaigns for this API key. Use campaigns ids for various reports, getting pURls or getting pages within the campaign |
| tns:getCampaignsResponse | A dataset containing all campaign information for this API key. |
| tns:getCampaignsResult [element getCampaignsResponse] | <xs:element name=”CampaignId” type=”xs:long” minOccurs=”0″/> <xs:element name=”CampaignName” type=”xs:string” minOccurs=”0″/> <xs:element name=”StartDate” type=”xs:dateTime” minOccurs=”0″/> <xs:element name=”MailingListFileName” type=”xs:string” minOccurs=”0″/> <xs:element name=”MyAdspURL” type=”xs:string” minOccurs=”0″/> <xs:element name=”HostedpURL” type=”xs:string” minOccurs=”0″/> <xs:element name=”MicrositeId” type=”xs:long” minOccurs=”0″/> <xs:element name=”ConflictResolutionId” type=”xs:int” minOccurs=”0″/> <xs:element name=”CreateDate” type=”xs:dateTime” minOccurs=”0″/> <xs:element name=”LastUpdateDate” type=”xs:dateTime” minOccurs=”0″/> <xs:element name=”MailingListFolderName” type=”xs:string” minOccurs=”0″/> <xs:element name=”UserId” type=”xs:int” minOccurs=”0″/> <xs:element name=”EmailNotification” type=”xs:int” minOccurs=”0″/> <xs:element name=”SubDomain” type=”xs:string” minOccurs=”0″/> <xs:element name=”DomainType” type=”xs:string” minOccurs=”0″/> <xs:element name=”Status” type=”xs:int” minOccurs=”0″/> <xs:element name=”alertEmail1″ type=”xs:string” minOccurs=”0″/> <xs:element name=”alertEmail2″ type=”xs:string” minOccurs=”0″/> <xs:element name=”SubUserId” type=”xs:int” minOccurs=”0″/> <xs:element name=”SubUserId2″ type=”xs:int” minOccurs=”0″/> <xs:element name=”NightlyEmail” type=”xs:int” minOccurs=”0″/> <xs:element name=”NightlyEmailTo” type=”xs:string” minOccurs=”0″/> <xs:element name=”QRCode” type=”xs:int” minOccurs=”0″/> |
| tns:getPagesByCampaign | Get all pages that in in the microsite assigned to this campaign. Use the returned page ids for various report functions that require a page id |
| tns:getPagesByCampaignResponse | A dataset containing all page information for the given CampaignId. |
| tns:getPagesByCampaignResult [element getPagesByCampaignResponse] | <xs:element name=”PageSrNo” type=”xs:int” minOccurs=”0″/> <xs:element name=”PageName” type=”xs:string” minOccurs=”0″/> |
| tns:getPurlsFromCampaign | Get all pURL for a given campaign |
| tns:getPurlsFromCampaignResponse | A dataset containing all pURL records for the given CampaignId. |
| tns:getPurlsFromCampaignResult [element getPurlsFromCampaignResponse] | <xs:element name=”DataId” type=”xs:long” minOccurs=”0″/> <xs:element name=”DataGUID” type=”xs:string” minOccurs=”0″/> <xs:element name=”CampaignId” type=”xs:long” minOccurs=”0″/> <xs:element name=”FirstName” type=”xs:string” minOccurs=”0″/> <xs:element name=”LastName” type=”xs:string” minOccurs=”0″/> <xs:element name=”City” type=”xs:string” minOccurs=”0″/> <xs:element name=”State” type=”xs:string” minOccurs=”0″/> <xs:element name=”Zip” type=”xs:string” minOccurs=”0″/> <xs:element name=”Address” type=”xs:string” minOccurs=”0″/> <xs:element name=”Address2″ type=”xs:string” minOccurs=”0″/> <xs:element name=”EmailId” type=”xs:string” minOccurs=”0″/> <xs:element name=”Company” type=”xs:string” minOccurs=”0″/> <xs:element name=”Occupation” type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField1″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField2″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField3″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField4″ type=”xs:string” minOccurs=”0″/> <xs:element name=”pURL” type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField5″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField6″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField7″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField8″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField9″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField10″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField11″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField12″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField13″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField14″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField15″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField16″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField17″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField18″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField19″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField20″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField21″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField22″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField23″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField24″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField25″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField26″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField27″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField28″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField29″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField30″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField31″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField32″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField33″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField34″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField35″ type=”xs:string” minOccurs=”0″/> <xs:element name=”LastVisited” type=”xs:dateTime” minOccurs=”0″/> |
| tns:Key [element addPurlToCampaign] | API Key |
| tns:Key [element deletePurlFromCampaign] | API Key |
| tns:Key [element getCampaigns] | API Key |
| tns:Key [element getPagesByCampaign] | API Key |
| tns:Key [element getPurlsFromCampaign] | API Key |
| tns:Key [element updatePurlToCampaign] | API Key |
| tns:LastName [element addPurlToCampaign] | Last Name |
| tns:LastName [element updatePurlToCampaign] | Last Name |
| tns:Occupation [element addPurlToCampaign] | Occupation |
| tns:Occupation [element updatePurlToCampaign] | Occupation |
| tns:pURL [element addPurlToCampaign] | Personal URL to be added to the campaign. The value must be unique to the campaign |
| tns:pURL [element updatePurlToCampaign] | Personal URL to be updated in the campaign. The value must be unique to the campaign |
| tns:State [element addPurlToCampaign] | State |
| tns:State [element updatePurlToCampaign] | State |
| tns:updatePurlToCampaign | Update an existing pURL by providing the new pURL data and pURL id of the recurd you are updating |
| tns:updatePurlToCampaignResponse | On success, result will return the number of records updated. The value should be 1 |
| tns:updatePurlToCampaignResult [element updatePurlToCampaignResponse] | |
| tns:VarField1 [element addPurlToCampaign] | Variable Field 1 |
| tns:VarField1 [element updatePurlToCampaign] | Variable Field 1 |
| tns:VarField10 [element addPurlToCampaign] | Variable Field 10 |
| tns:VarField10 [element updatePurlToCampaign] | Variable Field 10 |
| tns:VarField11 [element addPurlToCampaign] | Variable Field 11 |
| tns:VarField11 [element updatePurlToCampaign] | Variable Field 11 |
| tns:VarField12 [element addPurlToCampaign] | Variable Field 12 |
| tns:VarField12 [element updatePurlToCampaign] | Variable Field 12 |
| tns:VarField13 [element addPurlToCampaign] | Variable Field 13 |
| tns:VarField13 [element updatePurlToCampaign] | Variable Field 13 |
| tns:VarField14 [element addPurlToCampaign] | Variable Field 14 |
| tns:VarField14 [element updatePurlToCampaign] | Variable Field 14 |
| tns:VarField15 [element addPurlToCampaign] | Variable Field 15 |
| tns:VarField15 [element updatePurlToCampaign] | Variable Field 15 |
| tns:VarField16 [element addPurlToCampaign] | Variable Field 16 |
| tns:VarField16 [element updatePurlToCampaign] | Variable Field 16 |
| tns:VarField17 [element addPurlToCampaign] | Variable Field 17 |
| tns:VarField17 [element updatePurlToCampaign] | Variable Field 17 |
| tns:VarField18 [element addPurlToCampaign] | Variable Field 18 |
| tns:VarField18 [element updatePurlToCampaign] | Variable Field 18 |
| tns:VarField19 [element addPurlToCampaign] | Variable Field 19 |
| tns:VarField19 [element updatePurlToCampaign] | Variable Field 19 |
| tns:VarField2 [element addPurlToCampaign] | Variable Field 2 |
| tns:VarField2 [element updatePurlToCampaign] | Variable Field 2 |
| tns:VarField20 [element addPurlToCampaign] | Variable Field 20 |
| tns:VarField20 [element updatePurlToCampaign] | Variable Field 20 |
| tns:VarField21 [element addPurlToCampaign] | Variable Field 21 |
| tns:VarField21 [element updatePurlToCampaign] | Variable Field 21 |
| tns:VarField22 [element addPurlToCampaign] | Variable Field 22 |
| tns:VarField22 [element updatePurlToCampaign] | Variable Field 22 |
| tns:VarField23 [element addPurlToCampaign] | Variable Field 23 |
| tns:VarField23 [element updatePurlToCampaign] | Variable Field 23 |
| tns:VarField24 [element addPurlToCampaign] | Variable Field 24 |
| tns:VarField24 [element updatePurlToCampaign] | Variable Field 24 |
| tns:VarField25 [element addPurlToCampaign] | Variable Field 25 |
| tns:VarField25 [element updatePurlToCampaign] | Variable Field 25 |
| tns:VarField26 [element addPurlToCampaign] | Variable Field 26 |
| tns:VarField26 [element updatePurlToCampaign] | Variable Field 26 |
| tns:VarField27 [element addPurlToCampaign] | Variable Field 27 |
| tns:VarField27 [element updatePurlToCampaign] | Variable Field 27 |
| tns:VarField28 [element addPurlToCampaign] | Variable Field 28 |
| tns:VarField28 [element updatePurlToCampaign] | Variable Field 28 |
| tns:VarField29 [element addPurlToCampaign] | Variable Field 29 |
| tns:VarField29 [element updatePurlToCampaign] | Variable Field 29 |
| tns:VarField3 [element addPurlToCampaign] | Variable Field 3 |
| tns:VarField3 [element updatePurlToCampaign] | Variable Field 3 |
| tns:VarField30 [element addPurlToCampaign] | Variable Field 30 |
| tns:VarField30 [element updatePurlToCampaign] | Variable Field 30 |
| tns:VarField31 [element addPurlToCampaign] | Variable Field 31 |
| tns:VarField31 [element updatePurlToCampaign] | Variable Field 31 |
| tns:VarField32 [element addPurlToCampaign] | Variable Field 32 |
| tns:VarField32 [element updatePurlToCampaign] | Variable Field 32 |
| tns:VarField33 [element addPurlToCampaign] | Variable Field 33 |
| tns:VarField33 [element updatePurlToCampaign] | Variable Field 33 |
| tns:VarField34 [element addPurlToCampaign] | Variable Field 34 |
| tns:VarField34 [element updatePurlToCampaign] | Variable Field 34 |
| tns:VarField35 [element addPurlToCampaign] | Variable Field 35 |
| tns:VarField35 [element updatePurlToCampaign] | Variable Field 35 |
| tns:VarField4 [element addPurlToCampaign] | Variable Field 4 |
| tns:VarField4 [element updatePurlToCampaign] | Variable Field 4 |
| tns:VarField5 [element addPurlToCampaign] | Variable Field 5 |
| tns:VarField5 [element updatePurlToCampaign] | Variable Field 5 |
| tns:VarField6 [element addPurlToCampaign] | Variable Field 6 |
| tns:VarField6 [element updatePurlToCampaign] | Variable Field 6 |
| tns:VarField7 [element addPurlToCampaign] | Variable Field 7 |
| tns:VarField7 [element updatePurlToCampaign] | Variable Field 7 |
| tns:VarField8 [element addPurlToCampaign] | Variable Field 8 |
| tns:VarField8 [element updatePurlToCampaign] | Variable Field 8 |
| tns:VarField9 [element addPurlToCampaign] | Variable Field 9 |
| tns:VarField9 [element updatePurlToCampaign] | Variable Field 9 |
| tns:Zip [element addPurlToCampaign] | Zip |
| tns:Zip [element updatePurlToCampaign] | Zip |
Element: tns:addPurlToCampaign
Description
Add a new pURL to the given campaign
Derived By
Restricting s:anyType
Content Model
Contains elements as defined in the following table.
| Component | Type | Description |
|---|---|---|
| tns:Key | s:string | API Key |
| tns:CampaignId | s:int | CampaignId to add this pURL to. Use getCampaigns for a list of campaigns associated with this API key |
| tns:FirstName | s:string | First Name |
| tns:LastName | s:string | Last Name |
| tns:City | s:string | City |
| tns:State | s:string | State |
| tns:Zip | s:string | Zip |
| tns:Address | s:string | Street Address |
| tns:Address2 | s:string | Street Address 2 |
| tns:EmailId | s:string | Email address |
| tns:Company | s:string | Company |
| tns:Occupation | s:string | Occupation |
| tns:VarField1 | s:string | Variable Field 1 |
| tns:VarField2 | s:string | Variable Field 2 |
| tns:VarField3 | s:string | Variable Field 3 |
| tns:VarField4 | s:string | Variable Field 4 |
| tns:VarField5 | s:string | Variable Field 5 |
| tns:VarField6 | s:string | Variable Field 6 |
| tns:VarField7 | s:string | Variable Field 7 |
| tns:VarField8 | s:string | Variable Field 8 |
| tns:VarField9 | s:string | Variable Field 9 |
| tns:VarField10 | s:string | Variable Field 10 |
| tns:VarField11 | s:string | Variable Field 11 |
| tns:VarField12 | s:string | Variable Field 12 |
| tns:VarField13 | s:string | Variable Field 13 |
| tns:VarField14 | s:string | Variable Field 14 |
| tns:VarField15 | s:string | Variable Field 15 |
| tns:VarField16 | s:string | Variable Field 16 |
| tns:VarField17 | s:string | Variable Field 17 |
| tns:VarField18 | s:string | Variable Field 18 |
| tns:VarField19 | s:string | Variable Field 19 |
| tns:VarField20 | s:string | Variable Field 20 |
| tns:VarField21 | s:string | Variable Field 21 |
| tns:VarField22 | s:string | Variable Field 22 |
| tns:VarField23 | s:string | Variable Field 23 |
| tns:VarField24 | s:string | Variable Field 24 |
| tns:VarField25 | s:string | Variable Field 25 |
| tns:VarField26 | s:string | Variable Field 26 |
| tns:VarField27 | s:string | Variable Field 27 |
| tns:VarField28 | s:string | Variable Field 28 |
| tns:VarField29 | s:string | Variable Field 29 |
| tns:VarField30 | s:string | Variable Field 30 |
| tns:VarField31 | s:string | Variable Field 31 |
| tns:VarField32 | s:string | Variable Field 32 |
| tns:VarField33 | s:string | Variable Field 33 |
| tns:VarField34 | s:string | Variable Field 34 |
| tns:VarField35 | s:string | Variable Field 35 |
| tns:pURL | s:string | Personal URL to be added to the campaign. The value must be unique to the campaign |
Element: tns:addPurlToCampaignResponse
Description
On success, returns the number of reords added to the campaign. The result should be 1
Derived By
Restricting s:anyType
Content Model
Contains elements as defined in the following table.
| Component | Type | Description |
|---|---|---|
| tns:addPurlToCampaignResult | s:int | |
Element: tns:addPurlToCampaignResult [element addPurlToCampaignResponse]
Element: tns:Address [element addPurlToCampaign]
Element: tns:Address [element updatePurlToCampaign]
Element: tns:Address2 [element addPurlToCampaign]
Element: tns:Address2 [element updatePurlToCampaign]
Description
Street Address 2
Derived By
Type s:string
Referenced By
- Element tns:updatePurlToCampaign
Element: tns:CampaignId [element addPurlToCampaign]
Description
CampaignId to add this pURL to. Use getCampaigns for a list of campaigns associated with this API key
Derived By
Type s:int
Referenced By
- Element tns:addPurlToCampaign
Element: tns:CampaignId [element deletePurlFromCampaign]
Description
Campaign ID to delete this pURL from. Use getCampaigns for a list of campaigns associated with this API key
Derived By
Type s:int
Referenced By
- Element tns:deletePurlFromCampaign
Element: tns:CampaignId [element getPagesByCampaign]
Description
CampaignId to show all microsite pages for. Use getCampaigns for a list of campaigns associated with this API key
Derived By
Type s:int
Referenced By
- Element tns:getPagesByCampaign
Element: tns:CampaignId [element getPurlsFromCampaign]
Description
CampaignId to get all pURLs for. Use getCampaigns for a list of campaigns associated with this API key
Derived By
Type s:int
Referenced By
- Element tns:getPurlsFromCampaign
Element: tns:CampaignId [element updatePurlToCampaign]
Description
CampaignId to update this pURL to. Use getCampaigns for a list of campaigns associated with this API key
Derived By
Type s:int
Referenced By
- Element tns:updatePurlToCampaign
Element: tns:City [element addPurlToCampaign]
Element: tns:City [element updatePurlToCampaign]
Element: tns:Company [element addPurlToCampaign]
Element: tns:Company [element updatePurlToCampaign]
Element: tns:DataId [element deletePurlFromCampaign]
Description
DataId of the pURL record to delete from the campaign
Derived By
Type s:int
Referenced By
- Element tns:deletePurlFromCampaign
Element: tns:DataId [element updatePurlToCampaign]
Description
DataId of the pURL record to update to the campaign
Derived By
Type s:int
Referenced By
- Element tns:updatePurlToCampaign
Element: tns:deletePurlFromCampaign
Description
Delete a pURL from the given campaign
Derived By
Restricting s:anyType
Content Model
Contains elements as defined in the following table.
| Component | Type | Description |
|---|---|---|
| tns:Key | s:string | API Key |
| tns:CampaignId | s:int | Campaign ID to delete this pURL from. Use getCampaigns for a list of campaigns associated with this API key |
| tns:DataId | s:int | DataId of the pURL record to delete from the campaign |
Element: tns:deletePurlFromCampaignResponse
Description
On success, return value should be 1
Derived By
Restricting s:anyType
Content Model
Contains elements as defined in the following table.
| Component | Type | Description |
|---|---|---|
| tns:deletePurlFromCampaignResult | s:int | |
Element: tns:deletePurlFromCampaignResult [element deletePurlFromCampaignResponse]
Element: tns:EmailId [element addPurlToCampaign]
Element: tns:EmailId [element updatePurlToCampaign]
Element: tns:FirstName [element addPurlToCampaign]
Element: tns:FirstName [element updatePurlToCampaign]
Element: tns:getCampaigns
Description
Get all campaigns for this API key. Use campaigns ids for various reports, getting pURls or getting pages within the campaign
Derived By
Restricting s:anyType
Content Model
Contains elements as defined in the following table.
| Component | Type | Description |
|---|---|---|
| tns:Key | s:string | API Key |
Element: tns:getCampaignsResponse
Description
A dataset containing all campaign information for this API key.
Derived By
Restricting s:anyType
Content Model
Contains elements as defined in the following table.
| Component | Type | Description |
|---|---|---|
| tns:getCampaignsResult | s:anyType (restriction) | <xs:element name=”CampaignId” type=”xs:long” minOccurs=”0″/> <xs:element name=”CampaignName” type=”xs:string” minOccurs=”0″/> <xs:element name=”StartDate” type=”xs:dateTime” minOccurs=”0″/> <xs:element name=”MailingListFileName” type=”xs:string” minOccurs=”0″/> <xs:element name=”MyAdspURL” type=”xs:string” minOccurs=”0″/> <xs:element name=”HostedpURL” type=”xs:string” minOccurs=”0″/> <xs:element name=”MicrositeId” type=”xs:long” minOccurs=”0″/> <xs:element name=”ConflictResolutionId” type=”xs:int” minOccurs=”0″/> <xs:element name=”CreateDate” type=”xs:dateTime” minOccurs=”0″/> <xs:element name=”LastUpdateDate” type=”xs:dateTime” minOccurs=”0″/> <xs:element name=”MailingListFolderName” type=”xs:string” minOccurs=”0″/> <xs:element name=”UserId” type=”xs:int” minOccurs=”0″/> <xs:element name=”EmailNotification” type=”xs:int” minOccurs=”0″/> <xs:element name=”SubDomain” type=”xs:string” minOccurs=”0″/> <xs:element name=”DomainType” type=”xs:string” minOccurs=”0″/> <xs:element name=”Status” type=”xs:int” minOccurs=”0″/> <xs:element name=”alertEmail1″ type=”xs:string” minOccurs=”0″/> <xs:element name=”alertEmail2″ type=”xs:string” minOccurs=”0″/> <xs:element name=”SubUserId” type=”xs:int” minOccurs=”0″/> <xs:element name=”SubUserId2″ type=”xs:int” minOccurs=”0″/> <xs:element name=”NightlyEmail” type=”xs:int” minOccurs=”0″/> <xs:element name=”NightlyEmailTo” type=”xs:string” minOccurs=”0″/> <xs:element name=”QRCode” type=”xs:int” minOccurs=”0″/> |
Element: tns:getCampaignsResult [element getCampaignsResponse]
Description
<xs:element name=”CampaignId” type=”xs:long” minOccurs=”0″/>
<xs:element name=”CampaignName” type=”xs:string” minOccurs=”0″/>
<xs:element name=”StartDate” type=”xs:dateTime” minOccurs=”0″/>
<xs:element name=”MailingListFileName” type=”xs:string” minOccurs=”0″/>
<xs:element name=”MyAdspURL” type=”xs:string” minOccurs=”0″/>
<xs:element name=”HostedpURL” type=”xs:string” minOccurs=”0″/>
<xs:element name=”MicrositeId” type=”xs:long” minOccurs=”0″/>
<xs:element name=”ConflictResolutionId” type=”xs:int” minOccurs=”0″/>
<xs:element name=”CreateDate” type=”xs:dateTime” minOccurs=”0″/>
<xs:element name=”LastUpdateDate” type=”xs:dateTime” minOccurs=”0″/>
<xs:element name=”MailingListFolderName” type=”xs:string” minOccurs=”0″/>
<xs:element name=”UserId” type=”xs:int” minOccurs=”0″/>
<xs:element name=”EmailNotification” type=”xs:int” minOccurs=”0″/>
<xs:element name=”SubDomain” type=”xs:string” minOccurs=”0″/>
<xs:element name=”DomainType” type=”xs:string” minOccurs=”0″/>
<xs:element name=”Status” type=”xs:int” minOccurs=”0″/>
<xs:element name=”alertEmail1″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”alertEmail2″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”SubUserId” type=”xs:int” minOccurs=”0″/>
<xs:element name=”SubUserId2″ type=”xs:int” minOccurs=”0″/>
<xs:element name=”NightlyEmail” type=”xs:int” minOccurs=”0″/>
<xs:element name=”NightlyEmailTo” type=”xs:string” minOccurs=”0″/>
<xs:element name=”QRCode” type=”xs:int” minOccurs=”0″/>
Derived By
Restricting s:anyType
Content Model
Contains elements as defined in the following table.
| Component | Type | Description |
|---|---|---|
| s:schema | (none) | |
| any | ||
Referenced By
- Element tns:getCampaignsResponse
Element: tns:getPagesByCampaign
Description
Get all pages that in in the microsite assigned to this campaign. Use the returned page ids for various report functions that require a page id
Derived By
Restricting s:anyType
Content Model
Contains elements as defined in the following table.
| Component | Type | Description |
|---|---|---|
| tns:Key | s:string | API Key |
| tns:CampaignId | s:int | CampaignId to show all microsite pages for. Use getCampaigns for a list of campaigns associated with this API key |
Element: tns:getPagesByCampaignResponse
Description
A dataset containing all page information for the given CampaignId.
Derived By
Restricting s:anyType
Content Model
Contains elements as defined in the following table.
| Component | Type | Description |
|---|---|---|
| tns:getPagesByCampaignResult | s:anyType (restriction) | <xs:element name=”PageSrNo” type=”xs:int” minOccurs=”0″/> <xs:element name=”PageName” type=”xs:string” minOccurs=”0″/> |
Element: tns:getPagesByCampaignResult [element getPagesByCampaignResponse]
Description
<xs:element name=”PageSrNo” type=”xs:int” minOccurs=”0″/>
<xs:element name=”PageName” type=”xs:string” minOccurs=”0″/>
Derived By
Restricting s:anyType
Content Model
Contains elements as defined in the following table.
| Component | Type | Description |
|---|---|---|
| s:schema | (none) | |
| any | ||
Referenced By
- Element tns:getPagesByCampaignResponse
Element: tns:getPurlsFromCampaign
Description
Get all pURL for a given campaign
Derived By
Restricting s:anyType
Content Model
Contains elements as defined in the following table.
| Component | Type | Description |
|---|---|---|
| tns:Key | s:string | API Key |
| tns:CampaignId | s:int | CampaignId to get all pURLs for. Use getCampaigns for a list of campaigns associated with this API key |
Element: tns:getPurlsFromCampaignResponse
Description
A dataset containing all pURL records for the given CampaignId.
Derived By
Restricting s:anyType
Content Model
Contains elements as defined in the following table.
| Component | Type | Description |
|---|---|---|
| tns:getPurlsFromCampaignResult | s:anyType (restriction) | <xs:element name=”DataId” type=”xs:long” minOccurs=”0″/> <xs:element name=”DataGUID” type=”xs:string” minOccurs=”0″/> <xs:element name=”CampaignId” type=”xs:long” minOccurs=”0″/> <xs:element name=”FirstName” type=”xs:string” minOccurs=”0″/> <xs:element name=”LastName” type=”xs:string” minOccurs=”0″/> <xs:element name=”City” type=”xs:string” minOccurs=”0″/> <xs:element name=”State” type=”xs:string” minOccurs=”0″/> <xs:element name=”Zip” type=”xs:string” minOccurs=”0″/> <xs:element name=”Address” type=”xs:string” minOccurs=”0″/> <xs:element name=”Address2″ type=”xs:string” minOccurs=”0″/> <xs:element name=”EmailId” type=”xs:string” minOccurs=”0″/> <xs:element name=”Company” type=”xs:string” minOccurs=”0″/> <xs:element name=”Occupation” type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField1″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField2″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField3″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField4″ type=”xs:string” minOccurs=”0″/> <xs:element name=”pURL” type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField5″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField6″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField7″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField8″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField9″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField10″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField11″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField12″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField13″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField14″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField15″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField16″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField17″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField18″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField19″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField20″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField21″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField22″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField23″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField24″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField25″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField26″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField27″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField28″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField29″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField30″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField31″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField32″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField33″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField34″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField35″ type=”xs:string” minOccurs=”0″/> <xs:element name=”LastVisited” type=”xs:dateTime” minOccurs=”0″/> |
Element: tns:getPurlsFromCampaignResult [element getPurlsFromCampaignResponse]
Description
<xs:element name=”DataId” type=”xs:long” minOccurs=”0″/>
<xs:element name=”DataGUID” type=”xs:string” minOccurs=”0″/>
<xs:element name=”CampaignId” type=”xs:long” minOccurs=”0″/>
<xs:element name=”FirstName” type=”xs:string” minOccurs=”0″/>
<xs:element name=”LastName” type=”xs:string” minOccurs=”0″/>
<xs:element name=”City” type=”xs:string” minOccurs=”0″/>
<xs:element name=”State” type=”xs:string” minOccurs=”0″/>
<xs:element name=”Zip” type=”xs:string” minOccurs=”0″/>
<xs:element name=”Address” type=”xs:string” minOccurs=”0″/>
<xs:element name=”Address2″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”EmailId” type=”xs:string” minOccurs=”0″/>
<xs:element name=”Company” type=”xs:string” minOccurs=”0″/>
<xs:element name=”Occupation” type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField1″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField2″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField3″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField4″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”pURL” type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField5″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField6″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField7″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField8″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField9″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField10″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField11″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField12″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField13″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField14″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField15″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField16″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField17″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField18″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField19″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField20″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField21″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField22″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField23″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField24″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField25″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField26″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField27″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField28″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField29″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField30″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField31″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField32″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField33″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField34″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField35″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”LastVisited” type=”xs:dateTime” minOccurs=”0″/>
Derived By
Restricting s:anyType
Content Model
Contains elements as defined in the following table.
| Component | Type | Description |
|---|---|---|
| s:schema | (none) | |
| any | ||
Referenced By
- Element tns:getPurlsFromCampaignResponse
Element: tns:Key [element addPurlToCampaign]
Element: tns:Key [element deletePurlFromCampaign]
Element: tns:Key [element getCampaigns]
Element: tns:Key [element getPagesByCampaign]
Element: tns:Key [element getPurlsFromCampaign]
Element: tns:Key [element updatePurlToCampaign]
Element: tns:LastName [element addPurlToCampaign]
Element: tns:LastName [element updatePurlToCampaign]
Element: tns:Occupation [element addPurlToCampaign]
Element: tns:Occupation [element updatePurlToCampaign]
Element: tns:pURL [element addPurlToCampaign]
Description
Personal URL to be added to the campaign. The value must be unique to the campaign
Derived By
Type s:string
Referenced By
- Element tns:addPurlToCampaign
Element: tns:pURL [element updatePurlToCampaign]
Description
Personal URL to be updated in the campaign. The value must be unique to the campaign
Derived By
Type s:string
Referenced By
- Element tns:updatePurlToCampaign
Element: tns:State [element addPurlToCampaign]
Element: tns:State [element updatePurlToCampaign]
Element: tns:updatePurlToCampaign
Description
Update an existing pURL by providing the new pURL data and pURL id of the recurd you are updating
Derived By
Restricting s:anyType
Content Model
Contains elements as defined in the following table.
| Component | Type | Description |
|---|---|---|
| tns:Key | s:string | API Key |
| tns:CampaignId | s:int | CampaignId to update this pURL to. Use getCampaigns for a list of campaigns associated with this API key |
| tns:DataId | s:int | DataId of the pURL record to update to the campaign |
| tns:FirstName | s:string | First Name |
| tns:LastName | s:string | Last Name |
| tns:City | s:string | City |
| tns:State | s:string | State |
| tns:Zip | s:string | Zip |
| tns:Address | s:string | Streeet Address |
| tns:Address2 | s:string | Street Address 2 |
| tns:EmailId | s:string | Email address |
| tns:Company | s:string | Company |
| tns:Occupation | s:string | Occupation |
| tns:VarField1 | s:string | Variable Field 1 |
| tns:VarField2 | s:string | Variable Field 2 |
| tns:VarField3 | s:string | Variable Field 3 |
| tns:VarField4 | s:string | Variable Field 4 |
| tns:VarField5 | s:string | Variable Field 5 |
| tns:VarField6 | s:string | Variable Field 6 |
| tns:VarField7 | s:string | Variable Field 7 |
| tns:VarField8 | s:string | Variable Field 8 |
| tns:VarField9 | s:string | Variable Field 9 |
| tns:VarField10 | s:string | Variable Field 10 |
| tns:VarField11 | s:string | Variable Field 11 |
| tns:VarField12 | s:string | Variable Field 12 |
| tns:VarField13 | s:string | Variable Field 13 |
| tns:VarField14 | s:string | Variable Field 14 |
| tns:VarField15 | s:string | Variable Field 15 |
| tns:VarField16 | s:string | Variable Field 16 |
| tns:VarField17 | s:string | Variable Field 17 |
| tns:VarField18 | s:string | Variable Field 18 |
| tns:VarField19 | s:string | Variable Field 19 |
| tns:VarField20 | s:string | Variable Field 20 |
| tns:VarField21 | s:string | Variable Field 21 |
| tns:VarField22 | s:string | Variable Field 22 |
| tns:VarField23 | s:string | Variable Field 23 |
| tns:VarField24 | s:string | Variable Field 24 |
| tns:VarField25 | s:string | Variable Field 25 |
| tns:VarField26 | s:string | Variable Field 26 |
| tns:VarField27 | s:string | Variable Field 27 |
| tns:VarField28 | s:string | Variable Field 28 |
| tns:VarField29 | s:string | Variable Field 29 |
| tns:VarField30 | s:string | Variable Field 30 |
| tns:VarField31 | s:string | Variable Field 31 |
| tns:VarField32 | s:string | Variable Field 32 |
| tns:VarField33 | s:string | Variable Field 33 |
| tns:VarField34 | s:string | Variable Field 34 |
| tns:VarField35 | s:string | Variable Field 35 |
| tns:pURL | s:string | Personal URL to be updated in the campaign. The value must be unique to the campaign |
Element: tns:updatePurlToCampaignResponse
Description
On success, result will return the number of records updated. The value should be 1
Derived By
Restricting s:anyType
Content Model
Contains elements as defined in the following table.
| Component | Type | Description |
|---|---|---|
| tns:updatePurlToCampaignResult | s:string | |
Element: tns:updatePurlToCampaignResult [element updatePurlToCampaignResponse]
Element: tns:VarField1 [element addPurlToCampaign]
Element: tns:VarField1 [element updatePurlToCampaign]
Description
Variable Field 1
Derived By
Type s:string
Referenced By
- Element tns:updatePurlToCampaign
Element: tns:VarField10 [element addPurlToCampaign]
Element: tns:VarField10 [element updatePurlToCampaign]
Description
Variable Field 10
Derived By
Type s:string
Referenced By
- Element tns:updatePurlToCampaign
Element: tns:VarField11 [element addPurlToCampaign]
Element: tns:VarField11 [element updatePurlToCampaign]
Description
Variable Field 11
Derived By
Type s:string
Referenced By
- Element tns:updatePurlToCampaign
Element: tns:VarField12 [element addPurlToCampaign]
Element: tns:VarField12 [element updatePurlToCampaign]
Description
Variable Field 12
Derived By
Type s:string
Referenced By
- Element tns:updatePurlToCampaign
Element: tns:VarField13 [element addPurlToCampaign]
Element: tns:VarField13 [element updatePurlToCampaign]
Description
Variable Field 13
Derived By
Type s:string
Referenced By
- Element tns:updatePurlToCampaign
Element: tns:VarField14 [element addPurlToCampaign]
Element: tns:VarField14 [element updatePurlToCampaign]
Description
Variable Field 14
Derived By
Type s:string
Referenced By
- Element tns:updatePurlToCampaign
Element: tns:VarField15 [element addPurlToCampaign]
Element: tns:VarField15 [element updatePurlToCampaign]
Description
Variable Field 15
Derived By
Type s:string
Referenced By
- Element tns:updatePurlToCampaign
Element: tns:VarField16 [element addPurlToCampaign]
Element: tns:VarField16 [element updatePurlToCampaign]
Description
Variable Field 16
Derived By
Type s:string
Referenced By
- Element tns:updatePurlToCampaign
Element: tns:VarField17 [element addPurlToCampaign]
Element: tns:VarField17 [element updatePurlToCampaign]
Description
Variable Field 17
Derived By
Type s:string
Referenced By
- Element tns:updatePurlToCampaign
Element: tns:VarField18 [element addPurlToCampaign]
Element: tns:VarField18 [element updatePurlToCampaign]
Description
Variable Field 18
Derived By
Type s:string
Referenced By
- Element tns:updatePurlToCampaign
Element: tns:VarField19 [element addPurlToCampaign]
Element: tns:VarField19 [element updatePurlToCampaign]
Description
Variable Field 19
Derived By
Type s:string
Referenced By
- Element tns:updatePurlToCampaign
Element: tns:VarField2 [element addPurlToCampaign]
Element: tns:VarField2 [element updatePurlToCampaign]
Description
Variable Field 2
Derived By
Type s:string
Referenced By
- Element tns:updatePurlToCampaign
Element: tns:VarField20 [element addPurlToCampaign]
Element: tns:VarField20 [element updatePurlToCampaign]
Description
Variable Field 20
Derived By
Type s:string
Referenced By
- Element tns:updatePurlToCampaign
Element: tns:VarField21 [element addPurlToCampaign]
Element: tns:VarField21 [element updatePurlToCampaign]
Description
Variable Field 21
Derived By
Type s:string
Referenced By
- Element tns:updatePurlToCampaign
Element: tns:VarField22 [element addPurlToCampaign]
Element: tns:VarField22 [element updatePurlToCampaign]
Description
Variable Field 22
Derived By
Type s:string
Referenced By
- Element tns:updatePurlToCampaign
Element: tns:VarField23 [element addPurlToCampaign]
Element: tns:VarField23 [element updatePurlToCampaign]
Description
Variable Field 23
Derived By
Type s:string
Referenced By
- Element tns:updatePurlToCampaign
Element: tns:VarField24 [element addPurlToCampaign]
Element: tns:VarField24 [element updatePurlToCampaign]
Description
Variable Field 24
Derived By
Type s:string
Referenced By
- Element tns:updatePurlToCampaign
Element: tns:VarField25 [element addPurlToCampaign]
Element: tns:VarField25 [element updatePurlToCampaign]
Description
Variable Field 25
Derived By
Type s:string
Referenced By
- Element tns:updatePurlToCampaign
Element: tns:VarField26 [element addPurlToCampaign]
Element: tns:VarField26 [element updatePurlToCampaign]
Description
Variable Field 26
Derived By
Type s:string
Referenced By
- Element tns:updatePurlToCampaign
Element: tns:VarField27 [element addPurlToCampaign]
Element: tns:VarField27 [element updatePurlToCampaign]
Description
Variable Field 27
Derived By
Type s:string
Referenced By
- Element tns:updatePurlToCampaign
Element: tns:VarField28 [element addPurlToCampaign]
Element: tns:VarField28 [element updatePurlToCampaign]
Description
Variable Field 28
Derived By
Type s:string
Referenced By
- Element tns:updatePurlToCampaign
Element: tns:VarField29 [element addPurlToCampaign]
Element: tns:VarField29 [element updatePurlToCampaign]
Description
Variable Field 29
Derived By
Type s:string
Referenced By
- Element tns:updatePurlToCampaign
Element: tns:VarField3 [element addPurlToCampaign]
Element: tns:VarField3 [element updatePurlToCampaign]
Description
Variable Field 3
Derived By
Type s:string
Referenced By
- Element tns:updatePurlToCampaign
Element: tns:VarField30 [element addPurlToCampaign]
Element: tns:VarField30 [element updatePurlToCampaign]
Description
Variable Field 30
Derived By
Type s:string
Referenced By
- Element tns:updatePurlToCampaign
Element: tns:VarField31 [element addPurlToCampaign]
Element: tns:VarField31 [element updatePurlToCampaign]
Description
Variable Field 31
Derived By
Type s:string
Referenced By
- Element tns:updatePurlToCampaign
Element: tns:VarField32 [element addPurlToCampaign]
Element: tns:VarField32 [element updatePurlToCampaign]
Description
Variable Field 32
Derived By
Type s:string
Referenced By
- Element tns:updatePurlToCampaign
Element: tns:VarField33 [element addPurlToCampaign]
Element: tns:VarField33 [element updatePurlToCampaign]
Description
Variable Field 33
Derived By
Type s:string
Referenced By
- Element tns:updatePurlToCampaign
Element: tns:VarField34 [element addPurlToCampaign]
Element: tns:VarField34 [element updatePurlToCampaign]
Description
Variable Field 34
Derived By
Type s:string
Referenced By
- Element tns:updatePurlToCampaign
Element: tns:VarField35 [element addPurlToCampaign]
Element: tns:VarField35 [element updatePurlToCampaign]
Description
Variable Field 35
Derived By
Type s:string
Referenced By
- Element tns:updatePurlToCampaign
Element: tns:VarField4 [element addPurlToCampaign]
Element: tns:VarField4 [element updatePurlToCampaign]
Description
Variable Field 4
Derived By
Type s:string
Referenced By
- Element tns:updatePurlToCampaign
Element: tns:VarField5 [element addPurlToCampaign]
Element: tns:VarField5 [element updatePurlToCampaign]
Description
Variable Field 5
Derived By
Type s:string
Referenced By
- Element tns:updatePurlToCampaign
Element: tns:VarField6 [element addPurlToCampaign]
Element: tns:VarField6 [element updatePurlToCampaign]
Description
Variable Field 6
Derived By
Type s:string
Referenced By
- Element tns:updatePurlToCampaign
Element: tns:VarField7 [element addPurlToCampaign]
Element: tns:VarField7 [element updatePurlToCampaign]
Description
Variable Field 7
Derived By
Type s:string
Referenced By
- Element tns:updatePurlToCampaign
Element: tns:VarField8 [element addPurlToCampaign]
Element: tns:VarField8 [element updatePurlToCampaign]
Description
Variable Field 8
Derived By
Type s:string
Referenced By
- Element tns:updatePurlToCampaign
Element: tns:VarField9 [element addPurlToCampaign]
Element: tns:VarField9 [element updatePurlToCampaign]
Description
Variable Field 9
Derived By
Type s:string
Referenced By
- Element tns:updatePurlToCampaign
Element: tns:Zip [element addPurlToCampaign]
Element: tns:Zip [element updatePurlToCampaign]
Boinget Reporting API Web Service
Description
The reporting API services allowing for summary, detail, daily and click reports
Type
SOAP
Style
Document
See Also
Methods: Boinget Reporting API
Methods
| Name | Description |
|---|---|
| reportClickDetailByPage | Get a report showing the click activity for the given campaign and page |
| reportDailyByMonth | Get a daily report of pURL opens and complete for one month given the start date as mm/1/yyyy |
| reportDetailByCampaign | Get a detail report for this campaign for all pages. The DetailType specifies whether to get (1) all activity, (2) just opened pURLs or (3) just completed pURLs |
| reportDetailByPage | Get a detail report for this campaign and the given page. The DetailType specifies whether to get (1) all activity, (2) just opened pURLs or (3) just completed pURLs |
| reportFormDetailByPage | Get a detail form report for this campaign and the given page. The result will include all form questions and answers collected from that page |
| reportSummaryByCampaign | Get a high level summary report for this campaign which includes all page activity |
| reportSummaryByPage | Get a summary report for the given page in this campaign |
Method: reportClickDetailByPage
Description
Get a report showing the click activity for the given campaign and page
Action
http://boingnet.com/reportClickDetailByPage
Style
Document
Input (Literal)
The input of this method is the document element tns:reportClickDetailByPage having the structure defined by the following table.
| Element | Type | Description |
|---|---|---|
| tns:Key | s:string | API Key |
| tns:CampaignId | s:int | CampaignId to generate a report for |
| tns:PageId | s:int | PageId from the microsite to report on. Get PageIds by calling getPagesByCampaign |
Output (Literal)
The output of this method is the document element tns:reportClickDetailByPageResponse having the structure defined by the following table.
| Element | Type | Description |
|---|---|---|
| tns:reportClickDetailByPageResult | s:anyType (restriction) | <xs:element name=”linktext” type=”xs:string” minOccurs=”0″/> <xs:element name=”Uniqueclicks” type=”xs:int” minOccurs=”0″/> <xs:element name=”UniqueNoOfTimesOpened” type=”xs:int” minOccurs=”0″/> <xs:element name=”NoOfTimesClicked” type=”xs:int” minOccurs=”0″/> <xs:element name=”NoOfTimesOpened” type=”xs:int” minOccurs=”0″/> <xs:element name=”VisittoClickRate” type=”xs:string” minOccurs=”0″/> <xs:element name=”UniqueVisittoClickRate” type=”xs:string” minOccurs=”0″/> |
Method: reportDailyByMonth
Description
Get a daily report of pURL opens and complete for one month given the start date as mm/1/yyyy
Action
http://boingnet.com/reportDailyByMonth
Style
Document
Input (Literal)
The input of this method is the document element tns:reportDailyByMonth having the structure defined by the following table.
| Element | Type | Description |
|---|---|---|
| tns:Key | s:string | API Key |
| tns:CampaignId | s:int | CampaignId to generate a report for |
| tns:StartDate | s:string | The start date to report daily activity for that month. Format should be mm/1/yyyy |
Output (Literal)
The output of this method is the document element tns:reportDailyByMonthResponse having the structure defined by the following table.
| Element | Type | Description |
|---|---|---|
| tns:reportDailyByMonthResult | s:anyType (restriction) | <xs:element name=”dates” type=”xs:int” minOccurs=”0″/> <xs:element name=”opened” type=”xs:int” minOccurs=”0″/> <xs:element name=”completed” type=”xs:int” minOccurs=”0″/> |
Method: reportDetailByCampaign
Description
Get a detail report for this campaign for all pages. The DetailType specifies whether to get (1) all activity, (2) just opened pURLs or (3) just completed pURLs
Action
http://boingnet.com/reportDetailByCampaign
Style
Document
Input (Literal)
The input of this method is the document element tns:reportDetailByCampaign having the structure defined by the following table.
| Element | Type | Description |
|---|---|---|
| tns:Key | s:string | API Key |
| tns:CampaignId | s:int | CampaignId to generate a report for |
| tns:DetailType | s:int | Determines what pURL records are returned. 1=Return all records in campaign; 2=Return just the pURLs that were opened; 3=Return just the pURLs that were completed |
Output (Literal)
The output of this method is the document element tns:reportDetailByCampaignResponse having the structure defined by the following table.
| Element | Type | Description |
|---|---|---|
| tns:reportDetailByCampaignResult | s:anyType (restriction) | <xs:element name=”CampaignName” type=”xs:string” minOccurs=”0″/> <xs:element name=”DataId” type=”xs:int” minOccurs=”0″/> <xs:element name=”PageName” type=”xs:string” minOccurs=”0″/> <xs:element name=”CampaignId” type=”xs:int” minOccurs=”0″/> <xs:element name=”UserId” type=”xs:int” minOccurs=”0″/> <xs:element name=”FirstLastName” type=”xs:string” minOccurs=”0″/> <xs:element name=”City” type=”xs:string” minOccurs=”0″/> <xs:element name=”State” type=”xs:string” minOccurs=”0″/> <xs:element name=”Address” type=”xs:string” minOccurs=”0″/> <xs:element name=”Address2″ type=”xs:string” minOccurs=”0″/> <xs:element name=”EmailId” type=”xs:string” minOccurs=”0″/> <xs:element name=”Zip” type=”xs:string” minOccurs=”0″/> <xs:element name=”Company” type=”xs:string” minOccurs=”0″/> <xs:element name=”Occupation” type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField1″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField2″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField3″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField4″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField5″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField6″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField7″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField8″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField9″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField10″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField11″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField12″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField13″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField14″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField15″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField16″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField17″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField18″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField19″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField20″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField21″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField22″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField23″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField24″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField25″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField26″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField27″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField28″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField29″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField30″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField31″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField32″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField33″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField34″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField35″ type=”xs:string” minOccurs=”0″/> <xs:element name=”Openeddate” type=”xs:string” minOccurs=”0″/> <xs:element name=”Completed” type=”xs:string” minOccurs=”0″/> |
Method: reportDetailByPage
Description
Get a detail report for this campaign and the given page. The DetailType specifies whether to get (1) all activity, (2) just opened pURLs or (3) just completed pURLs
Action
http://boingnet.com/reportDetailByPage
Style
Document
Input (Literal)
The input of this method is the document element tns:reportDetailByPage having the structure defined by the following table.
| Element | Type | Description |
|---|---|---|
| tns:Key | s:string | API Key |
| tns:CampaignId | s:int | CampaignId to generate a report for |
| tns:PageId | s:int | PageId from the microsite to report on. Get PageIds by calling getPagesByCampaign |
| tns:DetailType | s:int | Determines what pURL records are returned. 1=Return all records in campaign; 2=Return just the pURLs that were opened; 3=Return just the pURLs that were completed |
Output (Literal)
The output of this method is the document element tns:reportDetailByPageResponse having the structure defined by the following table.
| Element | Type | Description |
|---|---|---|
| tns:reportDetailByPageResult | s:anyType (restriction) | <xs:element name=”CampaignName” type=”xs:string” minOccurs=”0″/> <xs:element name=”DataId” type=”xs:long” minOccurs=”0″/> <xs:element name=”PageName” type=”xs:string” minOccurs=”0″/> <xs:element name=”CampaignId” type=”xs:long” minOccurs=”0″/> <xs:element name=”UserId” type=”xs:int” minOccurs=”0″/> <xs:element name=”FirstLastName” type=”xs:string” minOccurs=”0″/> <xs:element name=”City” type=”xs:string” minOccurs=”0″/> <xs:element name=”State” type=”xs:string” minOccurs=”0″/> <xs:element name=”Address” type=”xs:string” minOccurs=”0″/> <xs:element name=”Address2″ type=”xs:string” minOccurs=”0″/> <xs:element name=”EmailId” type=”xs:string” minOccurs=”0″/> <xs:element name=”Zip” type=”xs:string” minOccurs=”0″/> <xs:element name=”Company” type=”xs:string” minOccurs=”0″/> <xs:element name=”Occupation” type=”xs:string” minOccurs=”0″/> <xs:element name=”Openeddate” type=”xs:string” minOccurs=”0″/> <xs:element name=”Completed” type=”xs:string” minOccurs=”0″/> <xs:element name=”Openeddateraw” type=”xs:dateTime” minOccurs=”0″/> |
Method: reportFormDetailByPage
Description
Get a detail form report for this campaign and the given page. The result will include all form questions and answers collected from that page
Action
http://boingnet.com/reportFormDetailByPage
Style
Document
Input (Literal)
The input of this method is the document element tns:reportFormDetailByPage having the structure defined by the following table.
| Element | Type | Description |
|---|---|---|
| tns:Key | s:string | API Key |
| tns:CampaignId | s:int | CampaignId to generate a report for |
| tns:PageId | s:int | PageId from the microsite to report on. Get PageIds by calling getPagesByCampaign |
Output (Literal)
The output of this method is the document element tns:reportFormDetailByPageResponse having the structure defined by the following table.
| Element | Type | Description |
|---|---|---|
| tns:reportFormDetailByPageResult | s:anyType (restriction) | <xs:element name=”pURL” type=”xs:string” minOccurs=”0″/> <xs:element name=”LastVisited” type=”xs:dateTime” minOccurs=”0″/> <xs:element name=”CompletedDate” type=”xs:dateTime” minOccurs=”0″/> <xs:element name=”FirstName” type=”xs:string” minOccurs=”0″/> <xs:element name=”LastName” type=”xs:string” minOccurs=”0″/> <xs:element name=”Address” type=”xs:string” minOccurs=”0″/> <xs:element name=”Address2″ type=”xs:string” minOccurs=”0″/> <xs:element name=”City” type=”xs:string” minOccurs=”0″/> <xs:element name=”State” type=”xs:string” minOccurs=”0″/> <xs:element name=”Zip” type=”xs:string” minOccurs=”0″/> <xs:element name=”EmailId” type=”xs:string” minOccurs=”0″/> <xs:element name=”Company” type=”xs:string” minOccurs=”0″/> <xs:element name=”Occupation” type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField1″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField2″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField3″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField4″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField5″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField6″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField7″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField8″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField9″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField10″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField11″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField12″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField13″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField14″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField15″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField16″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField17″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField18″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField19″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField20″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField21″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField22″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField23″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField24″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField25″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField26″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField27″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField28″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField29″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField30″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField31″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField32″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField33″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField34″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField35″ type=”xs:string” minOccurs=”0″/> <xs:element name=”SubmitedDate” type=”xs:dateTime” minOccurs=”0″/> <xs:element name=”DataId” type=”xs:int” minOccurs=”0″/> <xs:element name=”hdnFormSubmitURL” type=”xs:string” minOccurs=”0″/> <xs:element name=”Question_Here” type=”xs:string” minOccurs=”0″/> <xs:element name=”Question_Here” type=”xs:string” minOccurs=”0″/> … |
Method: reportSummaryByCampaign
Description
Get a high level summary report for this campaign which includes all page activity
Action
http://boingnet.com/reportSummaryByCampaign
Style
Document
Input (Literal)
The input of this method is the document element tns:reportSummaryByCampaign having the structure defined by the following table.
| Element | Type | Description |
|---|---|---|
| tns:Key | s:string | API Key |
| tns:CampaignId | s:int | CampaignId to generate a report for |
Output (Literal)
The output of this method is the document element tns:reportSummaryByCampaignResponse having the structure defined by the following table.
| Element | Type | Description |
|---|---|---|
| tns:reportSummaryByCampaignResult | s:anyType (restriction) | <xs:element name=”CampaignName” type=”xs:string” minOccurs=”0″/> <xs:element name=”CampaignId” type=”xs:int” minOccurs=”0″/> <xs:element name=”SubDomain” type=”xs:string” minOccurs=”0″/> <xs:element name=”DomainType” type=”xs:string” minOccurs=”0″/> <xs:element name=”Status” type=”xs:string” minOccurs=”0″/> <xs:element name=”MicrositeName” type=”xs:string” minOccurs=”0″/> <xs:element name=”MicrositeId” type=”xs:int” minOccurs=”0″/> <xs:element name=”total” type=”xs:int” minOccurs=”0″/> <xs:element name=”Views” type=”xs:decimal” minOccurs=”0″/> <xs:element name=”Ziptotal” type=”xs:int” minOccurs=”0″/> <xs:element name=”statetotal” type=”xs:int” minOccurs=”0″/> <xs:element name=”openedDate” type=”xs:string” minOccurs=”0″/> <xs:element name=”OpendPURL” type=”xs:int” minOccurs=”0″/> <xs:element name=”completed” type=”xs:int” minOccurs=”0″/> <xs:element name=”submited” type=”xs:decimal” minOccurs=”0″/> <xs:element name=”PageName” type=”xs:string” minOccurs=”0″/> <xs:element name=”Audience” type=”xs:int” minOccurs=”0″/> <xs:element name=”PurlVisits” type=”xs:int” minOccurs=”0″/> <xs:element name=”ResponseRate” type=”xs:decimal” minOccurs=”0″/> <xs:element name=”UniquePurlVisits” type=”xs:int” minOccurs=”0″/> <xs:element name=”UniqueResponseRate” type=”xs:decimal” minOccurs=”0″/> <xs:element name=”NoOfVisitsUniqueVisits” type=”xs:int” minOccurs=”0″/> <xs:element name=”NoOfSurveyCompleted” type=”xs:int” minOccurs=”0″/> <xs:element name=”MailingListFolderName” type=”xs:string” minOccurs=”0″/> <xs:element name=”MailingListFileName” type=”xs:string” minOccurs=”0″/> <xs:element name=”CreateDate” type=”xs:string” minOccurs=”0″/> |
Method: reportSummaryByPage
Description
Get a summary report for the given page in this campaign
Action
http://boingnet.com/reportSummaryByPage
Style
Document
Input (Literal)
The input of this method is the document element tns:reportSummaryByPage having the structure defined by the following table.
| Element | Type | Description |
|---|---|---|
| tns:Key | s:string | API Key |
| tns:CampaignId | s:int | CampaignId to generate a report for |
| tns:PageId | s:int | PageId from the microsite to report on. Get PageIds by calling getPagesByCampaign |
Output (Literal)
The output of this method is the document element tns:reportSummaryByPageResponse having the structure defined by the following table.
| Element | Type | Description |
|---|---|---|
| tns:reportSummaryByPageResult | s:anyType (restriction) | <xs:element name=”CampaignName” type=”xs:string” minOccurs=”0″/> <xs:element name=”CampaignId” type=”xs:int” minOccurs=”0″/> <xs:element name=”SubDomain” type=”xs:string” minOccurs=”0″/> <xs:element name=”DomainType” type=”xs:string” minOccurs=”0″/> <xs:element name=”Status” type=”xs:string” minOccurs=”0″/> <xs:element name=”MicrositeName” type=”xs:string” minOccurs=”0″/> <xs:element name=”MicrositeId” type=”xs:int” minOccurs=”0″/> <xs:element name=”total” type=”xs:int” minOccurs=”0″/> <xs:element name=”PageName” type=”xs:string” minOccurs=”0″/> <xs:element name=”Views” type=”xs:decimal” minOccurs=”0″/> <xs:element name=”Ziptotal” type=”xs:int” minOccurs=”0″/> <xs:element name=”statetotal” type=”xs:int” minOccurs=”0″/> <xs:element name=”openedDate” type=”xs:string” minOccurs=”0″/> <xs:element name=”OpendPURL” type=”xs:int” minOccurs=”0″/> <xs:element name=”completed” type=”xs:int” minOccurs=”0″/> <xs:element name=”submited” type=”xs:decimal” minOccurs=”0″/> <xs:element name=”PageName1″ type=”xs:string” minOccurs=”0″/> <xs:element name=”Audience” type=”xs:int” minOccurs=”0″/> <xs:element name=”PurlVisits” type=”xs:int” minOccurs=”0″/> <xs:element name=”ResponseRate” type=”xs:decimal” minOccurs=”0″/> <xs:element name=”UniquePurlVisits” type=”xs:int” minOccurs=”0″/> <xs:element name=”UniqueResponseRate” type=”xs:decimal” minOccurs=”0″/> <xs:element name=”NoOfVisitsUniqueVisits” type=”xs:int” minOccurs=”0″/> <xs:element name=”NoOfSurveyCompleted” type=”xs:int” minOccurs=”0″/> <xs:element name=”MailingListFolderName” type=”xs:string” minOccurs=”0″/> <xs:element name=”MailingListFileName” type=”xs:string” minOccurs=”0″/> <xs:element name=”CreateDate” type=”xs:string” minOccurs=”0″/> |
Elements: Boinget Reporting API
Elements
| Name | Description |
|---|---|
| tns:CampaignId [element reportClickDetailByPage] | CampaignId to generate a report for |
| tns:CampaignId [element reportDailyByMonth] | CampaignId to generate a report for |
| tns:CampaignId [element reportDetailByCampaign] | CampaignId to generate a report for |
| tns:CampaignId [element reportDetailByPage] | CampaignId to generate a report for |
| tns:CampaignId [element reportFormDetailByPage] | CampaignId to generate a report for |
| tns:CampaignId [element reportSummaryByCampaign] | CampaignId to generate a report for |
| tns:CampaignId [element reportSummaryByPage] | CampaignId to generate a report for |
| tns:DetailType [element reportDetailByCampaign] | Determines what pURL records are returned. 1=Return all records in campaign; 2=Return just the pURLs that were opened; 3=Return just the pURLs that were completed |
| tns:DetailType [element reportDetailByPage] | Determines what pURL records are returned. 1=Return all records in campaign; 2=Return just the pURLs that were opened; 3=Return just the pURLs that were completed |
| tns:Key [element reportClickDetailByPage] | API Key |
| tns:Key [element reportDailyByMonth] | API Key |
| tns:Key [element reportDetailByCampaign] | API Key |
| tns:Key [element reportDetailByPage] | API Key |
| tns:Key [element reportFormDetailByPage] | API Key |
| tns:Key [element reportSummaryByCampaign] | API Key |
| tns:Key [element reportSummaryByPage] | API Key |
| tns:PageId [element reportClickDetailByPage] | PageId from the microsite to report on. Get PageIds by calling getPagesByCampaign |
| tns:PageId [element reportDetailByPage] | PageId from the microsite to report on. Get PageIds by calling getPagesByCampaign |
| tns:PageId [element reportFormDetailByPage] | PageId from the microsite to report on. Get PageIds by calling getPagesByCampaign |
| tns:PageId [element reportSummaryByPage] | PageId from the microsite to report on. Get PageIds by calling getPagesByCampaign |
| tns:reportClickDetailByPage | Get a report showing the click activity for the given campaign and page |
| tns:reportClickDetailByPageResponse | Dataset containing report details |
| tns:reportClickDetailByPageResult [element reportClickDetailByPageResponse] | <xs:element name=”linktext” type=”xs:string” minOccurs=”0″/> <xs:element name=”Uniqueclicks” type=”xs:int” minOccurs=”0″/> <xs:element name=”UniqueNoOfTimesOpened” type=”xs:int” minOccurs=”0″/> <xs:element name=”NoOfTimesClicked” type=”xs:int” minOccurs=”0″/> <xs:element name=”NoOfTimesOpened” type=”xs:int” minOccurs=”0″/> <xs:element name=”VisittoClickRate” type=”xs:string” minOccurs=”0″/> <xs:element name=”UniqueVisittoClickRate” type=”xs:string” minOccurs=”0″/> |
| tns:reportDailyByMonth | Get a daily report of pURL opens and complete for one month given the start date as mm/1/yyyy |
| tns:reportDailyByMonthResponse | Dataset containing report details |
| tns:reportDailyByMonthResult [element reportDailyByMonthResponse] | <xs:element name=”dates” type=”xs:int” minOccurs=”0″/> <xs:element name=”opened” type=”xs:int” minOccurs=”0″/> <xs:element name=”completed” type=”xs:int” minOccurs=”0″/> |
| tns:reportDetailByCampaign | Get a detail report for this campaign for all pages. The DetailType specifies whether to get (1) all activity, (2) just opened pURLs or (3) just completed pURLs |
| tns:reportDetailByCampaignResponse | Dataset containing report details |
| tns:reportDetailByCampaignResult [element reportDetailByCampaignResponse] | <xs:element name=”CampaignName” type=”xs:string” minOccurs=”0″/> <xs:element name=”DataId” type=”xs:int” minOccurs=”0″/> <xs:element name=”PageName” type=”xs:string” minOccurs=”0″/> <xs:element name=”CampaignId” type=”xs:int” minOccurs=”0″/> <xs:element name=”UserId” type=”xs:int” minOccurs=”0″/> <xs:element name=”FirstLastName” type=”xs:string” minOccurs=”0″/> <xs:element name=”City” type=”xs:string” minOccurs=”0″/> <xs:element name=”State” type=”xs:string” minOccurs=”0″/> <xs:element name=”Address” type=”xs:string” minOccurs=”0″/> <xs:element name=”Address2″ type=”xs:string” minOccurs=”0″/> <xs:element name=”EmailId” type=”xs:string” minOccurs=”0″/> <xs:element name=”Zip” type=”xs:string” minOccurs=”0″/> <xs:element name=”Company” type=”xs:string” minOccurs=”0″/> <xs:element name=”Occupation” type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField1″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField2″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField3″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField4″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField5″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField6″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField7″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField8″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField9″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField10″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField11″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField12″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField13″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField14″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField15″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField16″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField17″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField18″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField19″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField20″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField21″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField22″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField23″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField24″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField25″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField26″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField27″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField28″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField29″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField30″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField31″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField32″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField33″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField34″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField35″ type=”xs:string” minOccurs=”0″/> <xs:element name=”Openeddate” type=”xs:string” minOccurs=”0″/> <xs:element name=”Completed” type=”xs:string” minOccurs=”0″/> |
| tns:reportDetailByPage | Get a detail report for this campaign and the given page. The DetailType specifies whether to get (1) all activity, (2) just opened pURLs or (3) just completed pURLs |
| tns:reportDetailByPageResponse | Dataset containing report details |
| tns:reportDetailByPageResult [element reportDetailByPageResponse] | <xs:element name=”CampaignName” type=”xs:string” minOccurs=”0″/> <xs:element name=”DataId” type=”xs:long” minOccurs=”0″/> <xs:element name=”PageName” type=”xs:string” minOccurs=”0″/> <xs:element name=”CampaignId” type=”xs:long” minOccurs=”0″/> <xs:element name=”UserId” type=”xs:int” minOccurs=”0″/> <xs:element name=”FirstLastName” type=”xs:string” minOccurs=”0″/> <xs:element name=”City” type=”xs:string” minOccurs=”0″/> <xs:element name=”State” type=”xs:string” minOccurs=”0″/> <xs:element name=”Address” type=”xs:string” minOccurs=”0″/> <xs:element name=”Address2″ type=”xs:string” minOccurs=”0″/> <xs:element name=”EmailId” type=”xs:string” minOccurs=”0″/> <xs:element name=”Zip” type=”xs:string” minOccurs=”0″/> <xs:element name=”Company” type=”xs:string” minOccurs=”0″/> <xs:element name=”Occupation” type=”xs:string” minOccurs=”0″/> <xs:element name=”Openeddate” type=”xs:string” minOccurs=”0″/> <xs:element name=”Completed” type=”xs:string” minOccurs=”0″/> <xs:element name=”Openeddateraw” type=”xs:dateTime” minOccurs=”0″/> |
| tns:reportFormDetailByPage | Get a detail form report for this campaign and the given page. The result will include all form questions and answers collected from that page |
| tns:reportFormDetailByPageResponse | Dataset containing report details |
| tns:reportFormDetailByPageResult [element reportFormDetailByPageResponse] | <xs:element name=”pURL” type=”xs:string” minOccurs=”0″/> <xs:element name=”LastVisited” type=”xs:dateTime” minOccurs=”0″/> <xs:element name=”CompletedDate” type=”xs:dateTime” minOccurs=”0″/> <xs:element name=”FirstName” type=”xs:string” minOccurs=”0″/> <xs:element name=”LastName” type=”xs:string” minOccurs=”0″/> <xs:element name=”Address” type=”xs:string” minOccurs=”0″/> <xs:element name=”Address2″ type=”xs:string” minOccurs=”0″/> <xs:element name=”City” type=”xs:string” minOccurs=”0″/> <xs:element name=”State” type=”xs:string” minOccurs=”0″/> <xs:element name=”Zip” type=”xs:string” minOccurs=”0″/> <xs:element name=”EmailId” type=”xs:string” minOccurs=”0″/> <xs:element name=”Company” type=”xs:string” minOccurs=”0″/> <xs:element name=”Occupation” type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField1″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField2″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField3″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField4″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField5″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField6″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField7″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField8″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField9″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField10″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField11″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField12″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField13″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField14″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField15″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField16″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField17″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField18″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField19″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField20″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField21″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField22″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField23″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField24″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField25″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField26″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField27″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField28″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField29″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField30″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField31″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField32″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField33″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField34″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField35″ type=”xs:string” minOccurs=”0″/> <xs:element name=”SubmitedDate” type=”xs:dateTime” minOccurs=”0″/> <xs:element name=”DataId” type=”xs:int” minOccurs=”0″/> <xs:element name=”hdnFormSubmitURL” type=”xs:string” minOccurs=”0″/> <xs:element name=”Question_Here” type=”xs:string” minOccurs=”0″/> <xs:element name=”Question_Here” type=”xs:string” minOccurs=”0″/> … |
| tns:reportSummaryByCampaign | Get a high level summary report for this campaign which includes all page activity |
| tns:reportSummaryByCampaignResponse | Dataset containing report details |
| tns:reportSummaryByCampaignResult [element reportSummaryByCampaignResponse] | <xs:element name=”CampaignName” type=”xs:string” minOccurs=”0″/> <xs:element name=”CampaignId” type=”xs:int” minOccurs=”0″/> <xs:element name=”SubDomain” type=”xs:string” minOccurs=”0″/> <xs:element name=”DomainType” type=”xs:string” minOccurs=”0″/> <xs:element name=”Status” type=”xs:string” minOccurs=”0″/> <xs:element name=”MicrositeName” type=”xs:string” minOccurs=”0″/> <xs:element name=”MicrositeId” type=”xs:int” minOccurs=”0″/> <xs:element name=”total” type=”xs:int” minOccurs=”0″/> <xs:element name=”Views” type=”xs:decimal” minOccurs=”0″/> <xs:element name=”Ziptotal” type=”xs:int” minOccurs=”0″/> <xs:element name=”statetotal” type=”xs:int” minOccurs=”0″/> <xs:element name=”openedDate” type=”xs:string” minOccurs=”0″/> <xs:element name=”OpendPURL” type=”xs:int” minOccurs=”0″/> <xs:element name=”completed” type=”xs:int” minOccurs=”0″/> <xs:element name=”submited” type=”xs:decimal” minOccurs=”0″/> <xs:element name=”PageName” type=”xs:string” minOccurs=”0″/> <xs:element name=”Audience” type=”xs:int” minOccurs=”0″/> <xs:element name=”PurlVisits” type=”xs:int” minOccurs=”0″/> <xs:element name=”ResponseRate” type=”xs:decimal” minOccurs=”0″/> <xs:element name=”UniquePurlVisits” type=”xs:int” minOccurs=”0″/> <xs:element name=”UniqueResponseRate” type=”xs:decimal” minOccurs=”0″/> <xs:element name=”NoOfVisitsUniqueVisits” type=”xs:int” minOccurs=”0″/> <xs:element name=”NoOfSurveyCompleted” type=”xs:int” minOccurs=”0″/> <xs:element name=”MailingListFolderName” type=”xs:string” minOccurs=”0″/> <xs:element name=”MailingListFileName” type=”xs:string” minOccurs=”0″/> <xs:element name=”CreateDate” type=”xs:string” minOccurs=”0″/> |
| tns:reportSummaryByPage | Get a summary report for the given page in this campaign |
| tns:reportSummaryByPageResponse | Dataset containing report details |
| tns:reportSummaryByPageResult [element reportSummaryByPageResponse] | <xs:element name=”CampaignName” type=”xs:string” minOccurs=”0″/> <xs:element name=”CampaignId” type=”xs:int” minOccurs=”0″/> <xs:element name=”SubDomain” type=”xs:string” minOccurs=”0″/> <xs:element name=”DomainType” type=”xs:string” minOccurs=”0″/> <xs:element name=”Status” type=”xs:string” minOccurs=”0″/> <xs:element name=”MicrositeName” type=”xs:string” minOccurs=”0″/> <xs:element name=”MicrositeId” type=”xs:int” minOccurs=”0″/> <xs:element name=”total” type=”xs:int” minOccurs=”0″/> <xs:element name=”PageName” type=”xs:string” minOccurs=”0″/> <xs:element name=”Views” type=”xs:decimal” minOccurs=”0″/> <xs:element name=”Ziptotal” type=”xs:int” minOccurs=”0″/> <xs:element name=”statetotal” type=”xs:int” minOccurs=”0″/> <xs:element name=”openedDate” type=”xs:string” minOccurs=”0″/> <xs:element name=”OpendPURL” type=”xs:int” minOccurs=”0″/> <xs:element name=”completed” type=”xs:int” minOccurs=”0″/> <xs:element name=”submited” type=”xs:decimal” minOccurs=”0″/> <xs:element name=”PageName1″ type=”xs:string” minOccurs=”0″/> <xs:element name=”Audience” type=”xs:int” minOccurs=”0″/> <xs:element name=”PurlVisits” type=”xs:int” minOccurs=”0″/> <xs:element name=”ResponseRate” type=”xs:decimal” minOccurs=”0″/> <xs:element name=”UniquePurlVisits” type=”xs:int” minOccurs=”0″/> <xs:element name=”UniqueResponseRate” type=”xs:decimal” minOccurs=”0″/> <xs:element name=”NoOfVisitsUniqueVisits” type=”xs:int” minOccurs=”0″/> <xs:element name=”NoOfSurveyCompleted” type=”xs:int” minOccurs=”0″/> <xs:element name=”MailingListFolderName” type=”xs:string” minOccurs=”0″/> <xs:element name=”MailingListFileName” type=”xs:string” minOccurs=”0″/> <xs:element name=”CreateDate” type=”xs:string” minOccurs=”0″/> |
| tns:StartDate [element reportDailyByMonth] | The start date to report daily activity for that month. Format should be mm/1/yyyy |
Element: tns:CampaignId [element reportClickDetailByPage]
Description
CampaignId to generate a report for
Derived By
Type s:int
Referenced By
- Element tns:reportClickDetailByPage
Element: tns:CampaignId [element reportDailyByMonth]
Description
CampaignId to generate a report for
Derived By
Type s:int
Referenced By
- Element tns:reportDailyByMonth
Element: tns:CampaignId [element reportDetailByCampaign]
Description
CampaignId to generate a report for
Derived By
Type s:int
Referenced By
- Element tns:reportDetailByCampaign
Element: tns:CampaignId [element reportDetailByPage]
Description
CampaignId to generate a report for
Derived By
Type s:int
Referenced By
- Element tns:reportDetailByPage
Element: tns:CampaignId [element reportFormDetailByPage]
Description
CampaignId to generate a report for
Derived By
Type s:int
Referenced By
- Element tns:reportFormDetailByPage
Element: tns:CampaignId [element reportSummaryByCampaign]
Description
CampaignId to generate a report for
Derived By
Type s:int
Referenced By
- Element tns:reportSummaryByCampaign
Element: tns:CampaignId [element reportSummaryByPage]
Description
CampaignId to generate a report for
Derived By
Type s:int
Referenced By
- Element tns:reportSummaryByPage
Element: tns:DetailType [element reportDetailByCampaign]
Description
Determines what pURL records are returned. 1=Return all records in campaign; 2=Return just the pURLs that were opened; 3=Return just the pURLs that were completed
Derived By
Type s:int
Referenced By
- Element tns:reportDetailByCampaign
Element: tns:DetailType [element reportDetailByPage]
Description
Determines what pURL records are returned. 1=Return all records in campaign; 2=Return just the pURLs that were opened; 3=Return just the pURLs that were completed
Derived By
Type s:int
Referenced By
- Element tns:reportDetailByPage
Element: tns:Key [element reportClickDetailByPage]
Element: tns:Key [element reportDailyByMonth]
Element: tns:Key [element reportDetailByCampaign]
Element: tns:Key [element reportDetailByPage]
Element: tns:Key [element reportFormDetailByPage]
Element: tns:Key [element reportSummaryByCampaign]
Element: tns:Key [element reportSummaryByPage]
Element: tns:PageId [element reportClickDetailByPage]
Description
PageId from the microsite to report on. Get PageIds by calling getPagesByCampaign
Derived By
Type s:int
Referenced By
- Element tns:reportClickDetailByPage
Element: tns:PageId [element reportDetailByPage]
Description
PageId from the microsite to report on. Get PageIds by calling getPagesByCampaign
Derived By
Type s:int
Referenced By
- Element tns:reportDetailByPage
Element: tns:PageId [element reportFormDetailByPage]
Description
PageId from the microsite to report on. Get PageIds by calling getPagesByCampaign
Derived By
Type s:int
Referenced By
- Element tns:reportFormDetailByPage
Element: tns:PageId [element reportSummaryByPage]
Description
PageId from the microsite to report on. Get PageIds by calling getPagesByCampaign
Derived By
Type s:int
Referenced By
- Element tns:reportSummaryByPage
Element: tns:reportClickDetailByPage
Description
Get a report showing the click activity for the given campaign and page
Derived By
Restricting s:anyType
Content Model
Contains elements as defined in the following table.
| Component | Type | Description |
|---|---|---|
| tns:Key | s:string | API Key |
| tns:CampaignId | s:int | CampaignId to generate a report for |
| tns:PageId | s:int | PageId from the microsite to report on. Get PageIds by calling getPagesByCampaign |
Element: tns:reportClickDetailByPageResponse
Description
Dataset containing report details
Derived By
Restricting s:anyType
Content Model
Contains elements as defined in the following table.
| Component | Type | Description |
|---|---|---|
| tns:reportClickDetailByPageResult | s:anyType (restriction) | <xs:element name=”linktext” type=”xs:string” minOccurs=”0″/> <xs:element name=”Uniqueclicks” type=”xs:int” minOccurs=”0″/> <xs:element name=”UniqueNoOfTimesOpened” type=”xs:int” minOccurs=”0″/> <xs:element name=”NoOfTimesClicked” type=”xs:int” minOccurs=”0″/> <xs:element name=”NoOfTimesOpened” type=”xs:int” minOccurs=”0″/> <xs:element name=”VisittoClickRate” type=”xs:string” minOccurs=”0″/> <xs:element name=”UniqueVisittoClickRate” type=”xs:string” minOccurs=”0″/> |
Element: tns:reportClickDetailByPageResult [element reportClickDetailByPageResponse]
Description
<xs:element name=”linktext” type=”xs:string” minOccurs=”0″/>
<xs:element name=”Uniqueclicks” type=”xs:int” minOccurs=”0″/>
<xs:element name=”UniqueNoOfTimesOpened” type=”xs:int” minOccurs=”0″/>
<xs:element name=”NoOfTimesClicked” type=”xs:int” minOccurs=”0″/>
<xs:element name=”NoOfTimesOpened” type=”xs:int” minOccurs=”0″/>
<xs:element name=”VisittoClickRate” type=”xs:string” minOccurs=”0″/>
<xs:element name=”UniqueVisittoClickRate” type=”xs:string” minOccurs=”0″/>
Derived By
Restricting s:anyType
Content Model
Contains elements as defined in the following table.
| Component | Type | Description |
|---|---|---|
| s:schema | (none) | |
| any | ||
Referenced By
Element: tns:reportDailyByMonth
Description
Get a daily report of pURL opens and complete for one month given the start date as mm/1/yyyy
Derived By
Restricting s:anyType
Content Model
Contains elements as defined in the following table.
| Component | Type | Description |
|---|---|---|
| tns:Key | s:string | API Key |
| tns:CampaignId | s:int | CampaignId to generate a report for |
| tns:StartDate | s:string | The start date to report daily activity for that month. Format should be mm/1/yyyy |
Element: tns:reportDailyByMonthResponse
Description
Dataset containing report details
Derived By
Restricting s:anyType
Content Model
Contains elements as defined in the following table.
| Component | Type | Description |
|---|---|---|
| tns:reportDailyByMonthResult | s:anyType (restriction) | <xs:element name=”dates” type=”xs:int” minOccurs=”0″/> <xs:element name=”opened” type=”xs:int” minOccurs=”0″/> <xs:element name=”completed” type=”xs:int” minOccurs=”0″/> |
Element: tns:reportDailyByMonthResult [element reportDailyByMonthResponse]
Description
<xs:element name=”dates” type=”xs:int” minOccurs=”0″/>
<xs:element name=”opened” type=”xs:int” minOccurs=”0″/>
<xs:element name=”completed” type=”xs:int” minOccurs=”0″/>
Derived By
Restricting s:anyType
Content Model
Contains elements as defined in the following table.
| Component | Type | Description |
|---|---|---|
| s:schema | (none) | |
| any | ||
Referenced By
- Element tns:reportDailyByMonthResponse
Element: tns:reportDetailByCampaign
Description
Get a detail report for this campaign for all pages. The DetailType specifies whether to get (1) all activity, (2) just opened pURLs or (3) just completed pURLs
Derived By
Restricting s:anyType
Content Model
Contains elements as defined in the following table.
| Component | Type | Description |
|---|---|---|
| tns:Key | s:string | API Key |
| tns:CampaignId | s:int | CampaignId to generate a report for |
| tns:DetailType | s:int | Determines what pURL records are returned. 1=Return all records in campaign; 2=Return just the pURLs that were opened; 3=Return just the pURLs that were completed |
Element: tns:reportDetailByCampaignResponse
Description
Dataset containing report details
Derived By
Restricting s:anyType
Content Model
Contains elements as defined in the following table.
| Component | Type | Description |
|---|---|---|
| tns:reportDetailByCampaignResult | s:anyType (restriction) | <xs:element name=”CampaignName” type=”xs:string” minOccurs=”0″/> <xs:element name=”DataId” type=”xs:int” minOccurs=”0″/> <xs:element name=”PageName” type=”xs:string” minOccurs=”0″/> <xs:element name=”CampaignId” type=”xs:int” minOccurs=”0″/> <xs:element name=”UserId” type=”xs:int” minOccurs=”0″/> <xs:element name=”FirstLastName” type=”xs:string” minOccurs=”0″/> <xs:element name=”City” type=”xs:string” minOccurs=”0″/> <xs:element name=”State” type=”xs:string” minOccurs=”0″/> <xs:element name=”Address” type=”xs:string” minOccurs=”0″/> <xs:element name=”Address2″ type=”xs:string” minOccurs=”0″/> <xs:element name=”EmailId” type=”xs:string” minOccurs=”0″/> <xs:element name=”Zip” type=”xs:string” minOccurs=”0″/> <xs:element name=”Company” type=”xs:string” minOccurs=”0″/> <xs:element name=”Occupation” type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField1″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField2″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField3″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField4″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField5″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField6″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField7″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField8″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField9″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField10″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField11″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField12″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField13″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField14″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField15″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField16″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField17″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField18″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField19″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField20″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField21″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField22″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField23″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField24″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField25″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField26″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField27″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField28″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField29″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField30″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField31″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField32″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField33″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField34″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField35″ type=”xs:string” minOccurs=”0″/> <xs:element name=”Openeddate” type=”xs:string” minOccurs=”0″/> <xs:element name=”Completed” type=”xs:string” minOccurs=”0″/> |
Element: tns:reportDetailByCampaignResult [element reportDetailByCampaignResponse]
Description
<xs:element name=”CampaignName” type=”xs:string” minOccurs=”0″/>
<xs:element name=”DataId” type=”xs:int” minOccurs=”0″/>
<xs:element name=”PageName” type=”xs:string” minOccurs=”0″/>
<xs:element name=”CampaignId” type=”xs:int” minOccurs=”0″/>
<xs:element name=”UserId” type=”xs:int” minOccurs=”0″/>
<xs:element name=”FirstLastName” type=”xs:string” minOccurs=”0″/>
<xs:element name=”City” type=”xs:string” minOccurs=”0″/>
<xs:element name=”State” type=”xs:string” minOccurs=”0″/>
<xs:element name=”Address” type=”xs:string” minOccurs=”0″/>
<xs:element name=”Address2″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”EmailId” type=”xs:string” minOccurs=”0″/>
<xs:element name=”Zip” type=”xs:string” minOccurs=”0″/>
<xs:element name=”Company” type=”xs:string” minOccurs=”0″/>
<xs:element name=”Occupation” type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField1″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField2″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField3″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField4″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField5″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField6″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField7″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField8″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField9″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField10″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField11″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField12″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField13″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField14″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField15″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField16″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField17″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField18″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField19″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField20″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField21″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField22″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField23″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField24″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField25″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField26″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField27″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField28″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField29″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField30″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField31″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField32″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField33″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField34″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField35″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”Openeddate” type=”xs:string” minOccurs=”0″/>
<xs:element name=”Completed” type=”xs:string” minOccurs=”0″/>
Derived By
Restricting s:anyType
Content Model
Contains elements as defined in the following table.
| Component | Type | Description |
|---|---|---|
| s:schema | (none) | |
| any | ||
Referenced By
Element: tns:reportDetailByPage
Description
Get a detail report for this campaign and the given page. The DetailType specifies whether to get (1) all activity, (2) just opened pURLs or (3) just completed pURLs
Derived By
Restricting s:anyType
Content Model
Contains elements as defined in the following table.
| Component | Type | Description |
|---|---|---|
| tns:Key | s:string | API Key |
| tns:CampaignId | s:int | CampaignId to generate a report for |
| tns:PageId | s:int | PageId from the microsite to report on. Get PageIds by calling getPagesByCampaign |
| tns:DetailType | s:int | Determines what pURL records are returned. 1=Return all records in campaign; 2=Return just the pURLs that were opened; 3=Return just the pURLs that were completed |
Element: tns:reportDetailByPageResponse
Description
Dataset containing report details
Derived By
Restricting s:anyType
Content Model
Contains elements as defined in the following table.
| Component | Type | Description |
|---|---|---|
| tns:reportDetailByPageResult | s:anyType (restriction) | <xs:element name=”CampaignName” type=”xs:string” minOccurs=”0″/> <xs:element name=”DataId” type=”xs:long” minOccurs=”0″/> <xs:element name=”PageName” type=”xs:string” minOccurs=”0″/> <xs:element name=”CampaignId” type=”xs:long” minOccurs=”0″/> <xs:element name=”UserId” type=”xs:int” minOccurs=”0″/> <xs:element name=”FirstLastName” type=”xs:string” minOccurs=”0″/> <xs:element name=”City” type=”xs:string” minOccurs=”0″/> <xs:element name=”State” type=”xs:string” minOccurs=”0″/> <xs:element name=”Address” type=”xs:string” minOccurs=”0″/> <xs:element name=”Address2″ type=”xs:string” minOccurs=”0″/> <xs:element name=”EmailId” type=”xs:string” minOccurs=”0″/> <xs:element name=”Zip” type=”xs:string” minOccurs=”0″/> <xs:element name=”Company” type=”xs:string” minOccurs=”0″/> <xs:element name=”Occupation” type=”xs:string” minOccurs=”0″/> <xs:element name=”Openeddate” type=”xs:string” minOccurs=”0″/> <xs:element name=”Completed” type=”xs:string” minOccurs=”0″/> <xs:element name=”Openeddateraw” type=”xs:dateTime” minOccurs=”0″/> |
Element: tns:reportDetailByPageResult [element reportDetailByPageResponse]
Description
<xs:element name=”CampaignName” type=”xs:string” minOccurs=”0″/>
<xs:element name=”DataId” type=”xs:long” minOccurs=”0″/>
<xs:element name=”PageName” type=”xs:string” minOccurs=”0″/>
<xs:element name=”CampaignId” type=”xs:long” minOccurs=”0″/>
<xs:element name=”UserId” type=”xs:int” minOccurs=”0″/>
<xs:element name=”FirstLastName” type=”xs:string” minOccurs=”0″/>
<xs:element name=”City” type=”xs:string” minOccurs=”0″/>
<xs:element name=”State” type=”xs:string” minOccurs=”0″/>
<xs:element name=”Address” type=”xs:string” minOccurs=”0″/>
<xs:element name=”Address2″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”EmailId” type=”xs:string” minOccurs=”0″/>
<xs:element name=”Zip” type=”xs:string” minOccurs=”0″/>
<xs:element name=”Company” type=”xs:string” minOccurs=”0″/>
<xs:element name=”Occupation” type=”xs:string” minOccurs=”0″/>
<xs:element name=”Openeddate” type=”xs:string” minOccurs=”0″/>
<xs:element name=”Completed” type=”xs:string” minOccurs=”0″/>
<xs:element name=”Openeddateraw” type=”xs:dateTime” minOccurs=”0″/>
Derived By
Restricting s:anyType
Content Model
Contains elements as defined in the following table.
| Component | Type | Description |
|---|---|---|
| s:schema | (none) | |
| any | ||
Referenced By
- Element tns:reportDetailByPageResponse
Element: tns:reportFormDetailByPage
Description
Get a detail form report for this campaign and the given page. The result will include all form questions and answers collected from that page
Derived By
Restricting s:anyType
Content Model
Contains elements as defined in the following table.
| Component | Type | Description |
|---|---|---|
| tns:Key | s:string | API Key |
| tns:CampaignId | s:int | CampaignId to generate a report for |
| tns:PageId | s:int | PageId from the microsite to report on. Get PageIds by calling getPagesByCampaign |
Element: tns:reportFormDetailByPageResponse
Description
Dataset containing report details
Derived By
Restricting s:anyType
Content Model
Contains elements as defined in the following table.
| Component | Type | Description |
|---|---|---|
| tns:reportFormDetailByPageResult | s:anyType (restriction) | <xs:element name=”pURL” type=”xs:string” minOccurs=”0″/> <xs:element name=”LastVisited” type=”xs:dateTime” minOccurs=”0″/> <xs:element name=”CompletedDate” type=”xs:dateTime” minOccurs=”0″/> <xs:element name=”FirstName” type=”xs:string” minOccurs=”0″/> <xs:element name=”LastName” type=”xs:string” minOccurs=”0″/> <xs:element name=”Address” type=”xs:string” minOccurs=”0″/> <xs:element name=”Address2″ type=”xs:string” minOccurs=”0″/> <xs:element name=”City” type=”xs:string” minOccurs=”0″/> <xs:element name=”State” type=”xs:string” minOccurs=”0″/> <xs:element name=”Zip” type=”xs:string” minOccurs=”0″/> <xs:element name=”EmailId” type=”xs:string” minOccurs=”0″/> <xs:element name=”Company” type=”xs:string” minOccurs=”0″/> <xs:element name=”Occupation” type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField1″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField2″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField3″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField4″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField5″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField6″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField7″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField8″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField9″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField10″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField11″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField12″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField13″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField14″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField15″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField16″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField17″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField18″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField19″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField20″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField21″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField22″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField23″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField24″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField25″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField26″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField27″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField28″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField29″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField30″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField31″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField32″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField33″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField34″ type=”xs:string” minOccurs=”0″/> <xs:element name=”VarField35″ type=”xs:string” minOccurs=”0″/> <xs:element name=”SubmitedDate” type=”xs:dateTime” minOccurs=”0″/> <xs:element name=”DataId” type=”xs:int” minOccurs=”0″/> <xs:element name=”hdnFormSubmitURL” type=”xs:string” minOccurs=”0″/> <xs:element name=”Question_Here” type=”xs:string” minOccurs=”0″/> <xs:element name=”Question_Here” type=”xs:string” minOccurs=”0″/> … |
Element: tns:reportFormDetailByPageResult [element reportFormDetailByPageResponse]
Description
<xs:element name=”pURL” type=”xs:string” minOccurs=”0″/>
<xs:element name=”LastVisited” type=”xs:dateTime” minOccurs=”0″/>
<xs:element name=”CompletedDate” type=”xs:dateTime” minOccurs=”0″/>
<xs:element name=”FirstName” type=”xs:string” minOccurs=”0″/>
<xs:element name=”LastName” type=”xs:string” minOccurs=”0″/>
<xs:element name=”Address” type=”xs:string” minOccurs=”0″/>
<xs:element name=”Address2″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”City” type=”xs:string” minOccurs=”0″/>
<xs:element name=”State” type=”xs:string” minOccurs=”0″/>
<xs:element name=”Zip” type=”xs:string” minOccurs=”0″/>
<xs:element name=”EmailId” type=”xs:string” minOccurs=”0″/>
<xs:element name=”Company” type=”xs:string” minOccurs=”0″/>
<xs:element name=”Occupation” type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField1″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField2″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField3″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField4″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField5″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField6″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField7″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField8″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField9″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField10″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField11″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField12″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField13″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField14″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField15″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField16″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField17″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField18″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField19″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField20″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField21″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField22″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField23″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField24″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField25″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField26″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField27″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField28″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField29″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField30″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField31″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField32″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField33″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField34″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”VarField35″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”SubmitedDate” type=”xs:dateTime” minOccurs=”0″/>
<xs:element name=”DataId” type=”xs:int” minOccurs=”0″/>
<xs:element name=”hdnFormSubmitURL” type=”xs:string” minOccurs=”0″/>
<xs:element name=”Question_Here” type=”xs:string” minOccurs=”0″/>
<xs:element name=”Question_Here” type=”xs:string” minOccurs=”0″/>
…
Derived By
Restricting s:anyType
Content Model
Contains elements as defined in the following table.
| Component | Type | Description |
|---|---|---|
| s:schema | (none) | |
| any | ||
Referenced By
Element: tns:reportSummaryByCampaign
Description
Get a high level summary report for this campaign which includes all page activity
Derived By
Restricting s:anyType
Content Model
Contains elements as defined in the following table.
| Component | Type | Description |
|---|---|---|
| tns:Key | s:string | API Key |
| tns:CampaignId | s:int | CampaignId to generate a report for |
Element: tns:reportSummaryByCampaignResponse
Description
Dataset containing report details
Derived By
Restricting s:anyType
Content Model
Contains elements as defined in the following table.
| Component | Type | Description |
|---|---|---|
| tns:reportSummaryByCampaignResult | s:anyType (restriction) | <xs:element name=”CampaignName” type=”xs:string” minOccurs=”0″/> <xs:element name=”CampaignId” type=”xs:int” minOccurs=”0″/> <xs:element name=”SubDomain” type=”xs:string” minOccurs=”0″/> <xs:element name=”DomainType” type=”xs:string” minOccurs=”0″/> <xs:element name=”Status” type=”xs:string” minOccurs=”0″/> <xs:element name=”MicrositeName” type=”xs:string” minOccurs=”0″/> <xs:element name=”MicrositeId” type=”xs:int” minOccurs=”0″/> <xs:element name=”total” type=”xs:int” minOccurs=”0″/> <xs:element name=”Views” type=”xs:decimal” minOccurs=”0″/> <xs:element name=”Ziptotal” type=”xs:int” minOccurs=”0″/> <xs:element name=”statetotal” type=”xs:int” minOccurs=”0″/> <xs:element name=”openedDate” type=”xs:string” minOccurs=”0″/> <xs:element name=”OpendPURL” type=”xs:int” minOccurs=”0″/> <xs:element name=”completed” type=”xs:int” minOccurs=”0″/> <xs:element name=”submited” type=”xs:decimal” minOccurs=”0″/> <xs:element name=”PageName” type=”xs:string” minOccurs=”0″/> <xs:element name=”Audience” type=”xs:int” minOccurs=”0″/> <xs:element name=”PurlVisits” type=”xs:int” minOccurs=”0″/> <xs:element name=”ResponseRate” type=”xs:decimal” minOccurs=”0″/> <xs:element name=”UniquePurlVisits” type=”xs:int” minOccurs=”0″/> <xs:element name=”UniqueResponseRate” type=”xs:decimal” minOccurs=”0″/> <xs:element name=”NoOfVisitsUniqueVisits” type=”xs:int” minOccurs=”0″/> <xs:element name=”NoOfSurveyCompleted” type=”xs:int” minOccurs=”0″/> <xs:element name=”MailingListFolderName” type=”xs:string” minOccurs=”0″/> <xs:element name=”MailingListFileName” type=”xs:string” minOccurs=”0″/> <xs:element name=”CreateDate” type=”xs:string” minOccurs=”0″/> |
Element: tns:reportSummaryByCampaignResult [element reportSummaryByCampaignResponse]
Description
<xs:element name=”CampaignName” type=”xs:string” minOccurs=”0″/>
<xs:element name=”CampaignId” type=”xs:int” minOccurs=”0″/>
<xs:element name=”SubDomain” type=”xs:string” minOccurs=”0″/>
<xs:element name=”DomainType” type=”xs:string” minOccurs=”0″/>
<xs:element name=”Status” type=”xs:string” minOccurs=”0″/>
<xs:element name=”MicrositeName” type=”xs:string” minOccurs=”0″/>
<xs:element name=”MicrositeId” type=”xs:int” minOccurs=”0″/>
<xs:element name=”total” type=”xs:int” minOccurs=”0″/>
<xs:element name=”Views” type=”xs:decimal” minOccurs=”0″/>
<xs:element name=”Ziptotal” type=”xs:int” minOccurs=”0″/>
<xs:element name=”statetotal” type=”xs:int” minOccurs=”0″/>
<xs:element name=”openedDate” type=”xs:string” minOccurs=”0″/>
<xs:element name=”OpendPURL” type=”xs:int” minOccurs=”0″/>
<xs:element name=”completed” type=”xs:int” minOccurs=”0″/>
<xs:element name=”submited” type=”xs:decimal” minOccurs=”0″/>
<xs:element name=”PageName” type=”xs:string” minOccurs=”0″/>
<xs:element name=”Audience” type=”xs:int” minOccurs=”0″/>
<xs:element name=”PurlVisits” type=”xs:int” minOccurs=”0″/>
<xs:element name=”ResponseRate” type=”xs:decimal” minOccurs=”0″/>
<xs:element name=”UniquePurlVisits” type=”xs:int” minOccurs=”0″/>
<xs:element name=”UniqueResponseRate” type=”xs:decimal” minOccurs=”0″/>
<xs:element name=”NoOfVisitsUniqueVisits” type=”xs:int” minOccurs=”0″/>
<xs:element name=”NoOfSurveyCompleted” type=”xs:int” minOccurs=”0″/>
<xs:element name=”MailingListFolderName” type=”xs:string” minOccurs=”0″/>
<xs:element name=”MailingListFileName” type=”xs:string” minOccurs=”0″/>
<xs:element name=”CreateDate” type=”xs:string” minOccurs=”0″/>
Derived By
Restricting s:anyType
Content Model
Contains elements as defined in the following table.
| Component | Type | Description |
|---|---|---|
| s:schema | (none) | |
| any | ||
Referenced By
Element: tns:reportSummaryByPage
Description
Get a summary report for the given page in this campaign
Derived By
Restricting s:anyType
Content Model
Contains elements as defined in the following table.
| Component | Type | Description |
|---|---|---|
| tns:Key | s:string | API Key |
| tns:CampaignId | s:int | CampaignId to generate a report for |
| tns:PageId | s:int | PageId from the microsite to report on. Get PageIds by calling getPagesByCampaign |
Element: tns:reportSummaryByPageResponse
Description
Dataset containing report details
Derived By
Restricting s:anyType
Content Model
Contains elements as defined in the following table.
| Component | Type | Description |
|---|---|---|
| tns:reportSummaryByPageResult | s:anyType (restriction) | <xs:element name=”CampaignName” type=”xs:string” minOccurs=”0″/> <xs:element name=”CampaignId” type=”xs:int” minOccurs=”0″/> <xs:element name=”SubDomain” type=”xs:string” minOccurs=”0″/> <xs:element name=”DomainType” type=”xs:string” minOccurs=”0″/> <xs:element name=”Status” type=”xs:string” minOccurs=”0″/> <xs:element name=”MicrositeName” type=”xs:string” minOccurs=”0″/> <xs:element name=”MicrositeId” type=”xs:int” minOccurs=”0″/> <xs:element name=”total” type=”xs:int” minOccurs=”0″/> <xs:element name=”PageName” type=”xs:string” minOccurs=”0″/> <xs:element name=”Views” type=”xs:decimal” minOccurs=”0″/> <xs:element name=”Ziptotal” type=”xs:int” minOccurs=”0″/> <xs:element name=”statetotal” type=”xs:int” minOccurs=”0″/> <xs:element name=”openedDate” type=”xs:string” minOccurs=”0″/> <xs:element name=”OpendPURL” type=”xs:int” minOccurs=”0″/> <xs:element name=”completed” type=”xs:int” minOccurs=”0″/> <xs:element name=”submited” type=”xs:decimal” minOccurs=”0″/> <xs:element name=”PageName1″ type=”xs:string” minOccurs=”0″/> <xs:element name=”Audience” type=”xs:int” minOccurs=”0″/> <xs:element name=”PurlVisits” type=”xs:int” minOccurs=”0″/> <xs:element name=”ResponseRate” type=”xs:decimal” minOccurs=”0″/> <xs:element name=”UniquePurlVisits” type=”xs:int” minOccurs=”0″/> <xs:element name=”UniqueResponseRate” type=”xs:decimal” minOccurs=”0″/> <xs:element name=”NoOfVisitsUniqueVisits” type=”xs:int” minOccurs=”0″/> <xs:element name=”NoOfSurveyCompleted” type=”xs:int” minOccurs=”0″/> <xs:element name=”MailingListFolderName” type=”xs:string” minOccurs=”0″/> <xs:element name=”MailingListFileName” type=”xs:string” minOccurs=”0″/> <xs:element name=”CreateDate” type=”xs:string” minOccurs=”0″/> |
Element: tns:reportSummaryByPageResult [element reportSummaryByPageResponse]
Description
<xs:element name=”CampaignName” type=”xs:string” minOccurs=”0″/>
<xs:element name=”CampaignId” type=”xs:int” minOccurs=”0″/>
<xs:element name=”SubDomain” type=”xs:string” minOccurs=”0″/>
<xs:element name=”DomainType” type=”xs:string” minOccurs=”0″/>
<xs:element name=”Status” type=”xs:string” minOccurs=”0″/>
<xs:element name=”MicrositeName” type=”xs:string” minOccurs=”0″/>
<xs:element name=”MicrositeId” type=”xs:int” minOccurs=”0″/>
<xs:element name=”total” type=”xs:int” minOccurs=”0″/>
<xs:element name=”PageName” type=”xs:string” minOccurs=”0″/>
<xs:element name=”Views” type=”xs:decimal” minOccurs=”0″/>
<xs:element name=”Ziptotal” type=”xs:int” minOccurs=”0″/>
<xs:element name=”statetotal” type=”xs:int” minOccurs=”0″/>
<xs:element name=”openedDate” type=”xs:string” minOccurs=”0″/>
<xs:element name=”OpendPURL” type=”xs:int” minOccurs=”0″/>
<xs:element name=”completed” type=”xs:int” minOccurs=”0″/>
<xs:element name=”submited” type=”xs:decimal” minOccurs=”0″/>
<xs:element name=”PageName1″ type=”xs:string” minOccurs=”0″/>
<xs:element name=”Audience” type=”xs:int” minOccurs=”0″/>
<xs:element name=”PurlVisits” type=”xs:int” minOccurs=”0″/>
<xs:element name=”ResponseRate” type=”xs:decimal” minOccurs=”0″/>
<xs:element name=”UniquePurlVisits” type=”xs:int” minOccurs=”0″/>
<xs:element name=”UniqueResponseRate” type=”xs:decimal” minOccurs=”0″/>
<xs:element name=”NoOfVisitsUniqueVisits” type=”xs:int” minOccurs=”0″/>
<xs:element name=”NoOfSurveyCompleted” type=”xs:int” minOccurs=”0″/>
<xs:element name=”MailingListFolderName” type=”xs:string” minOccurs=”0″/>
<xs:element name=”MailingListFileName” type=”xs:string” minOccurs=”0″/>
<xs:element name=”CreateDate” type=”xs:string” minOccurs=”0″/>
Derived By
Restricting s:anyType
Content Model
Contains elements as defined in the following table.
| Component | Type | Description |
|---|---|---|
| s:schema | (none) | |
| any | ||
Referenced By
- Element tns:reportSummaryByPageResponse
Element: tns:StartDate [element reportDailyByMonth]
Description
The start date to report daily activity for that month. Format should be mm/1/yyyy
Derived By
Type s:string
Referenced By
- Element tns:reportDailyByMonth
