Service Summary

Services

Methods

account_create - V1.1 - Admin

Creates a new account.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for account_create (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.account_create = function(
	p_masterkey,
	p_name,
	p_email,
	p_password)
{
    this.m_action = {};
    this.m_action.m_account_create = 
    { 
        m_masterkey:p_masterkey,
        m_name:p_name,
        m_email:p_email,
        m_password:p_password
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.account_create.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_account_create = 
        {

        };
    return this;
}                   

// Reference to the request
var l_account_create = null;

// Reference to the action
var l_account_create_action = null;

// This is called on completion of a call to account_create
function oncomplete_account_create()
{
    alert("oncomplete_account_create");


    // Get response as object
    var l_obj = l_account_create.m_response.m_account_create;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_account_create_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/account_create/status").text);

    // Get response as a single string
    alert(l_account_create_action.m_response_string);
}

// Create the request
l_account_create = new MetaWrap.XML.Action.WS.account_create
(
								
    'masterkey',
    'name',
    'email',
    'password'
);

// Create action
l_account_create_action = new MetaWrap.XML.Action(l_account_create,l_api_server + "/account_create");

// Call the action
if (!l_account_create_action.run(oncomplete_account_create))
{
    alert("There was an error calling 'account_create'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for account_create
//

// JQuery GET request
    var dataString = 'masterkey=masterkey&name=name&email=email&password=password'
    $.get(
      l_api_server+'account_create',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for account_create
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<account_create version="V1.1" service="Admin">\n';
    dataString += '<masterkey>masterkey</masterkey>\n';
    dataString += '<name>name</name>\n';
    dataString += '<email>email</email>\n';
    dataString += '<password>password</password>\n';
    dataString += '</account_create></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

account_exists - V1.1 - Admin

Used to determine if an account already exists.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for account_exists (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.account_exists = function(
	p_masterkey,
	p_name)
{
    this.m_action = {};
    this.m_action.m_account_exists = 
    { 
        m_masterkey:p_masterkey,
        m_name:p_name
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.account_exists.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_account_exists = 
        {

        };
    return this;
}                   

// Reference to the request
var l_account_exists = null;

// Reference to the action
var l_account_exists_action = null;

// This is called on completion of a call to account_exists
function oncomplete_account_exists()
{
    alert("oncomplete_account_exists");


    // Get response as object
    var l_obj = l_account_exists.m_response.m_account_exists;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_account_exists_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/account_exists/status").text);

    // Get response as a single string
    alert(l_account_exists_action.m_response_string);
}

// Create the request
l_account_exists = new MetaWrap.XML.Action.WS.account_exists
(
								
    'masterkey',
    'name'
);

// Create action
l_account_exists_action = new MetaWrap.XML.Action(l_account_exists,l_api_server + "/account_exists");

// Call the action
if (!l_account_exists_action.run(oncomplete_account_exists))
{
    alert("There was an error calling 'account_exists'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for account_exists
//

// JQuery GET request
    var dataString = 'masterkey=masterkey&name=name'
    $.get(
      l_api_server+'account_exists',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for account_exists
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<account_exists version="V1.1" service="Admin">\n';
    dataString += '<masterkey>masterkey</masterkey>\n';
    dataString += '<name>name</name>\n';
    dataString += '</account_exists></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

add_to_producer - V1.1 - Content

Adds someone to an already existing producer

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for add_to_producer (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.add_to_producer = function(
	p_key,
	p_producer,
	p_member,
	p_consumer)
{
    this.m_action = {};
    this.m_action.m_add_to_producer = 
    { 
        m_key:p_key,
        m_producer:p_producer,
        m_member:p_member,
        m_consumer:p_consumer
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.add_to_producer.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_add_to_producer = 
        {

        };
    return this;
}                   

// Reference to the request
var l_add_to_producer = null;

// Reference to the action
var l_add_to_producer_action = null;

// This is called on completion of a call to add_to_producer
function oncomplete_add_to_producer()
{
    alert("oncomplete_add_to_producer");


    // Get response as object
    var l_obj = l_add_to_producer.m_response.m_add_to_producer;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_add_to_producer_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/add_to_producer/status").text);

    // Get response as a single string
    alert(l_add_to_producer_action.m_response_string);
}

// Create the request
l_add_to_producer = new MetaWrap.XML.Action.WS.add_to_producer
(
								
    'key',
    'producer',
    'member',
    'consumer'
);

// Create action
l_add_to_producer_action = new MetaWrap.XML.Action(l_add_to_producer,l_api_server + "/add_to_producer");

// Call the action
if (!l_add_to_producer_action.run(oncomplete_add_to_producer))
{
    alert("There was an error calling 'add_to_producer'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for add_to_producer
//

// JQuery GET request
    var dataString = 'key=key&producer=producer&member=member&consumer=consumer'
    $.get(
      l_api_server+'add_to_producer',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for add_to_producer
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<add_to_producer version="V1.1" service="Content">\n';
    dataString += '<key>key</key>\n';
    dataString += '<producer>producer</producer>\n';
    dataString += '<member>member</member>\n';
    dataString += '<consumer>consumer</consumer>\n';
    dataString += '</add_to_producer></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

api_identity_token_request - V0.0 - ThumbWhere

Requests an API Identity Token.

After making the request, you need complete the request with a call to ^api_identity_token_request_authenticate^. This call should only be made if you are satisfed that the identity has been proven to belong to the person asserting that they own it. If this identity is a mobile phone, you have the option to SMS or MMS #code# to #number# to complete the request. Once the request is completed, make a call to ^api_identity_token_request_query^ with the returned #code# as a parameter to get the #api_identity_token# and the #api_member_token#.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_identity_token_request (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.api_identity_token_request = function(
	p_api_key,
	p_api_member_token,
	p_id,
	p_type)
{
    this.m_action = {};
    this.m_action.m_api_identity_token_request = 
    { 
        m_api_key:p_api_key,
        m_api_member_token:p_api_member_token,
        m_id:p_id,
        m_type:p_type
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.api_identity_token_request.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_api_identity_token_request = 
        {

        };
    return this;
}                   

// Reference to the request
var l_api_identity_token_request = null;

// Reference to the action
var l_api_identity_token_request_action = null;

// This is called on completion of a call to api_identity_token_request
function oncomplete_api_identity_token_request()
{
    alert("oncomplete_api_identity_token_request");


    // Get response as object
    var l_obj = l_api_identity_token_request.m_response.m_api_identity_token_request;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_api_identity_token_request_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/api_identity_token_request/status").text);

    // Get response as a single string
    alert(l_api_identity_token_request_action.m_response_string);
}

// Create the request
l_api_identity_token_request = new MetaWrap.XML.Action.WS.api_identity_token_request
(
								
    'api_key',
    'api_member_token',
    'id',
    'type'
);

// Create action
l_api_identity_token_request_action = new MetaWrap.XML.Action(l_api_identity_token_request,l_api_server + "/api_identity_token_request");

// Call the action
if (!l_api_identity_token_request_action.run(oncomplete_api_identity_token_request))
{
    alert("There was an error calling 'api_identity_token_request'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for api_identity_token_request
//

// JQuery GET request
    var dataString = 'api_key=api_key&api_member_token=api_member_token&id=id&type=type'
    $.get(
      l_api_server+'api_identity_token_request',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_identity_token_request
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<api_identity_token_request version="V0.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<api_member_token>api_member_token</api_member_token>\n';
    dataString += '<id>id</id>\n';
    dataString += '<type>type</type>\n';
    dataString += '</api_identity_token_request></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

api_identity_token_request - V1.0 - ThumbWhere

Requests an API Identity Token.

After making the request, you need complete the request with a call to ^api_identity_token_request_authenticate^. This call should only be made if you are satisfed that the identity has been proven to belong to the person asserting that they own it. If this identity is a mobile phone, you have the option to SMS or MMS #code# to #number# to complete the request. Once the request is completed, make a call to ^api_identity_token_request_query^ with the returned #code# as a parameter to get the #api_identity_token# and the #api_member_token#.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_identity_token_request (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.api_identity_token_request = function(
	p_api_key,
	p_api_member_token,
	p_id,
	p_type)
{
    this.m_action = {};
    this.m_action.m_api_identity_token_request = 
    { 
        m_api_key:p_api_key,
        m_api_member_token:p_api_member_token,
        m_id:p_id,
        m_type:p_type
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.api_identity_token_request.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_api_identity_token_request = 
        {

            m_code:"",
            m_number:""
        };
    return this;
}                   

// Reference to the request
var l_api_identity_token_request = null;

// Reference to the action
var l_api_identity_token_request_action = null;

// This is called on completion of a call to api_identity_token_request
function oncomplete_api_identity_token_request()
{
    alert("oncomplete_api_identity_token_request");


    // Get response as object
    var l_obj = l_api_identity_token_request.m_response.m_api_identity_token_request;
    alert("'status' = " + l_obj.m_status);
    alert("'code' = " + l_obj.m_code);
    alert("'number' = " + l_obj.m_number);

    // Get response as XML
    var l_xml = l_api_identity_token_request_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/api_identity_token_request/status").text);    
    alert("'code' (from xml) = " +l_xml.selectSingleNode("response/api_identity_token_request/code").text);    
    alert("'number' (from xml) = " +l_xml.selectSingleNode("response/api_identity_token_request/number").text);

    // Get response as a single string
    alert(l_api_identity_token_request_action.m_response_string);
}

// Create the request
l_api_identity_token_request = new MetaWrap.XML.Action.WS.api_identity_token_request
(
								
    'api_key',
    'api_member_token',
    'id',
    'type'
);

// Create action
l_api_identity_token_request_action = new MetaWrap.XML.Action(l_api_identity_token_request,l_api_server + "/api_identity_token_request");

// Call the action
if (!l_api_identity_token_request_action.run(oncomplete_api_identity_token_request))
{
    alert("There was an error calling 'api_identity_token_request'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for api_identity_token_request
//

// JQuery GET request
    var dataString = 'api_key=api_key&api_member_token=api_member_token&id=id&type=type'
    $.get(
      l_api_server+'api_identity_token_request',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_identity_token_request
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<api_identity_token_request version="V1.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<api_member_token>api_member_token</api_member_token>\n';
    dataString += '<id>id</id>\n';
    dataString += '<type>type</type>\n';
    dataString += '</api_identity_token_request></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

api_identity_token_request_authenticate - V0.0 - ThumbWhere

Authenticates an API Identity Token Request made by a previous call to ^api_identity_token_request^.

This enables an application to vouch for the validity of an Identity.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_identity_token_request_authenticate (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.api_identity_token_request_authenticate = function(
	p_api_key,
	p_code)
{
    this.m_action = {};
    this.m_action.m_api_identity_token_request_authenticate = 
    { 
        m_api_key:p_api_key,
        m_code:p_code
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.api_identity_token_request_authenticate.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_api_identity_token_request_authenticate = 
        {

        };
    return this;
}                   

// Reference to the request
var l_api_identity_token_request_authenticate = null;

// Reference to the action
var l_api_identity_token_request_authenticate_action = null;

// This is called on completion of a call to api_identity_token_request_authenticate
function oncomplete_api_identity_token_request_authenticate()
{
    alert("oncomplete_api_identity_token_request_authenticate");


    // Get response as object
    var l_obj = l_api_identity_token_request_authenticate.m_response.m_api_identity_token_request_authenticate;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_api_identity_token_request_authenticate_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/api_identity_token_request_authenticate/status").text);

    // Get response as a single string
    alert(l_api_identity_token_request_authenticate_action.m_response_string);
}

// Create the request
l_api_identity_token_request_authenticate = new MetaWrap.XML.Action.WS.api_identity_token_request_authenticate
(
								
    'api_key',
    'code'
);

// Create action
l_api_identity_token_request_authenticate_action = new MetaWrap.XML.Action(l_api_identity_token_request_authenticate,l_api_server + "/api_identity_token_request_authenticate");

// Call the action
if (!l_api_identity_token_request_authenticate_action.run(oncomplete_api_identity_token_request_authenticate))
{
    alert("There was an error calling 'api_identity_token_request_authenticate'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for api_identity_token_request_authenticate
//

// JQuery GET request
    var dataString = 'api_key=api_key&code=code'
    $.get(
      l_api_server+'api_identity_token_request_authenticate',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_identity_token_request_authenticate
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<api_identity_token_request_authenticate version="V0.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<code>code</code>\n';
    dataString += '</api_identity_token_request_authenticate></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

api_identity_token_request_authenticate - V1.0 - ThumbWhere

Authenticates an API Identity Token Request made by a previous call to ^api_identity_token_request^.

This enables an application to vouch for the validity of an Identity.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_identity_token_request_authenticate (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.api_identity_token_request_authenticate = function(
	p_api_key,
	p_code)
{
    this.m_action = {};
    this.m_action.m_api_identity_token_request_authenticate = 
    { 
        m_api_key:p_api_key,
        m_code:p_code
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.api_identity_token_request_authenticate.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_api_identity_token_request_authenticate = 
        {

            m_api_identity_token:"",
            m_api_member_token:""
        };
    return this;
}                   

// Reference to the request
var l_api_identity_token_request_authenticate = null;

// Reference to the action
var l_api_identity_token_request_authenticate_action = null;

// This is called on completion of a call to api_identity_token_request_authenticate
function oncomplete_api_identity_token_request_authenticate()
{
    alert("oncomplete_api_identity_token_request_authenticate");


    // Get response as object
    var l_obj = l_api_identity_token_request_authenticate.m_response.m_api_identity_token_request_authenticate;
    alert("'status' = " + l_obj.m_status);
    alert("'api_identity_token' = " + l_obj.m_api_identity_token);
    alert("'api_member_token' = " + l_obj.m_api_member_token);

    // Get response as XML
    var l_xml = l_api_identity_token_request_authenticate_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/api_identity_token_request_authenticate/status").text);    
    alert("'api_identity_token' (from xml) = " +l_xml.selectSingleNode("response/api_identity_token_request_authenticate/api_identity_token").text);    
    alert("'api_member_token' (from xml) = " +l_xml.selectSingleNode("response/api_identity_token_request_authenticate/api_member_token").text);

    // Get response as a single string
    alert(l_api_identity_token_request_authenticate_action.m_response_string);
}

// Create the request
l_api_identity_token_request_authenticate = new MetaWrap.XML.Action.WS.api_identity_token_request_authenticate
(
								
    'api_key',
    'code'
);

// Create action
l_api_identity_token_request_authenticate_action = new MetaWrap.XML.Action(l_api_identity_token_request_authenticate,l_api_server + "/api_identity_token_request_authenticate");

// Call the action
if (!l_api_identity_token_request_authenticate_action.run(oncomplete_api_identity_token_request_authenticate))
{
    alert("There was an error calling 'api_identity_token_request_authenticate'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for api_identity_token_request_authenticate
//

// JQuery GET request
    var dataString = 'api_key=api_key&code=code'
    $.get(
      l_api_server+'api_identity_token_request_authenticate',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_identity_token_request_authenticate
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<api_identity_token_request_authenticate version="V1.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<code>code</code>\n';
    dataString += '</api_identity_token_request_authenticate></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

api_identity_token_request_query - V0.0 - ThumbWhere

Query the status of an API identity token request.

This should be performed after a call to ^api_identity_token_request^ and should pass in the code returned by that call. The api identity_token details will not be returned until the code has been sent by SMS to the mobile number will also have been returned by ^api_identity_token_request^.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_identity_token_request_query (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.api_identity_token_request_query = function(
	p_api_key,
	p_code)
{
    this.m_action = {};
    this.m_action.m_api_identity_token_request_query = 
    { 
        m_api_key:p_api_key,
        m_code:p_code
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.api_identity_token_request_query.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_api_identity_token_request_query = 
        {

        };
    return this;
}                   

// Reference to the request
var l_api_identity_token_request_query = null;

// Reference to the action
var l_api_identity_token_request_query_action = null;

// This is called on completion of a call to api_identity_token_request_query
function oncomplete_api_identity_token_request_query()
{
    alert("oncomplete_api_identity_token_request_query");


    // Get response as object
    var l_obj = l_api_identity_token_request_query.m_response.m_api_identity_token_request_query;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_api_identity_token_request_query_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/api_identity_token_request_query/status").text);

    // Get response as a single string
    alert(l_api_identity_token_request_query_action.m_response_string);
}

// Create the request
l_api_identity_token_request_query = new MetaWrap.XML.Action.WS.api_identity_token_request_query
(
								
    'api_key',
    'code'
);

// Create action
l_api_identity_token_request_query_action = new MetaWrap.XML.Action(l_api_identity_token_request_query,l_api_server + "/api_identity_token_request_query");

// Call the action
if (!l_api_identity_token_request_query_action.run(oncomplete_api_identity_token_request_query))
{
    alert("There was an error calling 'api_identity_token_request_query'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for api_identity_token_request_query
//

// JQuery GET request
    var dataString = 'api_key=api_key&code=code'
    $.get(
      l_api_server+'api_identity_token_request_query',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_identity_token_request_query
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<api_identity_token_request_query version="V0.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<code>code</code>\n';
    dataString += '</api_identity_token_request_query></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

api_identity_token_request_query - V1.0 - ThumbWhere

Query the status of an API identity token request.

This should be performed after a call to ^api_identity_token_request^ and should pass in the code returned by that call. The api identity_token details will not be returned until the code has been sent by SMS to the mobile number will also have been returned by ^api_identity_token_request^.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_identity_token_request_query (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.api_identity_token_request_query = function(
	p_api_key,
	p_code)
{
    this.m_action = {};
    this.m_action.m_api_identity_token_request_query = 
    { 
        m_api_key:p_api_key,
        m_code:p_code
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.api_identity_token_request_query.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_api_identity_token_request_query = 
        {

            m_request:"",
            m_expiry_seconds:"",
            m_api_member_token:""
        };
    return this;
}                   

// Reference to the request
var l_api_identity_token_request_query = null;

// Reference to the action
var l_api_identity_token_request_query_action = null;

// This is called on completion of a call to api_identity_token_request_query
function oncomplete_api_identity_token_request_query()
{
    alert("oncomplete_api_identity_token_request_query");


    // Get response as object
    var l_obj = l_api_identity_token_request_query.m_response.m_api_identity_token_request_query;
    alert("'status' = " + l_obj.m_status);
    alert("'request' = " + l_obj.m_request);
    alert("'expiry_seconds' = " + l_obj.m_expiry_seconds);
    alert("'api_member_token' = " + l_obj.m_api_member_token);

    // Get response as XML
    var l_xml = l_api_identity_token_request_query_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/api_identity_token_request_query/status").text);    
    alert("'request' (from xml) = " +l_xml.selectSingleNode("response/api_identity_token_request_query/request").text);    
    alert("'expiry_seconds' (from xml) = " +l_xml.selectSingleNode("response/api_identity_token_request_query/expiry_seconds").text);    
    alert("'api_member_token' (from xml) = " +l_xml.selectSingleNode("response/api_identity_token_request_query/api_member_token").text);

    // Get response as a single string
    alert(l_api_identity_token_request_query_action.m_response_string);
}

// Create the request
l_api_identity_token_request_query = new MetaWrap.XML.Action.WS.api_identity_token_request_query
(
								
    'api_key',
    'code'
);

// Create action
l_api_identity_token_request_query_action = new MetaWrap.XML.Action(l_api_identity_token_request_query,l_api_server + "/api_identity_token_request_query");

// Call the action
if (!l_api_identity_token_request_query_action.run(oncomplete_api_identity_token_request_query))
{
    alert("There was an error calling 'api_identity_token_request_query'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for api_identity_token_request_query
//

// JQuery GET request
    var dataString = 'api_key=api_key&code=code'
    $.get(
      l_api_server+'api_identity_token_request_query',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_identity_token_request_query
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<api_identity_token_request_query version="V1.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<code>code</code>\n';
    dataString += '</api_identity_token_request_query></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

api_identity_token_validate - V0.0 - ThumbWhere

Validates #api_identity_token# and returns its current state.

An API Identity Token or an API Key can be 'revoked' due to abuse.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_identity_token_validate (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.api_identity_token_validate = function(
	p_api_member_token)
{
    this.m_action = {};
    this.m_action.m_api_identity_token_validate = 
    { 
        m_api_member_token:p_api_member_token
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.api_identity_token_validate.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_api_identity_token_validate = 
        {

        };
    return this;
}                   

// Reference to the request
var l_api_identity_token_validate = null;

// Reference to the action
var l_api_identity_token_validate_action = null;

// This is called on completion of a call to api_identity_token_validate
function oncomplete_api_identity_token_validate()
{
    alert("oncomplete_api_identity_token_validate");


    // Get response as object
    var l_obj = l_api_identity_token_validate.m_response.m_api_identity_token_validate;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_api_identity_token_validate_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/api_identity_token_validate/status").text);

    // Get response as a single string
    alert(l_api_identity_token_validate_action.m_response_string);
}

// Create the request
l_api_identity_token_validate = new MetaWrap.XML.Action.WS.api_identity_token_validate
(
								
    'api_member_token'
);

// Create action
l_api_identity_token_validate_action = new MetaWrap.XML.Action(l_api_identity_token_validate,l_api_server + "/api_identity_token_validate");

// Call the action
if (!l_api_identity_token_validate_action.run(oncomplete_api_identity_token_validate))
{
    alert("There was an error calling 'api_identity_token_validate'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for api_identity_token_validate
//

// JQuery GET request
    var dataString = 'api_member_token=api_member_token'
    $.get(
      l_api_server+'api_identity_token_validate',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_identity_token_validate
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<api_identity_token_validate version="V0.0" service="ThumbWhere">\n';
    dataString += '<api_member_token>api_member_token</api_member_token>\n';
    dataString += '</api_identity_token_validate></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

api_identity_token_validate - V1.0 - ThumbWhere

Validates #api_identity_token# and returns its current state.

An API Identity Token or an API Key can be 'revoked' due to abuse.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_identity_token_validate (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.api_identity_token_validate = function(
	p_api_member_token)
{
    this.m_action = {};
    this.m_action.m_api_identity_token_validate = 
    { 
        m_api_member_token:p_api_member_token
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.api_identity_token_validate.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_api_identity_token_validate = 
        {

            m_state:""
        };
    return this;
}                   

// Reference to the request
var l_api_identity_token_validate = null;

// Reference to the action
var l_api_identity_token_validate_action = null;

// This is called on completion of a call to api_identity_token_validate
function oncomplete_api_identity_token_validate()
{
    alert("oncomplete_api_identity_token_validate");


    // Get response as object
    var l_obj = l_api_identity_token_validate.m_response.m_api_identity_token_validate;
    alert("'status' = " + l_obj.m_status);
    alert("'state' = " + l_obj.m_state);

    // Get response as XML
    var l_xml = l_api_identity_token_validate_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/api_identity_token_validate/status").text);    
    alert("'state' (from xml) = " +l_xml.selectSingleNode("response/api_identity_token_validate/state").text);

    // Get response as a single string
    alert(l_api_identity_token_validate_action.m_response_string);
}

// Create the request
l_api_identity_token_validate = new MetaWrap.XML.Action.WS.api_identity_token_validate
(
								
    'api_member_token'
);

// Create action
l_api_identity_token_validate_action = new MetaWrap.XML.Action(l_api_identity_token_validate,l_api_server + "/api_identity_token_validate");

// Call the action
if (!l_api_identity_token_validate_action.run(oncomplete_api_identity_token_validate))
{
    alert("There was an error calling 'api_identity_token_validate'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for api_identity_token_validate
//

// JQuery GET request
    var dataString = 'api_member_token=api_member_token'
    $.get(
      l_api_server+'api_identity_token_validate',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_identity_token_validate
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<api_identity_token_validate version="V1.0" service="ThumbWhere">\n';
    dataString += '<api_member_token>api_member_token</api_member_token>\n';
    dataString += '</api_identity_token_validate></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

api_key_request - V0.0 - ThumbWhere

Requests an API Key for an external application. This will register the external application against the specified user.

After making the request, you need to SMS or MMS #code# to #number# and a call to ^api_key_request_query^ with the returned #code# as a parameter. If the name and the URL is for an existing application then the api_key for that pre-existing application will be returned.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_key_request (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.api_key_request = function(
	p_campaign_id,
	p_name,
	p_url,
	p_description)
{
    this.m_action = {};
    this.m_action.m_api_key_request = 
    { 
        m_campaign_id:p_campaign_id,
        m_name:p_name,
        m_url:p_url,
        m_description:p_description
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.api_key_request.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_api_key_request = 
        {

        };
    return this;
}                   

// Reference to the request
var l_api_key_request = null;

// Reference to the action
var l_api_key_request_action = null;

// This is called on completion of a call to api_key_request
function oncomplete_api_key_request()
{
    alert("oncomplete_api_key_request");


    // Get response as object
    var l_obj = l_api_key_request.m_response.m_api_key_request;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_api_key_request_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/api_key_request/status").text);

    // Get response as a single string
    alert(l_api_key_request_action.m_response_string);
}

// Create the request
l_api_key_request = new MetaWrap.XML.Action.WS.api_key_request
(
								
    'campaign_id',
    'name',
    'url',
    'description'
);

// Create action
l_api_key_request_action = new MetaWrap.XML.Action(l_api_key_request,l_api_server + "/api_key_request");

// Call the action
if (!l_api_key_request_action.run(oncomplete_api_key_request))
{
    alert("There was an error calling 'api_key_request'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for api_key_request
//

// JQuery GET request
    var dataString = 'campaign_id=campaign_id&name=name&url=url&description=description'
    $.get(
      l_api_server+'api_key_request',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_key_request
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<api_key_request version="V0.0" service="ThumbWhere">\n';
    dataString += '<campaign_id>campaign_id</campaign_id>\n';
    dataString += '<name>name</name>\n';
    dataString += '<url>url</url>\n';
    dataString += '<description>description</description>\n';
    dataString += '</api_key_request></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

api_key_request - V1.0 - ThumbWhere

Requests an API Key for an external application. This will register the external application against the specified user.

After making the request, you need to SMS or MMS #code# to #number# and a call to ^api_key_request_query^ with the returned #code# as a parameter. If the name and the URL is for an existing application then the api_key for that pre-existing application will be returned.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_key_request (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.api_key_request = function(
	p_campaign_id,
	p_name,
	p_url,
	p_description)
{
    this.m_action = {};
    this.m_action.m_api_key_request = 
    { 
        m_campaign_id:p_campaign_id,
        m_name:p_name,
        m_url:p_url,
        m_description:p_description
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.api_key_request.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_api_key_request = 
        {

            m_code:"",
            m_number:""
        };
    return this;
}                   

// Reference to the request
var l_api_key_request = null;

// Reference to the action
var l_api_key_request_action = null;

// This is called on completion of a call to api_key_request
function oncomplete_api_key_request()
{
    alert("oncomplete_api_key_request");


    // Get response as object
    var l_obj = l_api_key_request.m_response.m_api_key_request;
    alert("'status' = " + l_obj.m_status);
    alert("'code' = " + l_obj.m_code);
    alert("'number' = " + l_obj.m_number);

    // Get response as XML
    var l_xml = l_api_key_request_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/api_key_request/status").text);    
    alert("'code' (from xml) = " +l_xml.selectSingleNode("response/api_key_request/code").text);    
    alert("'number' (from xml) = " +l_xml.selectSingleNode("response/api_key_request/number").text);

    // Get response as a single string
    alert(l_api_key_request_action.m_response_string);
}

// Create the request
l_api_key_request = new MetaWrap.XML.Action.WS.api_key_request
(
								
    'campaign_id',
    'name',
    'url',
    'description'
);

// Create action
l_api_key_request_action = new MetaWrap.XML.Action(l_api_key_request,l_api_server + "/api_key_request");

// Call the action
if (!l_api_key_request_action.run(oncomplete_api_key_request))
{
    alert("There was an error calling 'api_key_request'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for api_key_request
//

// JQuery GET request
    var dataString = 'campaign_id=campaign_id&name=name&url=url&description=description'
    $.get(
      l_api_server+'api_key_request',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_key_request
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<api_key_request version="V1.0" service="ThumbWhere">\n';
    dataString += '<campaign_id>campaign_id</campaign_id>\n';
    dataString += '<name>name</name>\n';
    dataString += '<url>url</url>\n';
    dataString += '<description>description</description>\n';
    dataString += '</api_key_request></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

api_key_request_query - V0.0 - ThumbWhere

Queries the state of an API Key request.

This is a back end API call - this is not part of the public API. This should be performed after a call to ^api_key_request^ and should pass in the code returned by that call. The api key details will not be returned until the code has been sent by SMS to the mobile number will also have been returned by ^api_key_request^.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_key_request_query (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.api_key_request_query = function(
	p_campaign_id,
	p_code)
{
    this.m_action = {};
    this.m_action.m_api_key_request_query = 
    { 
        m_campaign_id:p_campaign_id,
        m_code:p_code
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.api_key_request_query.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_api_key_request_query = 
        {

        };
    return this;
}                   

// Reference to the request
var l_api_key_request_query = null;

// Reference to the action
var l_api_key_request_query_action = null;

// This is called on completion of a call to api_key_request_query
function oncomplete_api_key_request_query()
{
    alert("oncomplete_api_key_request_query");


    // Get response as object
    var l_obj = l_api_key_request_query.m_response.m_api_key_request_query;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_api_key_request_query_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/api_key_request_query/status").text);

    // Get response as a single string
    alert(l_api_key_request_query_action.m_response_string);
}

// Create the request
l_api_key_request_query = new MetaWrap.XML.Action.WS.api_key_request_query
(
								
    'campaign_id',
    'code'
);

// Create action
l_api_key_request_query_action = new MetaWrap.XML.Action(l_api_key_request_query,l_api_server + "/api_key_request_query");

// Call the action
if (!l_api_key_request_query_action.run(oncomplete_api_key_request_query))
{
    alert("There was an error calling 'api_key_request_query'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for api_key_request_query
//

// JQuery GET request
    var dataString = 'campaign_id=campaign_id&code=code'
    $.get(
      l_api_server+'api_key_request_query',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_key_request_query
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<api_key_request_query version="V0.0" service="ThumbWhere">\n';
    dataString += '<campaign_id>campaign_id</campaign_id>\n';
    dataString += '<code>code</code>\n';
    dataString += '</api_key_request_query></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

api_key_request_query - V1.0 - ThumbWhere

Queries the state of an API Key request.

This is a back end API call - this is not part of the public API. This should be performed after a call to ^api_key_request^ and should pass in the code returned by that call. The api key details will not be returned until the code has been sent by SMS to the mobile number will also have been returned by ^api_key_request^.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_key_request_query (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.api_key_request_query = function(
	p_campaign_id,
	p_code)
{
    this.m_action = {};
    this.m_action.m_api_key_request_query = 
    { 
        m_campaign_id:p_campaign_id,
        m_code:p_code
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.api_key_request_query.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_api_key_request_query = 
        {

            m_request:"",
            m_expiry_seconds:"",
            m_api_key:""
        };
    return this;
}                   

// Reference to the request
var l_api_key_request_query = null;

// Reference to the action
var l_api_key_request_query_action = null;

// This is called on completion of a call to api_key_request_query
function oncomplete_api_key_request_query()
{
    alert("oncomplete_api_key_request_query");


    // Get response as object
    var l_obj = l_api_key_request_query.m_response.m_api_key_request_query;
    alert("'status' = " + l_obj.m_status);
    alert("'request' = " + l_obj.m_request);
    alert("'expiry_seconds' = " + l_obj.m_expiry_seconds);
    alert("'api_key' = " + l_obj.m_api_key);

    // Get response as XML
    var l_xml = l_api_key_request_query_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/api_key_request_query/status").text);    
    alert("'request' (from xml) = " +l_xml.selectSingleNode("response/api_key_request_query/request").text);    
    alert("'expiry_seconds' (from xml) = " +l_xml.selectSingleNode("response/api_key_request_query/expiry_seconds").text);    
    alert("'api_key' (from xml) = " +l_xml.selectSingleNode("response/api_key_request_query/api_key").text);

    // Get response as a single string
    alert(l_api_key_request_query_action.m_response_string);
}

// Create the request
l_api_key_request_query = new MetaWrap.XML.Action.WS.api_key_request_query
(
								
    'campaign_id',
    'code'
);

// Create action
l_api_key_request_query_action = new MetaWrap.XML.Action(l_api_key_request_query,l_api_server + "/api_key_request_query");

// Call the action
if (!l_api_key_request_query_action.run(oncomplete_api_key_request_query))
{
    alert("There was an error calling 'api_key_request_query'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for api_key_request_query
//

// JQuery GET request
    var dataString = 'campaign_id=campaign_id&code=code'
    $.get(
      l_api_server+'api_key_request_query',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_key_request_query
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<api_key_request_query version="V1.0" service="ThumbWhere">\n';
    dataString += '<campaign_id>campaign_id</campaign_id>\n';
    dataString += '<code>code</code>\n';
    dataString += '</api_key_request_query></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

api_key_validate - V0.0 - ThumbWhere

Validates #api_key# and returns its current state

An API key can be 'revoked' due to abuse.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_key_validate (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.api_key_validate = function(
	p_api_key)
{
    this.m_action = {};
    this.m_action.m_api_key_validate = 
    { 
        m_api_key:p_api_key
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.api_key_validate.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_api_key_validate = 
        {

        };
    return this;
}                   

// Reference to the request
var l_api_key_validate = null;

// Reference to the action
var l_api_key_validate_action = null;

// This is called on completion of a call to api_key_validate
function oncomplete_api_key_validate()
{
    alert("oncomplete_api_key_validate");


    // Get response as object
    var l_obj = l_api_key_validate.m_response.m_api_key_validate;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_api_key_validate_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/api_key_validate/status").text);

    // Get response as a single string
    alert(l_api_key_validate_action.m_response_string);
}

// Create the request
l_api_key_validate = new MetaWrap.XML.Action.WS.api_key_validate
(
								
    'api_key'
);

// Create action
l_api_key_validate_action = new MetaWrap.XML.Action(l_api_key_validate,l_api_server + "/api_key_validate");

// Call the action
if (!l_api_key_validate_action.run(oncomplete_api_key_validate))
{
    alert("There was an error calling 'api_key_validate'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for api_key_validate
//

// JQuery GET request
    var dataString = 'api_key=api_key'
    $.get(
      l_api_server+'api_key_validate',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_key_validate
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<api_key_validate version="V0.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '</api_key_validate></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

api_key_validate - V1.0 - ThumbWhere

Validates #api_key# and returns its current state

An API key can be 'revoked' due to abuse.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_key_validate (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.api_key_validate = function(
	p_api_key)
{
    this.m_action = {};
    this.m_action.m_api_key_validate = 
    { 
        m_api_key:p_api_key
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.api_key_validate.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_api_key_validate = 
        {

            m_state:""
        };
    return this;
}                   

// Reference to the request
var l_api_key_validate = null;

// Reference to the action
var l_api_key_validate_action = null;

// This is called on completion of a call to api_key_validate
function oncomplete_api_key_validate()
{
    alert("oncomplete_api_key_validate");


    // Get response as object
    var l_obj = l_api_key_validate.m_response.m_api_key_validate;
    alert("'status' = " + l_obj.m_status);
    alert("'state' = " + l_obj.m_state);

    // Get response as XML
    var l_xml = l_api_key_validate_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/api_key_validate/status").text);    
    alert("'state' (from xml) = " +l_xml.selectSingleNode("response/api_key_validate/state").text);

    // Get response as a single string
    alert(l_api_key_validate_action.m_response_string);
}

// Create the request
l_api_key_validate = new MetaWrap.XML.Action.WS.api_key_validate
(
								
    'api_key'
);

// Create action
l_api_key_validate_action = new MetaWrap.XML.Action(l_api_key_validate,l_api_server + "/api_key_validate");

// Call the action
if (!l_api_key_validate_action.run(oncomplete_api_key_validate))
{
    alert("There was an error calling 'api_key_validate'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for api_key_validate
//

// JQuery GET request
    var dataString = 'api_key=api_key'
    $.get(
      l_api_server+'api_key_validate',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_key_validate
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<api_key_validate version="V1.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '</api_key_validate></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

api_member_token_create_code - V0.0 - ThumbWhere

Creates a lookup #code# that can be exchanged in the future for the specified api_member_token

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_member_token_create_code (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.api_member_token_create_code = function(
	p_api_key,
	p_api_member_token,
	p_alphabet,
	p_length)
{
    this.m_action = {};
    this.m_action.m_api_member_token_create_code = 
    { 
        m_api_key:p_api_key,
        m_api_member_token:p_api_member_token,
        m_alphabet:p_alphabet,
        m_length:p_length
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.api_member_token_create_code.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_api_member_token_create_code = 
        {

        };
    return this;
}                   

// Reference to the request
var l_api_member_token_create_code = null;

// Reference to the action
var l_api_member_token_create_code_action = null;

// This is called on completion of a call to api_member_token_create_code
function oncomplete_api_member_token_create_code()
{
    alert("oncomplete_api_member_token_create_code");


    // Get response as object
    var l_obj = l_api_member_token_create_code.m_response.m_api_member_token_create_code;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_api_member_token_create_code_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/api_member_token_create_code/status").text);

    // Get response as a single string
    alert(l_api_member_token_create_code_action.m_response_string);
}

// Create the request
l_api_member_token_create_code = new MetaWrap.XML.Action.WS.api_member_token_create_code
(
								
    'api_key',
    'api_member_token',
    'alphabet',
    'length'
);

// Create action
l_api_member_token_create_code_action = new MetaWrap.XML.Action(l_api_member_token_create_code,l_api_server + "/api_member_token_create_code");

// Call the action
if (!l_api_member_token_create_code_action.run(oncomplete_api_member_token_create_code))
{
    alert("There was an error calling 'api_member_token_create_code'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for api_member_token_create_code
//

// JQuery GET request
    var dataString = 'api_key=api_key&api_member_token=api_member_token&alphabet=alphabet&length=length'
    $.get(
      l_api_server+'api_member_token_create_code',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_member_token_create_code
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<api_member_token_create_code version="V0.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<api_member_token>api_member_token</api_member_token>\n';
    dataString += '<alphabet>alphabet</alphabet>\n';
    dataString += '<length>length</length>\n';
    dataString += '</api_member_token_create_code></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

api_member_token_create_code - V1.0 - ThumbWhere

Creates a lookup #code# that can be exchanged in the future for the specified api_member_token

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_member_token_create_code (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.api_member_token_create_code = function(
	p_api_key,
	p_api_member_token,
	p_alphabet,
	p_length)
{
    this.m_action = {};
    this.m_action.m_api_member_token_create_code = 
    { 
        m_api_key:p_api_key,
        m_api_member_token:p_api_member_token,
        m_alphabet:p_alphabet,
        m_length:p_length
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.api_member_token_create_code.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_api_member_token_create_code = 
        {

            m_code:""
        };
    return this;
}                   

// Reference to the request
var l_api_member_token_create_code = null;

// Reference to the action
var l_api_member_token_create_code_action = null;

// This is called on completion of a call to api_member_token_create_code
function oncomplete_api_member_token_create_code()
{
    alert("oncomplete_api_member_token_create_code");


    // Get response as object
    var l_obj = l_api_member_token_create_code.m_response.m_api_member_token_create_code;
    alert("'status' = " + l_obj.m_status);
    alert("'code' = " + l_obj.m_code);

    // Get response as XML
    var l_xml = l_api_member_token_create_code_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/api_member_token_create_code/status").text);    
    alert("'code' (from xml) = " +l_xml.selectSingleNode("response/api_member_token_create_code/code").text);

    // Get response as a single string
    alert(l_api_member_token_create_code_action.m_response_string);
}

// Create the request
l_api_member_token_create_code = new MetaWrap.XML.Action.WS.api_member_token_create_code
(
								
    'api_key',
    'api_member_token',
    'alphabet',
    'length'
);

// Create action
l_api_member_token_create_code_action = new MetaWrap.XML.Action(l_api_member_token_create_code,l_api_server + "/api_member_token_create_code");

// Call the action
if (!l_api_member_token_create_code_action.run(oncomplete_api_member_token_create_code))
{
    alert("There was an error calling 'api_member_token_create_code'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for api_member_token_create_code
//

// JQuery GET request
    var dataString = 'api_key=api_key&api_member_token=api_member_token&alphabet=alphabet&length=length'
    $.get(
      l_api_server+'api_member_token_create_code',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_member_token_create_code
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<api_member_token_create_code version="V1.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<api_member_token>api_member_token</api_member_token>\n';
    dataString += '<alphabet>alphabet</alphabet>\n';
    dataString += '<length>length</length>\n';
    dataString += '</api_member_token_create_code></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

api_member_token_create_code_by_identity_id - V0.0 - ThumbWhere

Creates a lookup #code# that can be exchanged in the future for the specified api_member_token

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_member_token_create_code_by_identity_id (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.api_member_token_create_code_by_identity_id = function(
	p_master_key,
	p_api_key,
	p_id,
	p_type,
	p_alphabet,
	p_length)
{
    this.m_action = {};
    this.m_action.m_api_member_token_create_code_by_identity_id = 
    { 
        m_master_key:p_master_key,
        m_api_key:p_api_key,
        m_id:p_id,
        m_type:p_type,
        m_alphabet:p_alphabet,
        m_length:p_length
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.api_member_token_create_code_by_identity_id.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_api_member_token_create_code_by_identity_id = 
        {

        };
    return this;
}                   

// Reference to the request
var l_api_member_token_create_code_by_identity_id = null;

// Reference to the action
var l_api_member_token_create_code_by_identity_id_action = null;

// This is called on completion of a call to api_member_token_create_code_by_identity_id
function oncomplete_api_member_token_create_code_by_identity_id()
{
    alert("oncomplete_api_member_token_create_code_by_identity_id");


    // Get response as object
    var l_obj = l_api_member_token_create_code_by_identity_id.m_response.m_api_member_token_create_code_by_identity_id;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_api_member_token_create_code_by_identity_id_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/api_member_token_create_code_by_identity_id/status").text);

    // Get response as a single string
    alert(l_api_member_token_create_code_by_identity_id_action.m_response_string);
}

// Create the request
l_api_member_token_create_code_by_identity_id = new MetaWrap.XML.Action.WS.api_member_token_create_code_by_identity_id
(
								
    'master_key',
    'api_key',
    'id',
    'type',
    'alphabet',
    'length'
);

// Create action
l_api_member_token_create_code_by_identity_id_action = new MetaWrap.XML.Action(l_api_member_token_create_code_by_identity_id,l_api_server + "/api_member_token_create_code_by_identity_id");

// Call the action
if (!l_api_member_token_create_code_by_identity_id_action.run(oncomplete_api_member_token_create_code_by_identity_id))
{
    alert("There was an error calling 'api_member_token_create_code_by_identity_id'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for api_member_token_create_code_by_identity_id
//

// JQuery GET request
    var dataString = 'master_key=master_key&api_key=api_key&id=id&type=type&alphabet=alphabet&length=length'
    $.get(
      l_api_server+'api_member_token_create_code_by_identity_id',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_member_token_create_code_by_identity_id
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<api_member_token_create_code_by_identity_id version="V0.0" service="ThumbWhere">\n';
    dataString += '<master_key>master_key</master_key>\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<id>id</id>\n';
    dataString += '<type>type</type>\n';
    dataString += '<alphabet>alphabet</alphabet>\n';
    dataString += '<length>length</length>\n';
    dataString += '</api_member_token_create_code_by_identity_id></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

api_member_token_create_code_by_identity_id - V1.0 - ThumbWhere

Creates a lookup #code# that can be exchanged in the future for the specified api_member_token

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_member_token_create_code_by_identity_id (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.api_member_token_create_code_by_identity_id = function(
	p_master_key,
	p_api_key,
	p_id,
	p_type,
	p_alphabet,
	p_length)
{
    this.m_action = {};
    this.m_action.m_api_member_token_create_code_by_identity_id = 
    { 
        m_master_key:p_master_key,
        m_api_key:p_api_key,
        m_id:p_id,
        m_type:p_type,
        m_alphabet:p_alphabet,
        m_length:p_length
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.api_member_token_create_code_by_identity_id.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_api_member_token_create_code_by_identity_id = 
        {

            m_code:""
        };
    return this;
}                   

// Reference to the request
var l_api_member_token_create_code_by_identity_id = null;

// Reference to the action
var l_api_member_token_create_code_by_identity_id_action = null;

// This is called on completion of a call to api_member_token_create_code_by_identity_id
function oncomplete_api_member_token_create_code_by_identity_id()
{
    alert("oncomplete_api_member_token_create_code_by_identity_id");


    // Get response as object
    var l_obj = l_api_member_token_create_code_by_identity_id.m_response.m_api_member_token_create_code_by_identity_id;
    alert("'status' = " + l_obj.m_status);
    alert("'code' = " + l_obj.m_code);

    // Get response as XML
    var l_xml = l_api_member_token_create_code_by_identity_id_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/api_member_token_create_code_by_identity_id/status").text);    
    alert("'code' (from xml) = " +l_xml.selectSingleNode("response/api_member_token_create_code_by_identity_id/code").text);

    // Get response as a single string
    alert(l_api_member_token_create_code_by_identity_id_action.m_response_string);
}

// Create the request
l_api_member_token_create_code_by_identity_id = new MetaWrap.XML.Action.WS.api_member_token_create_code_by_identity_id
(
								
    'master_key',
    'api_key',
    'id',
    'type',
    'alphabet',
    'length'
);

// Create action
l_api_member_token_create_code_by_identity_id_action = new MetaWrap.XML.Action(l_api_member_token_create_code_by_identity_id,l_api_server + "/api_member_token_create_code_by_identity_id");

// Call the action
if (!l_api_member_token_create_code_by_identity_id_action.run(oncomplete_api_member_token_create_code_by_identity_id))
{
    alert("There was an error calling 'api_member_token_create_code_by_identity_id'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for api_member_token_create_code_by_identity_id
//

// JQuery GET request
    var dataString = 'master_key=master_key&api_key=api_key&id=id&type=type&alphabet=alphabet&length=length'
    $.get(
      l_api_server+'api_member_token_create_code_by_identity_id',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_member_token_create_code_by_identity_id
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<api_member_token_create_code_by_identity_id version="V1.0" service="ThumbWhere">\n';
    dataString += '<master_key>master_key</master_key>\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<id>id</id>\n';
    dataString += '<type>type</type>\n';
    dataString += '<alphabet>alphabet</alphabet>\n';
    dataString += '<length>length</length>\n';
    dataString += '</api_member_token_create_code_by_identity_id></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

api_member_token_login - V0.0 - ThumbWhere

Login using an #api_key#/#api_member_token# pair.

This is used to provide the same response as a normal username/password login (using ^member_login^ and ^member_login_identity^) from just the #api_member_token#

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_member_token_login (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.api_member_token_login = function(
	p_api_key,
	p_api_member_token)
{
    this.m_action = {};
    this.m_action.m_api_member_token_login = 
    { 
        m_api_key:p_api_key,
        m_api_member_token:p_api_member_token
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.api_member_token_login.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_api_member_token_login = 
        {

        };
    return this;
}                   

// Reference to the request
var l_api_member_token_login = null;

// Reference to the action
var l_api_member_token_login_action = null;

// This is called on completion of a call to api_member_token_login
function oncomplete_api_member_token_login()
{
    alert("oncomplete_api_member_token_login");


    // Get response as object
    var l_obj = l_api_member_token_login.m_response.m_api_member_token_login;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_api_member_token_login_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/api_member_token_login/status").text);

    // Get response as a single string
    alert(l_api_member_token_login_action.m_response_string);
}

// Create the request
l_api_member_token_login = new MetaWrap.XML.Action.WS.api_member_token_login
(
								
    'api_key',
    'api_member_token'
);

// Create action
l_api_member_token_login_action = new MetaWrap.XML.Action(l_api_member_token_login,l_api_server + "/api_member_token_login");

// Call the action
if (!l_api_member_token_login_action.run(oncomplete_api_member_token_login))
{
    alert("There was an error calling 'api_member_token_login'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for api_member_token_login
//

// JQuery GET request
    var dataString = 'api_key=api_key&api_member_token=api_member_token'
    $.get(
      l_api_server+'api_member_token_login',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_member_token_login
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<api_member_token_login version="V0.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<api_member_token>api_member_token</api_member_token>\n';
    dataString += '</api_member_token_login></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

api_member_token_login - V1.0 - ThumbWhere

Login using an #api_key#/#api_member_token# pair.

This is used to provide the same response as a normal username/password login (using ^member_login^ and ^member_login_identity^) from just the #api_member_token#

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_member_token_login (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.api_member_token_login = function(
	p_api_key,
	p_api_member_token)
{
    this.m_action = {};
    this.m_action.m_api_member_token_login = 
    { 
        m_api_key:p_api_key,
        m_api_member_token:p_api_member_token
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.api_member_token_login.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_api_member_token_login = 
        {

            m_username:"",
            m_feedurl:""
        };
    return this;
}                   

// Reference to the request
var l_api_member_token_login = null;

// Reference to the action
var l_api_member_token_login_action = null;

// This is called on completion of a call to api_member_token_login
function oncomplete_api_member_token_login()
{
    alert("oncomplete_api_member_token_login");


    // Get response as object
    var l_obj = l_api_member_token_login.m_response.m_api_member_token_login;
    alert("'status' = " + l_obj.m_status);
    alert("'username' = " + l_obj.m_username);
    alert("'feedurl' = " + l_obj.m_feedurl);

    // Get response as XML
    var l_xml = l_api_member_token_login_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/api_member_token_login/status").text);    
    alert("'username' (from xml) = " +l_xml.selectSingleNode("response/api_member_token_login/username").text);    
    alert("'feedurl' (from xml) = " +l_xml.selectSingleNode("response/api_member_token_login/feedurl").text);

    // Get response as a single string
    alert(l_api_member_token_login_action.m_response_string);
}

// Create the request
l_api_member_token_login = new MetaWrap.XML.Action.WS.api_member_token_login
(
								
    'api_key',
    'api_member_token'
);

// Create action
l_api_member_token_login_action = new MetaWrap.XML.Action(l_api_member_token_login,l_api_server + "/api_member_token_login");

// Call the action
if (!l_api_member_token_login_action.run(oncomplete_api_member_token_login))
{
    alert("There was an error calling 'api_member_token_login'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for api_member_token_login
//

// JQuery GET request
    var dataString = 'api_key=api_key&api_member_token=api_member_token'
    $.get(
      l_api_server+'api_member_token_login',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_member_token_login
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<api_member_token_login version="V1.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<api_member_token>api_member_token</api_member_token>\n';
    dataString += '</api_member_token_login></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

api_member_token_lookup_code - V0.0 - ThumbWhere

Returns an #api_member_token# associated with a lookup #code#

To create a code, make a call to ^api_member_token_create_code^ with the #api_member_token# that you want to create.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_member_token_lookup_code (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.api_member_token_lookup_code = function(
	p_api_key,
	p_code)
{
    this.m_action = {};
    this.m_action.m_api_member_token_lookup_code = 
    { 
        m_api_key:p_api_key,
        m_code:p_code
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.api_member_token_lookup_code.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_api_member_token_lookup_code = 
        {

        };
    return this;
}                   

// Reference to the request
var l_api_member_token_lookup_code = null;

// Reference to the action
var l_api_member_token_lookup_code_action = null;

// This is called on completion of a call to api_member_token_lookup_code
function oncomplete_api_member_token_lookup_code()
{
    alert("oncomplete_api_member_token_lookup_code");


    // Get response as object
    var l_obj = l_api_member_token_lookup_code.m_response.m_api_member_token_lookup_code;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_api_member_token_lookup_code_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/api_member_token_lookup_code/status").text);

    // Get response as a single string
    alert(l_api_member_token_lookup_code_action.m_response_string);
}

// Create the request
l_api_member_token_lookup_code = new MetaWrap.XML.Action.WS.api_member_token_lookup_code
(
								
    'api_key',
    'code'
);

// Create action
l_api_member_token_lookup_code_action = new MetaWrap.XML.Action(l_api_member_token_lookup_code,l_api_server + "/api_member_token_lookup_code");

// Call the action
if (!l_api_member_token_lookup_code_action.run(oncomplete_api_member_token_lookup_code))
{
    alert("There was an error calling 'api_member_token_lookup_code'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for api_member_token_lookup_code
//

// JQuery GET request
    var dataString = 'api_key=api_key&code=code'
    $.get(
      l_api_server+'api_member_token_lookup_code',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_member_token_lookup_code
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<api_member_token_lookup_code version="V0.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<code>code</code>\n';
    dataString += '</api_member_token_lookup_code></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

api_member_token_lookup_code - V1.0 - ThumbWhere

Returns an #api_member_token# associated with a lookup #code#

To create a code, make a call to ^api_member_token_create_code^ with the #api_member_token# that you want to create.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_member_token_lookup_code (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.api_member_token_lookup_code = function(
	p_api_key,
	p_code)
{
    this.m_action = {};
    this.m_action.m_api_member_token_lookup_code = 
    { 
        m_api_key:p_api_key,
        m_code:p_code
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.api_member_token_lookup_code.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_api_member_token_lookup_code = 
        {

            m_api_member_token:""
        };
    return this;
}                   

// Reference to the request
var l_api_member_token_lookup_code = null;

// Reference to the action
var l_api_member_token_lookup_code_action = null;

// This is called on completion of a call to api_member_token_lookup_code
function oncomplete_api_member_token_lookup_code()
{
    alert("oncomplete_api_member_token_lookup_code");


    // Get response as object
    var l_obj = l_api_member_token_lookup_code.m_response.m_api_member_token_lookup_code;
    alert("'status' = " + l_obj.m_status);
    alert("'api_member_token' = " + l_obj.m_api_member_token);

    // Get response as XML
    var l_xml = l_api_member_token_lookup_code_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/api_member_token_lookup_code/status").text);    
    alert("'api_member_token' (from xml) = " +l_xml.selectSingleNode("response/api_member_token_lookup_code/api_member_token").text);

    // Get response as a single string
    alert(l_api_member_token_lookup_code_action.m_response_string);
}

// Create the request
l_api_member_token_lookup_code = new MetaWrap.XML.Action.WS.api_member_token_lookup_code
(
								
    'api_key',
    'code'
);

// Create action
l_api_member_token_lookup_code_action = new MetaWrap.XML.Action(l_api_member_token_lookup_code,l_api_server + "/api_member_token_lookup_code");

// Call the action
if (!l_api_member_token_lookup_code_action.run(oncomplete_api_member_token_lookup_code))
{
    alert("There was an error calling 'api_member_token_lookup_code'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for api_member_token_lookup_code
//

// JQuery GET request
    var dataString = 'api_key=api_key&code=code'
    $.get(
      l_api_server+'api_member_token_lookup_code',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_member_token_lookup_code
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<api_member_token_lookup_code version="V1.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<code>code</code>\n';
    dataString += '</api_member_token_lookup_code></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

api_member_token_request - V0.0 - ThumbWhere

Requests an API Member Token.

After making the request, you need to SMS or MMS #code# to #number# and a call to ^api_member_token_request_query^ with the returned #code# as a parameter.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_member_token_request (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.api_member_token_request = function(
	p_api_key)
{
    this.m_action = {};
    this.m_action.m_api_member_token_request = 
    { 
        m_api_key:p_api_key
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.api_member_token_request.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_api_member_token_request = 
        {

        };
    return this;
}                   

// Reference to the request
var l_api_member_token_request = null;

// Reference to the action
var l_api_member_token_request_action = null;

// This is called on completion of a call to api_member_token_request
function oncomplete_api_member_token_request()
{
    alert("oncomplete_api_member_token_request");


    // Get response as object
    var l_obj = l_api_member_token_request.m_response.m_api_member_token_request;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_api_member_token_request_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/api_member_token_request/status").text);

    // Get response as a single string
    alert(l_api_member_token_request_action.m_response_string);
}

// Create the request
l_api_member_token_request = new MetaWrap.XML.Action.WS.api_member_token_request
(
								
    'api_key'
);

// Create action
l_api_member_token_request_action = new MetaWrap.XML.Action(l_api_member_token_request,l_api_server + "/api_member_token_request");

// Call the action
if (!l_api_member_token_request_action.run(oncomplete_api_member_token_request))
{
    alert("There was an error calling 'api_member_token_request'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for api_member_token_request
//

// JQuery GET request
    var dataString = 'api_key=api_key'
    $.get(
      l_api_server+'api_member_token_request',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_member_token_request
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<api_member_token_request version="V0.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '</api_member_token_request></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

api_member_token_request - V1.0 - ThumbWhere

Requests an API Member Token.

After making the request, you need to SMS or MMS #code# to #number# and a call to ^api_member_token_request_query^ with the returned #code# as a parameter.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_member_token_request (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.api_member_token_request = function(
	p_api_key)
{
    this.m_action = {};
    this.m_action.m_api_member_token_request = 
    { 
        m_api_key:p_api_key
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.api_member_token_request.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_api_member_token_request = 
        {

            m_code:"",
            m_number:""
        };
    return this;
}                   

// Reference to the request
var l_api_member_token_request = null;

// Reference to the action
var l_api_member_token_request_action = null;

// This is called on completion of a call to api_member_token_request
function oncomplete_api_member_token_request()
{
    alert("oncomplete_api_member_token_request");


    // Get response as object
    var l_obj = l_api_member_token_request.m_response.m_api_member_token_request;
    alert("'status' = " + l_obj.m_status);
    alert("'code' = " + l_obj.m_code);
    alert("'number' = " + l_obj.m_number);

    // Get response as XML
    var l_xml = l_api_member_token_request_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/api_member_token_request/status").text);    
    alert("'code' (from xml) = " +l_xml.selectSingleNode("response/api_member_token_request/code").text);    
    alert("'number' (from xml) = " +l_xml.selectSingleNode("response/api_member_token_request/number").text);

    // Get response as a single string
    alert(l_api_member_token_request_action.m_response_string);
}

// Create the request
l_api_member_token_request = new MetaWrap.XML.Action.WS.api_member_token_request
(
								
    'api_key'
);

// Create action
l_api_member_token_request_action = new MetaWrap.XML.Action(l_api_member_token_request,l_api_server + "/api_member_token_request");

// Call the action
if (!l_api_member_token_request_action.run(oncomplete_api_member_token_request))
{
    alert("There was an error calling 'api_member_token_request'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for api_member_token_request
//

// JQuery GET request
    var dataString = 'api_key=api_key'
    $.get(
      l_api_server+'api_member_token_request',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_member_token_request
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<api_member_token_request version="V1.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '</api_member_token_request></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

api_member_token_request_query - V0.0 - ThumbWhere

Query the status of an API request.

This should be performed after a call to ^api_member_token_request^ and should pass in the code returned by that call. The api member_token details will not be returned until the code has been sent by SMS to the mobile number will also have been returned by ^api_member_token_request^.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_member_token_request_query (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.api_member_token_request_query = function(
	p_api_key,
	p_code)
{
    this.m_action = {};
    this.m_action.m_api_member_token_request_query = 
    { 
        m_api_key:p_api_key,
        m_code:p_code
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.api_member_token_request_query.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_api_member_token_request_query = 
        {

        };
    return this;
}                   

// Reference to the request
var l_api_member_token_request_query = null;

// Reference to the action
var l_api_member_token_request_query_action = null;

// This is called on completion of a call to api_member_token_request_query
function oncomplete_api_member_token_request_query()
{
    alert("oncomplete_api_member_token_request_query");


    // Get response as object
    var l_obj = l_api_member_token_request_query.m_response.m_api_member_token_request_query;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_api_member_token_request_query_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/api_member_token_request_query/status").text);

    // Get response as a single string
    alert(l_api_member_token_request_query_action.m_response_string);
}

// Create the request
l_api_member_token_request_query = new MetaWrap.XML.Action.WS.api_member_token_request_query
(
								
    'api_key',
    'code'
);

// Create action
l_api_member_token_request_query_action = new MetaWrap.XML.Action(l_api_member_token_request_query,l_api_server + "/api_member_token_request_query");

// Call the action
if (!l_api_member_token_request_query_action.run(oncomplete_api_member_token_request_query))
{
    alert("There was an error calling 'api_member_token_request_query'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for api_member_token_request_query
//

// JQuery GET request
    var dataString = 'api_key=api_key&code=code'
    $.get(
      l_api_server+'api_member_token_request_query',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_member_token_request_query
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<api_member_token_request_query version="V0.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<code>code</code>\n';
    dataString += '</api_member_token_request_query></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

api_member_token_request_query - V1.0 - ThumbWhere

Query the status of an API request.

This should be performed after a call to ^api_member_token_request^ and should pass in the code returned by that call. The api member_token details will not be returned until the code has been sent by SMS to the mobile number will also have been returned by ^api_member_token_request^.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_member_token_request_query (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.api_member_token_request_query = function(
	p_api_key,
	p_code)
{
    this.m_action = {};
    this.m_action.m_api_member_token_request_query = 
    { 
        m_api_key:p_api_key,
        m_code:p_code
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.api_member_token_request_query.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_api_member_token_request_query = 
        {

            m_request:"",
            m_expiry_seconds:"",
            m_api_member_token:""
        };
    return this;
}                   

// Reference to the request
var l_api_member_token_request_query = null;

// Reference to the action
var l_api_member_token_request_query_action = null;

// This is called on completion of a call to api_member_token_request_query
function oncomplete_api_member_token_request_query()
{
    alert("oncomplete_api_member_token_request_query");


    // Get response as object
    var l_obj = l_api_member_token_request_query.m_response.m_api_member_token_request_query;
    alert("'status' = " + l_obj.m_status);
    alert("'request' = " + l_obj.m_request);
    alert("'expiry_seconds' = " + l_obj.m_expiry_seconds);
    alert("'api_member_token' = " + l_obj.m_api_member_token);

    // Get response as XML
    var l_xml = l_api_member_token_request_query_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/api_member_token_request_query/status").text);    
    alert("'request' (from xml) = " +l_xml.selectSingleNode("response/api_member_token_request_query/request").text);    
    alert("'expiry_seconds' (from xml) = " +l_xml.selectSingleNode("response/api_member_token_request_query/expiry_seconds").text);    
    alert("'api_member_token' (from xml) = " +l_xml.selectSingleNode("response/api_member_token_request_query/api_member_token").text);

    // Get response as a single string
    alert(l_api_member_token_request_query_action.m_response_string);
}

// Create the request
l_api_member_token_request_query = new MetaWrap.XML.Action.WS.api_member_token_request_query
(
								
    'api_key',
    'code'
);

// Create action
l_api_member_token_request_query_action = new MetaWrap.XML.Action(l_api_member_token_request_query,l_api_server + "/api_member_token_request_query");

// Call the action
if (!l_api_member_token_request_query_action.run(oncomplete_api_member_token_request_query))
{
    alert("There was an error calling 'api_member_token_request_query'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for api_member_token_request_query
//

// JQuery GET request
    var dataString = 'api_key=api_key&code=code'
    $.get(
      l_api_server+'api_member_token_request_query',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_member_token_request_query
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<api_member_token_request_query version="V1.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<code>code</code>\n';
    dataString += '</api_member_token_request_query></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

api_member_token_revoke_code - V0.0 - ThumbWhere

If the supplied #code# exists, it is deleted.

To create a code, make a call to ^api_member_token_create_code^ with the #api_member_token# that you want to create.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_member_token_revoke_code (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.api_member_token_revoke_code = function(
	p_api_key,
	p_code)
{
    this.m_action = {};
    this.m_action.m_api_member_token_revoke_code = 
    { 
        m_api_key:p_api_key,
        m_code:p_code
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.api_member_token_revoke_code.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_api_member_token_revoke_code = 
        {

        };
    return this;
}                   

// Reference to the request
var l_api_member_token_revoke_code = null;

// Reference to the action
var l_api_member_token_revoke_code_action = null;

// This is called on completion of a call to api_member_token_revoke_code
function oncomplete_api_member_token_revoke_code()
{
    alert("oncomplete_api_member_token_revoke_code");


    // Get response as object
    var l_obj = l_api_member_token_revoke_code.m_response.m_api_member_token_revoke_code;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_api_member_token_revoke_code_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/api_member_token_revoke_code/status").text);

    // Get response as a single string
    alert(l_api_member_token_revoke_code_action.m_response_string);
}

// Create the request
l_api_member_token_revoke_code = new MetaWrap.XML.Action.WS.api_member_token_revoke_code
(
								
    'api_key',
    'code'
);

// Create action
l_api_member_token_revoke_code_action = new MetaWrap.XML.Action(l_api_member_token_revoke_code,l_api_server + "/api_member_token_revoke_code");

// Call the action
if (!l_api_member_token_revoke_code_action.run(oncomplete_api_member_token_revoke_code))
{
    alert("There was an error calling 'api_member_token_revoke_code'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for api_member_token_revoke_code
//

// JQuery GET request
    var dataString = 'api_key=api_key&code=code'
    $.get(
      l_api_server+'api_member_token_revoke_code',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_member_token_revoke_code
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<api_member_token_revoke_code version="V0.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<code>code</code>\n';
    dataString += '</api_member_token_revoke_code></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

api_member_token_revoke_code - V1.0 - ThumbWhere

If the supplied #code# exists, it is deleted.

To create a code, make a call to ^api_member_token_create_code^ with the #api_member_token# that you want to create.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_member_token_revoke_code (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.api_member_token_revoke_code = function(
	p_api_key,
	p_code)
{
    this.m_action = {};
    this.m_action.m_api_member_token_revoke_code = 
    { 
        m_api_key:p_api_key,
        m_code:p_code
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.api_member_token_revoke_code.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_api_member_token_revoke_code = 
        {

        };
    return this;
}                   

// Reference to the request
var l_api_member_token_revoke_code = null;

// Reference to the action
var l_api_member_token_revoke_code_action = null;

// This is called on completion of a call to api_member_token_revoke_code
function oncomplete_api_member_token_revoke_code()
{
    alert("oncomplete_api_member_token_revoke_code");


    // Get response as object
    var l_obj = l_api_member_token_revoke_code.m_response.m_api_member_token_revoke_code;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_api_member_token_revoke_code_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/api_member_token_revoke_code/status").text);

    // Get response as a single string
    alert(l_api_member_token_revoke_code_action.m_response_string);
}

// Create the request
l_api_member_token_revoke_code = new MetaWrap.XML.Action.WS.api_member_token_revoke_code
(
								
    'api_key',
    'code'
);

// Create action
l_api_member_token_revoke_code_action = new MetaWrap.XML.Action(l_api_member_token_revoke_code,l_api_server + "/api_member_token_revoke_code");

// Call the action
if (!l_api_member_token_revoke_code_action.run(oncomplete_api_member_token_revoke_code))
{
    alert("There was an error calling 'api_member_token_revoke_code'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for api_member_token_revoke_code
//

// JQuery GET request
    var dataString = 'api_key=api_key&code=code'
    $.get(
      l_api_server+'api_member_token_revoke_code',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_member_token_revoke_code
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<api_member_token_revoke_code version="V1.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<code>code</code>\n';
    dataString += '</api_member_token_revoke_code></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

api_member_token_validate - V0.0 - ThumbWhere

Validates #api_member_token# and returns its current state. An API Member Token or an API Key can be 'revoked' due to abuse.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_member_token_validate (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.api_member_token_validate = function(
	p_api_member_token)
{
    this.m_action = {};
    this.m_action.m_api_member_token_validate = 
    { 
        m_api_member_token:p_api_member_token
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.api_member_token_validate.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_api_member_token_validate = 
        {

        };
    return this;
}                   

// Reference to the request
var l_api_member_token_validate = null;

// Reference to the action
var l_api_member_token_validate_action = null;

// This is called on completion of a call to api_member_token_validate
function oncomplete_api_member_token_validate()
{
    alert("oncomplete_api_member_token_validate");


    // Get response as object
    var l_obj = l_api_member_token_validate.m_response.m_api_member_token_validate;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_api_member_token_validate_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/api_member_token_validate/status").text);

    // Get response as a single string
    alert(l_api_member_token_validate_action.m_response_string);
}

// Create the request
l_api_member_token_validate = new MetaWrap.XML.Action.WS.api_member_token_validate
(
								
    'api_member_token'
);

// Create action
l_api_member_token_validate_action = new MetaWrap.XML.Action(l_api_member_token_validate,l_api_server + "/api_member_token_validate");

// Call the action
if (!l_api_member_token_validate_action.run(oncomplete_api_member_token_validate))
{
    alert("There was an error calling 'api_member_token_validate'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for api_member_token_validate
//

// JQuery GET request
    var dataString = 'api_member_token=api_member_token'
    $.get(
      l_api_server+'api_member_token_validate',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_member_token_validate
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<api_member_token_validate version="V0.0" service="ThumbWhere">\n';
    dataString += '<api_member_token>api_member_token</api_member_token>\n';
    dataString += '</api_member_token_validate></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

api_member_token_validate - V1.0 - ThumbWhere

Validates #api_member_token# and returns its current state. An API Member Token or an API Key can be 'revoked' due to abuse.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_member_token_validate (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.api_member_token_validate = function(
	p_api_member_token)
{
    this.m_action = {};
    this.m_action.m_api_member_token_validate = 
    { 
        m_api_member_token:p_api_member_token
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.api_member_token_validate.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_api_member_token_validate = 
        {

            m_state:""
        };
    return this;
}                   

// Reference to the request
var l_api_member_token_validate = null;

// Reference to the action
var l_api_member_token_validate_action = null;

// This is called on completion of a call to api_member_token_validate
function oncomplete_api_member_token_validate()
{
    alert("oncomplete_api_member_token_validate");


    // Get response as object
    var l_obj = l_api_member_token_validate.m_response.m_api_member_token_validate;
    alert("'status' = " + l_obj.m_status);
    alert("'state' = " + l_obj.m_state);

    // Get response as XML
    var l_xml = l_api_member_token_validate_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/api_member_token_validate/status").text);    
    alert("'state' (from xml) = " +l_xml.selectSingleNode("response/api_member_token_validate/state").text);

    // Get response as a single string
    alert(l_api_member_token_validate_action.m_response_string);
}

// Create the request
l_api_member_token_validate = new MetaWrap.XML.Action.WS.api_member_token_validate
(
								
    'api_member_token'
);

// Create action
l_api_member_token_validate_action = new MetaWrap.XML.Action(l_api_member_token_validate,l_api_server + "/api_member_token_validate");

// Call the action
if (!l_api_member_token_validate_action.run(oncomplete_api_member_token_validate))
{
    alert("There was an error calling 'api_member_token_validate'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for api_member_token_validate
//

// JQuery GET request
    var dataString = 'api_member_token=api_member_token'
    $.get(
      l_api_server+'api_member_token_validate',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for api_member_token_validate
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<api_member_token_validate version="V1.0" service="ThumbWhere">\n';
    dataString += '<api_member_token>api_member_token</api_member_token>\n';
    dataString += '</api_member_token_validate></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

application_add_namevaluepairdefinition - V0.0 - ThumbWhere

Adds a name value pair definition for an application.

This is shared across all campaigns that use this application.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for application_add_namevaluepairdefinition (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.application_add_namevaluepairdefinition = function(
	p_api_key,
	p_name,
	p_type,
	p_encrypted)
{
    this.m_action = {};
    this.m_action.m_application_add_namevaluepairdefinition = 
    { 
        m_api_key:p_api_key,
        m_name:p_name,
        m_type:p_type,
        m_encrypted:p_encrypted
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.application_add_namevaluepairdefinition.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_application_add_namevaluepairdefinition = 
        {

        };
    return this;
}                   

// Reference to the request
var l_application_add_namevaluepairdefinition = null;

// Reference to the action
var l_application_add_namevaluepairdefinition_action = null;

// This is called on completion of a call to application_add_namevaluepairdefinition
function oncomplete_application_add_namevaluepairdefinition()
{
    alert("oncomplete_application_add_namevaluepairdefinition");


    // Get response as object
    var l_obj = l_application_add_namevaluepairdefinition.m_response.m_application_add_namevaluepairdefinition;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_application_add_namevaluepairdefinition_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/application_add_namevaluepairdefinition/status").text);

    // Get response as a single string
    alert(l_application_add_namevaluepairdefinition_action.m_response_string);
}

// Create the request
l_application_add_namevaluepairdefinition = new MetaWrap.XML.Action.WS.application_add_namevaluepairdefinition
(
								
    'api_key',
    'name',
    'type',
    'encrypted'
);

// Create action
l_application_add_namevaluepairdefinition_action = new MetaWrap.XML.Action(l_application_add_namevaluepairdefinition,l_api_server + "/application_add_namevaluepairdefinition");

// Call the action
if (!l_application_add_namevaluepairdefinition_action.run(oncomplete_application_add_namevaluepairdefinition))
{
    alert("There was an error calling 'application_add_namevaluepairdefinition'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for application_add_namevaluepairdefinition
//

// JQuery GET request
    var dataString = 'api_key=api_key&name=name&type=type&encrypted=encrypted'
    $.get(
      l_api_server+'application_add_namevaluepairdefinition',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for application_add_namevaluepairdefinition
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<application_add_namevaluepairdefinition version="V0.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<name>name</name>\n';
    dataString += '<type>type</type>\n';
    dataString += '<encrypted>encrypted</encrypted>\n';
    dataString += '</application_add_namevaluepairdefinition></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

application_add_namevaluepairdefinition - V1.0 - ThumbWhere

Adds a name value pair definition for an application.

This is shared across all campaigns that use this application.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for application_add_namevaluepairdefinition (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.application_add_namevaluepairdefinition = function(
	p_api_key,
	p_name,
	p_type,
	p_encrypted)
{
    this.m_action = {};
    this.m_action.m_application_add_namevaluepairdefinition = 
    { 
        m_api_key:p_api_key,
        m_name:p_name,
        m_type:p_type,
        m_encrypted:p_encrypted
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.application_add_namevaluepairdefinition.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_application_add_namevaluepairdefinition = 
        {

        };
    return this;
}                   

// Reference to the request
var l_application_add_namevaluepairdefinition = null;

// Reference to the action
var l_application_add_namevaluepairdefinition_action = null;

// This is called on completion of a call to application_add_namevaluepairdefinition
function oncomplete_application_add_namevaluepairdefinition()
{
    alert("oncomplete_application_add_namevaluepairdefinition");


    // Get response as object
    var l_obj = l_application_add_namevaluepairdefinition.m_response.m_application_add_namevaluepairdefinition;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_application_add_namevaluepairdefinition_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/application_add_namevaluepairdefinition/status").text);

    // Get response as a single string
    alert(l_application_add_namevaluepairdefinition_action.m_response_string);
}

// Create the request
l_application_add_namevaluepairdefinition = new MetaWrap.XML.Action.WS.application_add_namevaluepairdefinition
(
								
    'api_key',
    'name',
    'type',
    'encrypted'
);

// Create action
l_application_add_namevaluepairdefinition_action = new MetaWrap.XML.Action(l_application_add_namevaluepairdefinition,l_api_server + "/application_add_namevaluepairdefinition");

// Call the action
if (!l_application_add_namevaluepairdefinition_action.run(oncomplete_application_add_namevaluepairdefinition))
{
    alert("There was an error calling 'application_add_namevaluepairdefinition'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for application_add_namevaluepairdefinition
//

// JQuery GET request
    var dataString = 'api_key=api_key&name=name&type=type&encrypted=encrypted'
    $.get(
      l_api_server+'application_add_namevaluepairdefinition',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for application_add_namevaluepairdefinition
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<application_add_namevaluepairdefinition version="V1.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<name>name</name>\n';
    dataString += '<type>type</type>\n';
    dataString += '<encrypted>encrypted</encrypted>\n';
    dataString += '</application_add_namevaluepairdefinition></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

application_delete_namevaluepairdefinition - V0.0 - ThumbWhere

Deletes a name value pair definition for an application.

This will delete the name value pair definition and values for all applications across all campaigns that use this applicaton.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for application_delete_namevaluepairdefinition (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.application_delete_namevaluepairdefinition = function(
	p_api_key,
	p_name)
{
    this.m_action = {};
    this.m_action.m_application_delete_namevaluepairdefinition = 
    { 
        m_api_key:p_api_key,
        m_name:p_name
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.application_delete_namevaluepairdefinition.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_application_delete_namevaluepairdefinition = 
        {

        };
    return this;
}                   

// Reference to the request
var l_application_delete_namevaluepairdefinition = null;

// Reference to the action
var l_application_delete_namevaluepairdefinition_action = null;

// This is called on completion of a call to application_delete_namevaluepairdefinition
function oncomplete_application_delete_namevaluepairdefinition()
{
    alert("oncomplete_application_delete_namevaluepairdefinition");


    // Get response as object
    var l_obj = l_application_delete_namevaluepairdefinition.m_response.m_application_delete_namevaluepairdefinition;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_application_delete_namevaluepairdefinition_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/application_delete_namevaluepairdefinition/status").text);

    // Get response as a single string
    alert(l_application_delete_namevaluepairdefinition_action.m_response_string);
}

// Create the request
l_application_delete_namevaluepairdefinition = new MetaWrap.XML.Action.WS.application_delete_namevaluepairdefinition
(
								
    'api_key',
    'name'
);

// Create action
l_application_delete_namevaluepairdefinition_action = new MetaWrap.XML.Action(l_application_delete_namevaluepairdefinition,l_api_server + "/application_delete_namevaluepairdefinition");

// Call the action
if (!l_application_delete_namevaluepairdefinition_action.run(oncomplete_application_delete_namevaluepairdefinition))
{
    alert("There was an error calling 'application_delete_namevaluepairdefinition'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for application_delete_namevaluepairdefinition
//

// JQuery GET request
    var dataString = 'api_key=api_key&name=name'
    $.get(
      l_api_server+'application_delete_namevaluepairdefinition',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for application_delete_namevaluepairdefinition
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<application_delete_namevaluepairdefinition version="V0.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<name>name</name>\n';
    dataString += '</application_delete_namevaluepairdefinition></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

application_delete_namevaluepairdefinition - V1.0 - ThumbWhere

Deletes a name value pair definition for an application.

This will delete the name value pair definition and values for all applications across all campaigns that use this applicaton.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for application_delete_namevaluepairdefinition (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.application_delete_namevaluepairdefinition = function(
	p_api_key,
	p_name)
{
    this.m_action = {};
    this.m_action.m_application_delete_namevaluepairdefinition = 
    { 
        m_api_key:p_api_key,
        m_name:p_name
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.application_delete_namevaluepairdefinition.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_application_delete_namevaluepairdefinition = 
        {

        };
    return this;
}                   

// Reference to the request
var l_application_delete_namevaluepairdefinition = null;

// Reference to the action
var l_application_delete_namevaluepairdefinition_action = null;

// This is called on completion of a call to application_delete_namevaluepairdefinition
function oncomplete_application_delete_namevaluepairdefinition()
{
    alert("oncomplete_application_delete_namevaluepairdefinition");


    // Get response as object
    var l_obj = l_application_delete_namevaluepairdefinition.m_response.m_application_delete_namevaluepairdefinition;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_application_delete_namevaluepairdefinition_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/application_delete_namevaluepairdefinition/status").text);

    // Get response as a single string
    alert(l_application_delete_namevaluepairdefinition_action.m_response_string);
}

// Create the request
l_application_delete_namevaluepairdefinition = new MetaWrap.XML.Action.WS.application_delete_namevaluepairdefinition
(
								
    'api_key',
    'name'
);

// Create action
l_application_delete_namevaluepairdefinition_action = new MetaWrap.XML.Action(l_application_delete_namevaluepairdefinition,l_api_server + "/application_delete_namevaluepairdefinition");

// Call the action
if (!l_application_delete_namevaluepairdefinition_action.run(oncomplete_application_delete_namevaluepairdefinition))
{
    alert("There was an error calling 'application_delete_namevaluepairdefinition'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for application_delete_namevaluepairdefinition
//

// JQuery GET request
    var dataString = 'api_key=api_key&name=name'
    $.get(
      l_api_server+'application_delete_namevaluepairdefinition',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for application_delete_namevaluepairdefinition
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<application_delete_namevaluepairdefinition version="V1.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<name>name</name>\n';
    dataString += '</application_delete_namevaluepairdefinition></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

application_get_summary - V0.0 - ThumbWhere

Get a summary of the application. Its url and its name value pair definitions.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for application_get_summary (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.application_get_summary = function(
	p_api_key)
{
    this.m_action = {};
    this.m_action.m_application_get_summary = 
    { 
        m_api_key:p_api_key
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.application_get_summary.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_application_get_summary = 
        {

        };
    return this;
}                   

// Reference to the request
var l_application_get_summary = null;

// Reference to the action
var l_application_get_summary_action = null;

// This is called on completion of a call to application_get_summary
function oncomplete_application_get_summary()
{
    alert("oncomplete_application_get_summary");


    // Get response as object
    var l_obj = l_application_get_summary.m_response.m_application_get_summary;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_application_get_summary_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/application_get_summary/status").text);

    // Get response as a single string
    alert(l_application_get_summary_action.m_response_string);
}

// Create the request
l_application_get_summary = new MetaWrap.XML.Action.WS.application_get_summary
(
								
    'api_key'
);

// Create action
l_application_get_summary_action = new MetaWrap.XML.Action(l_application_get_summary,l_api_server + "/application_get_summary");

// Call the action
if (!l_application_get_summary_action.run(oncomplete_application_get_summary))
{
    alert("There was an error calling 'application_get_summary'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for application_get_summary
//

// JQuery GET request
    var dataString = 'api_key=api_key'
    $.get(
      l_api_server+'application_get_summary',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for application_get_summary
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<application_get_summary version="V0.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '</application_get_summary></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

application_get_summary - V1.0 - ThumbWhere

Get a summary of the application. Its url and its name value pair definitions.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for application_get_summary (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.application_get_summary = function(
	p_api_key)
{
    this.m_action = {};
    this.m_action.m_application_get_summary = 
    { 
        m_api_key:p_api_key
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.application_get_summary.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_application_get_summary = 
        {

        };
    return this;
}                   

// Reference to the request
var l_application_get_summary = null;

// Reference to the action
var l_application_get_summary_action = null;

// This is called on completion of a call to application_get_summary
function oncomplete_application_get_summary()
{
    alert("oncomplete_application_get_summary");


    // Get response as object
    var l_obj = l_application_get_summary.m_response.m_application_get_summary;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_application_get_summary_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/application_get_summary/status").text);

    // Get response as a single string
    alert(l_application_get_summary_action.m_response_string);
}

// Create the request
l_application_get_summary = new MetaWrap.XML.Action.WS.application_get_summary
(
								
    'api_key'
);

// Create action
l_application_get_summary_action = new MetaWrap.XML.Action(l_application_get_summary,l_api_server + "/application_get_summary");

// Call the action
if (!l_application_get_summary_action.run(oncomplete_application_get_summary))
{
    alert("There was an error calling 'application_get_summary'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for application_get_summary
//

// JQuery GET request
    var dataString = 'api_key=api_key'
    $.get(
      l_api_server+'application_get_summary',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for application_get_summary
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<application_get_summary version="V1.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '</application_get_summary></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

authenticate - V1.1 - Identity

Authenticates an identity.

This enables an application to vouch for the validity of an Identity.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for authenticate (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.authenticate = function(
	p_key,
	p_type,
	p_id,
	p_secret)
{
    this.m_action = {};
    this.m_action.m_authenticate = 
    { 
        m_key:p_key,
        m_type:p_type,
        m_id:p_id,
        m_secret:p_secret
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.authenticate.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_authenticate = 
        {

        };
    return this;
}                   

// Reference to the request
var l_authenticate = null;

// Reference to the action
var l_authenticate_action = null;

// This is called on completion of a call to authenticate
function oncomplete_authenticate()
{
    alert("oncomplete_authenticate");


    // Get response as object
    var l_obj = l_authenticate.m_response.m_authenticate;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_authenticate_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/authenticate/status").text);

    // Get response as a single string
    alert(l_authenticate_action.m_response_string);
}

// Create the request
l_authenticate = new MetaWrap.XML.Action.WS.authenticate
(
								
    'key',
    'type',
    'id',
    'secret'
);

// Create action
l_authenticate_action = new MetaWrap.XML.Action(l_authenticate,l_api_server + "/authenticate");

// Call the action
if (!l_authenticate_action.run(oncomplete_authenticate))
{
    alert("There was an error calling 'authenticate'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for authenticate
//

// JQuery GET request
    var dataString = 'key=key&type=type&id=id&secret=secret'
    $.get(
      l_api_server+'authenticate',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for authenticate
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<authenticate version="V1.1" service="Identity">\n';
    dataString += '<key>key</key>\n';
    dataString += '<type>type</type>\n';
    dataString += '<id>id</id>\n';
    dataString += '<secret>secret</secret>\n';
    dataString += '</authenticate></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

authenticate_request - V1.1 - Identity

Authenticates an Identity Token Request made by a previous call to ^request^.

This enables an application to vouch for the validity of an Identity.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for authenticate_request (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.authenticate_request = function(
	p_key,
	p_code,
	p_id,
	p_secret,
	p_label)
{
    this.m_action = {};
    this.m_action.m_authenticate_request = 
    { 
        m_key:p_key,
        m_code:p_code,
        m_id:p_id,
        m_secret:p_secret,
        m_label:p_label
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.authenticate_request.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_authenticate_request = 
        {

        };
    return this;
}                   

// Reference to the request
var l_authenticate_request = null;

// Reference to the action
var l_authenticate_request_action = null;

// This is called on completion of a call to authenticate_request
function oncomplete_authenticate_request()
{
    alert("oncomplete_authenticate_request");


    // Get response as object
    var l_obj = l_authenticate_request.m_response.m_authenticate_request;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_authenticate_request_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/authenticate_request/status").text);

    // Get response as a single string
    alert(l_authenticate_request_action.m_response_string);
}

// Create the request
l_authenticate_request = new MetaWrap.XML.Action.WS.authenticate_request
(
								
    'key',
    'code',
    'id',
    'secret',
    'label'
);

// Create action
l_authenticate_request_action = new MetaWrap.XML.Action(l_authenticate_request,l_api_server + "/authenticate_request");

// Call the action
if (!l_authenticate_request_action.run(oncomplete_authenticate_request))
{
    alert("There was an error calling 'authenticate_request'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for authenticate_request
//

// JQuery GET request
    var dataString = 'key=key&code=code&id=id&secret=secret&label=label'
    $.get(
      l_api_server+'authenticate_request',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for authenticate_request
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<authenticate_request version="V1.1" service="Identity">\n';
    dataString += '<key>key</key>\n';
    dataString += '<code>code</code>\n';
    dataString += '<id>id</id>\n';
    dataString += '<secret>secret</secret>\n';
    dataString += '<label>label</label>\n';
    dataString += '</authenticate_request></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

available - V1.1 - Identity

Returns true if an identity is available.

Returns true if the identity is available..

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for available (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.available = function(
	p_key,
	p_type,
	p_id)
{
    this.m_action = {};
    this.m_action.m_available = 
    { 
        m_key:p_key,
        m_type:p_type,
        m_id:p_id
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.available.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_available = 
        {

        };
    return this;
}                   

// Reference to the request
var l_available = null;

// Reference to the action
var l_available_action = null;

// This is called on completion of a call to available
function oncomplete_available()
{
    alert("oncomplete_available");


    // Get response as object
    var l_obj = l_available.m_response.m_available;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_available_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/available/status").text);

    // Get response as a single string
    alert(l_available_action.m_response_string);
}

// Create the request
l_available = new MetaWrap.XML.Action.WS.available
(
								
    'key',
    'type',
    'id'
);

// Create action
l_available_action = new MetaWrap.XML.Action(l_available,l_api_server + "/available");

// Call the action
if (!l_available_action.run(oncomplete_available))
{
    alert("There was an error calling 'available'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for available
//

// JQuery GET request
    var dataString = 'key=key&type=type&id=id'
    $.get(
      l_api_server+'available',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for available
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<available version="V1.1" service="Identity">\n';
    dataString += '<key>key</key>\n';
    dataString += '<type>type</type>\n';
    dataString += '<id>id</id>\n';
    dataString += '</available></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

bookmark_mediaitem - V1.1 - Content

Bookmark a mediaitem

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for bookmark_mediaitem (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.bookmark_mediaitem = function(
	p_key,
	p_member,
	p_mediaitem)
{
    this.m_action = {};
    this.m_action.m_bookmark_mediaitem = 
    { 
        m_key:p_key,
        m_member:p_member,
        m_mediaitem:p_mediaitem
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.bookmark_mediaitem.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_bookmark_mediaitem = 
        {

        };
    return this;
}                   

// Reference to the request
var l_bookmark_mediaitem = null;

// Reference to the action
var l_bookmark_mediaitem_action = null;

// This is called on completion of a call to bookmark_mediaitem
function oncomplete_bookmark_mediaitem()
{
    alert("oncomplete_bookmark_mediaitem");


    // Get response as object
    var l_obj = l_bookmark_mediaitem.m_response.m_bookmark_mediaitem;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_bookmark_mediaitem_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/bookmark_mediaitem/status").text);

    // Get response as a single string
    alert(l_bookmark_mediaitem_action.m_response_string);
}

// Create the request
l_bookmark_mediaitem = new MetaWrap.XML.Action.WS.bookmark_mediaitem
(
								
    'key',
    'member',
    'mediaitem'
);

// Create action
l_bookmark_mediaitem_action = new MetaWrap.XML.Action(l_bookmark_mediaitem,l_api_server + "/bookmark_mediaitem");

// Call the action
if (!l_bookmark_mediaitem_action.run(oncomplete_bookmark_mediaitem))
{
    alert("There was an error calling 'bookmark_mediaitem'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for bookmark_mediaitem
//

// JQuery GET request
    var dataString = 'key=key&member=member&mediaitem=mediaitem'
    $.get(
      l_api_server+'bookmark_mediaitem',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for bookmark_mediaitem
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<bookmark_mediaitem version="V1.1" service="Content">\n';
    dataString += '<key>key</key>\n';
    dataString += '<member>member</member>\n';
    dataString += '<mediaitem>mediaitem</mediaitem>\n';
    dataString += '</bookmark_mediaitem></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

campaign_bandwidthusage_create - V1.0 - ThumbWhere

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for campaign_bandwidthusage_create (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.campaign_bandwidthusage_create = function(
	p_api_key,
	p_api_member_token,
	p_actor,
	p_action,
	p_target,
	p_magnitide)
{
    this.m_action = {};
    this.m_action.m_campaign_bandwidthusage_create = 
    { 
        m_api_key:p_api_key,
        m_api_member_token:p_api_member_token,
        m_actor:p_actor,
        m_action:p_action,
        m_target:p_target,
        m_magnitide:p_magnitide
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.campaign_bandwidthusage_create.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_campaign_bandwidthusage_create = 
        {

        };
    return this;
}                   

// Reference to the request
var l_campaign_bandwidthusage_create = null;

// Reference to the action
var l_campaign_bandwidthusage_create_action = null;

// This is called on completion of a call to campaign_bandwidthusage_create
function oncomplete_campaign_bandwidthusage_create()
{
    alert("oncomplete_campaign_bandwidthusage_create");


    // Get response as object
    var l_obj = l_campaign_bandwidthusage_create.m_response.m_campaign_bandwidthusage_create;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_campaign_bandwidthusage_create_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/campaign_bandwidthusage_create/status").text);

    // Get response as a single string
    alert(l_campaign_bandwidthusage_create_action.m_response_string);
}

// Create the request
l_campaign_bandwidthusage_create = new MetaWrap.XML.Action.WS.campaign_bandwidthusage_create
(
								
    'api_key',
    'api_member_token',
    'actor',
    'action',
    'target',
    'magnitide'
);

// Create action
l_campaign_bandwidthusage_create_action = new MetaWrap.XML.Action(l_campaign_bandwidthusage_create,l_api_server + "/campaign_bandwidthusage_create");

// Call the action
if (!l_campaign_bandwidthusage_create_action.run(oncomplete_campaign_bandwidthusage_create))
{
    alert("There was an error calling 'campaign_bandwidthusage_create'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for campaign_bandwidthusage_create
//

// JQuery GET request
    var dataString = 'api_key=api_key&api_member_token=api_member_token&actor=actor&action=action&target=target&magnitide=magnitide'
    $.get(
      l_api_server+'campaign_bandwidthusage_create',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for campaign_bandwidthusage_create
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<campaign_bandwidthusage_create version="V1.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<api_member_token>api_member_token</api_member_token>\n';
    dataString += '<actor>actor</actor>\n';
    dataString += '<action>action</action>\n';
    dataString += '<target>target</target>\n';
    dataString += '<magnitide>magnitide</magnitide>\n';
    dataString += '</campaign_bandwidthusage_create></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

campaign_create_clone - V0.0 - ThumbWhere

Create a campaign based on an existing campaign.

The will clone the campaign details, the deployment servers and the media definitions for a specified campaign.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for campaign_create_clone (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.campaign_create_clone = function(
	p_master_key,
	p_campaign_id)
{
    this.m_action = {};
    this.m_action.m_campaign_create_clone = 
    { 
        m_master_key:p_master_key,
        m_campaign_id:p_campaign_id
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.campaign_create_clone.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_campaign_create_clone = 
        {

            m_campaign_id:"",
            m_api_key:""
        };
    return this;
}                   

// Reference to the request
var l_campaign_create_clone = null;

// Reference to the action
var l_campaign_create_clone_action = null;

// This is called on completion of a call to campaign_create_clone
function oncomplete_campaign_create_clone()
{
    alert("oncomplete_campaign_create_clone");


    // Get response as object
    var l_obj = l_campaign_create_clone.m_response.m_campaign_create_clone;
    alert("'status' = " + l_obj.m_status);
    alert("'campaign_id' = " + l_obj.m_campaign_id);
    alert("'api_key' = " + l_obj.m_api_key);

    // Get response as XML
    var l_xml = l_campaign_create_clone_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/campaign_create_clone/status").text);    
    alert("'campaign_id' (from xml) = " +l_xml.selectSingleNode("response/campaign_create_clone/campaign_id").text);    
    alert("'api_key' (from xml) = " +l_xml.selectSingleNode("response/campaign_create_clone/api_key").text);

    // Get response as a single string
    alert(l_campaign_create_clone_action.m_response_string);
}

// Create the request
l_campaign_create_clone = new MetaWrap.XML.Action.WS.campaign_create_clone
(
								
    'master_key',
    'campaign_id'
);

// Create action
l_campaign_create_clone_action = new MetaWrap.XML.Action(l_campaign_create_clone,l_api_server + "/campaign_create_clone");

// Call the action
if (!l_campaign_create_clone_action.run(oncomplete_campaign_create_clone))
{
    alert("There was an error calling 'campaign_create_clone'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for campaign_create_clone
//

// JQuery GET request
    var dataString = 'master_key=master_key&campaign_id=campaign_id'
    $.get(
      l_api_server+'campaign_create_clone',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for campaign_create_clone
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<campaign_create_clone version="V0.0" service="ThumbWhere">\n';
    dataString += '<master_key>master_key</master_key>\n';
    dataString += '<campaign_id>campaign_id</campaign_id>\n';
    dataString += '</campaign_create_clone></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

campaign_create_clone - V1.0 - ThumbWhere

Create a campaign based on an existing campaign.

The will clone the campaign details, the deployment servers and the media definitions for a specified campaign.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for campaign_create_clone (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.campaign_create_clone = function(
	p_master_key,
	p_campaign_id)
{
    this.m_action = {};
    this.m_action.m_campaign_create_clone = 
    { 
        m_master_key:p_master_key,
        m_campaign_id:p_campaign_id
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.campaign_create_clone.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_campaign_create_clone = 
        {

            m_campaign_id:"",
            m_api_key:""
        };
    return this;
}                   

// Reference to the request
var l_campaign_create_clone = null;

// Reference to the action
var l_campaign_create_clone_action = null;

// This is called on completion of a call to campaign_create_clone
function oncomplete_campaign_create_clone()
{
    alert("oncomplete_campaign_create_clone");


    // Get response as object
    var l_obj = l_campaign_create_clone.m_response.m_campaign_create_clone;
    alert("'status' = " + l_obj.m_status);
    alert("'campaign_id' = " + l_obj.m_campaign_id);
    alert("'api_key' = " + l_obj.m_api_key);

    // Get response as XML
    var l_xml = l_campaign_create_clone_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/campaign_create_clone/status").text);    
    alert("'campaign_id' (from xml) = " +l_xml.selectSingleNode("response/campaign_create_clone/campaign_id").text);    
    alert("'api_key' (from xml) = " +l_xml.selectSingleNode("response/campaign_create_clone/api_key").text);

    // Get response as a single string
    alert(l_campaign_create_clone_action.m_response_string);
}

// Create the request
l_campaign_create_clone = new MetaWrap.XML.Action.WS.campaign_create_clone
(
								
    'master_key',
    'campaign_id'
);

// Create action
l_campaign_create_clone_action = new MetaWrap.XML.Action(l_campaign_create_clone,l_api_server + "/campaign_create_clone");

// Call the action
if (!l_campaign_create_clone_action.run(oncomplete_campaign_create_clone))
{
    alert("There was an error calling 'campaign_create_clone'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for campaign_create_clone
//

// JQuery GET request
    var dataString = 'master_key=master_key&campaign_id=campaign_id'
    $.get(
      l_api_server+'campaign_create_clone',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for campaign_create_clone
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<campaign_create_clone version="V1.0" service="ThumbWhere">\n';
    dataString += '<master_key>master_key</master_key>\n';
    dataString += '<campaign_id>campaign_id</campaign_id>\n';
    dataString += '</campaign_create_clone></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

campaign_encrypt - V1.1 - Admin

Encrypts the provided plaintext with the Campaign's encryption key.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for campaign_encrypt (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.campaign_encrypt = function(
	p_key,
	p_plaintext)
{
    this.m_action = {};
    this.m_action.m_campaign_encrypt = 
    { 
        m_key:p_key,
        m_plaintext:p_plaintext
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.campaign_encrypt.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_campaign_encrypt = 
        {

        };
    return this;
}                   

// Reference to the request
var l_campaign_encrypt = null;

// Reference to the action
var l_campaign_encrypt_action = null;

// This is called on completion of a call to campaign_encrypt
function oncomplete_campaign_encrypt()
{
    alert("oncomplete_campaign_encrypt");


    // Get response as object
    var l_obj = l_campaign_encrypt.m_response.m_campaign_encrypt;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_campaign_encrypt_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/campaign_encrypt/status").text);

    // Get response as a single string
    alert(l_campaign_encrypt_action.m_response_string);
}

// Create the request
l_campaign_encrypt = new MetaWrap.XML.Action.WS.campaign_encrypt
(
								
    'key',
    'plaintext'
);

// Create action
l_campaign_encrypt_action = new MetaWrap.XML.Action(l_campaign_encrypt,l_api_server + "/campaign_encrypt");

// Call the action
if (!l_campaign_encrypt_action.run(oncomplete_campaign_encrypt))
{
    alert("There was an error calling 'campaign_encrypt'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for campaign_encrypt
//

// JQuery GET request
    var dataString = 'key=key&plaintext=plaintext'
    $.get(
      l_api_server+'campaign_encrypt',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for campaign_encrypt
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<campaign_encrypt version="V1.1" service="Admin">\n';
    dataString += '<key>key</key>\n';
    dataString += '<plaintext>plaintext</plaintext>\n';
    dataString += '</campaign_encrypt></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

campaign_get_summary - V0.0 - ThumbWhere

Returns the values from the name values pair for the members external application.

The member must be a member of the external application. The returned values are encrypted with the applications encryption key if they are specified as encrypted over the wire in the name value pair definitions for this application.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for campaign_get_summary (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.campaign_get_summary = function(
	p_api_key)
{
    this.m_action = {};
    this.m_action.m_campaign_get_summary = 
    { 
        m_api_key:p_api_key
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.campaign_get_summary.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_campaign_get_summary = 
        {

        };
    return this;
}                   

// Reference to the request
var l_campaign_get_summary = null;

// Reference to the action
var l_campaign_get_summary_action = null;

// This is called on completion of a call to campaign_get_summary
function oncomplete_campaign_get_summary()
{
    alert("oncomplete_campaign_get_summary");


    // Get response as object
    var l_obj = l_campaign_get_summary.m_response.m_campaign_get_summary;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_campaign_get_summary_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/campaign_get_summary/status").text);

    // Get response as a single string
    alert(l_campaign_get_summary_action.m_response_string);
}

// Create the request
l_campaign_get_summary = new MetaWrap.XML.Action.WS.campaign_get_summary
(
								
    'api_key'
);

// Create action
l_campaign_get_summary_action = new MetaWrap.XML.Action(l_campaign_get_summary,l_api_server + "/campaign_get_summary");

// Call the action
if (!l_campaign_get_summary_action.run(oncomplete_campaign_get_summary))
{
    alert("There was an error calling 'campaign_get_summary'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for campaign_get_summary
//

// JQuery GET request
    var dataString = 'api_key=api_key'
    $.get(
      l_api_server+'campaign_get_summary',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for campaign_get_summary
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<campaign_get_summary version="V0.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '</campaign_get_summary></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

campaign_get_summary - V1.0 - ThumbWhere

Returns the values from the name values pair for the members external application.

The member must be a member of the external application. The returned values are encrypted with the applications encryption key if they are specified as encrypted over the wire in the name value pair definitions for this application.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for campaign_get_summary (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.campaign_get_summary = function(
	p_api_key)
{
    this.m_action = {};
    this.m_action.m_campaign_get_summary = 
    { 
        m_api_key:p_api_key
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.campaign_get_summary.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_campaign_get_summary = 
        {

            m_name:"",
            m_description:"",
            m_apps:""
        };
    return this;
}                   

// Reference to the request
var l_campaign_get_summary = null;

// Reference to the action
var l_campaign_get_summary_action = null;

// This is called on completion of a call to campaign_get_summary
function oncomplete_campaign_get_summary()
{
    alert("oncomplete_campaign_get_summary");


    // Get response as object
    var l_obj = l_campaign_get_summary.m_response.m_campaign_get_summary;
    alert("'status' = " + l_obj.m_status);
    alert("'name' = " + l_obj.m_name);
    alert("'description' = " + l_obj.m_description);
    alert("'apps' = " + l_obj.m_apps);

    // Get response as XML
    var l_xml = l_campaign_get_summary_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/campaign_get_summary/status").text);    
    alert("'name' (from xml) = " +l_xml.selectSingleNode("response/campaign_get_summary/name").text);    
    alert("'description' (from xml) = " +l_xml.selectSingleNode("response/campaign_get_summary/description").text);    
    alert("'apps' (from xml) = " +l_xml.selectSingleNode("response/campaign_get_summary/apps").text);

    // Get response as a single string
    alert(l_campaign_get_summary_action.m_response_string);
}

// Create the request
l_campaign_get_summary = new MetaWrap.XML.Action.WS.campaign_get_summary
(
								
    'api_key'
);

// Create action
l_campaign_get_summary_action = new MetaWrap.XML.Action(l_campaign_get_summary,l_api_server + "/campaign_get_summary");

// Call the action
if (!l_campaign_get_summary_action.run(oncomplete_campaign_get_summary))
{
    alert("There was an error calling 'campaign_get_summary'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for campaign_get_summary
//

// JQuery GET request
    var dataString = 'api_key=api_key'
    $.get(
      l_api_server+'campaign_get_summary',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for campaign_get_summary
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<campaign_get_summary version="V1.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '</campaign_get_summary></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

campaign_set_key - V1.1 - Admin

Set's the for a campaign to a defined value.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for campaign_set_key (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.campaign_set_key = function(
	p_masterkey,
	p_id,
	p_key)
{
    this.m_action = {};
    this.m_action.m_campaign_set_key = 
    { 
        m_masterkey:p_masterkey,
        m_id:p_id,
        m_key:p_key
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.campaign_set_key.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_campaign_set_key = 
        {

        };
    return this;
}                   

// Reference to the request
var l_campaign_set_key = null;

// Reference to the action
var l_campaign_set_key_action = null;

// This is called on completion of a call to campaign_set_key
function oncomplete_campaign_set_key()
{
    alert("oncomplete_campaign_set_key");


    // Get response as object
    var l_obj = l_campaign_set_key.m_response.m_campaign_set_key;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_campaign_set_key_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/campaign_set_key/status").text);

    // Get response as a single string
    alert(l_campaign_set_key_action.m_response_string);
}

// Create the request
l_campaign_set_key = new MetaWrap.XML.Action.WS.campaign_set_key
(
								
    'masterkey',
    'id',
    'key'
);

// Create action
l_campaign_set_key_action = new MetaWrap.XML.Action(l_campaign_set_key,l_api_server + "/campaign_set_key");

// Call the action
if (!l_campaign_set_key_action.run(oncomplete_campaign_set_key))
{
    alert("There was an error calling 'campaign_set_key'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for campaign_set_key
//

// JQuery GET request
    var dataString = 'masterkey=masterkey&id=id&key=key'
    $.get(
      l_api_server+'campaign_set_key',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for campaign_set_key
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<campaign_set_key version="V1.1" service="Admin">\n';
    dataString += '<masterkey>masterkey</masterkey>\n';
    dataString += '<id>id</id>\n';
    dataString += '<key>key</key>\n';
    dataString += '</campaign_set_key></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_add_namevaluepairdefinition - V0.0 - ThumbWhere

Adds a name value pair definition to a competition.

This is shared across all competitions for this campaign.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_add_namevaluepairdefinition (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_add_namevaluepairdefinition = function(
	p_api_key,
	p_competition_id,
	p_name,
	p_type,
	p_encrypted)
{
    this.m_action = {};
    this.m_action.m_competition_add_namevaluepairdefinition = 
    { 
        m_api_key:p_api_key,
        m_competition_id:p_competition_id,
        m_name:p_name,
        m_type:p_type,
        m_encrypted:p_encrypted
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_add_namevaluepairdefinition.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_add_namevaluepairdefinition = 
        {

        };
    return this;
}                   

// Reference to the request
var l_competition_add_namevaluepairdefinition = null;

// Reference to the action
var l_competition_add_namevaluepairdefinition_action = null;

// This is called on completion of a call to competition_add_namevaluepairdefinition
function oncomplete_competition_add_namevaluepairdefinition()
{
    alert("oncomplete_competition_add_namevaluepairdefinition");


    // Get response as object
    var l_obj = l_competition_add_namevaluepairdefinition.m_response.m_competition_add_namevaluepairdefinition;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_competition_add_namevaluepairdefinition_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_add_namevaluepairdefinition/status").text);

    // Get response as a single string
    alert(l_competition_add_namevaluepairdefinition_action.m_response_string);
}

// Create the request
l_competition_add_namevaluepairdefinition = new MetaWrap.XML.Action.WS.competition_add_namevaluepairdefinition
(
								
    'api_key',
    'competition_id',
    'name',
    'type',
    'encrypted'
);

// Create action
l_competition_add_namevaluepairdefinition_action = new MetaWrap.XML.Action(l_competition_add_namevaluepairdefinition,l_api_server + "/competition_add_namevaluepairdefinition");

// Call the action
if (!l_competition_add_namevaluepairdefinition_action.run(oncomplete_competition_add_namevaluepairdefinition))
{
    alert("There was an error calling 'competition_add_namevaluepairdefinition'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_add_namevaluepairdefinition
//

// JQuery GET request
    var dataString = 'api_key=api_key&competition_id=competition_id&name=name&type=type&encrypted=encrypted'
    $.get(
      l_api_server+'competition_add_namevaluepairdefinition',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_add_namevaluepairdefinition
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_add_namevaluepairdefinition version="V0.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<competition_id>competition_id</competition_id>\n';
    dataString += '<name>name</name>\n';
    dataString += '<type>type</type>\n';
    dataString += '<encrypted>encrypted</encrypted>\n';
    dataString += '</competition_add_namevaluepairdefinition></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_add_namevaluepairdefinition - V1.0 - ThumbWhere

Adds a name value pair definition to a competition.

This is shared across all competitions for this campaign.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_add_namevaluepairdefinition (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_add_namevaluepairdefinition = function(
	p_api_key,
	p_competition_id,
	p_name,
	p_type,
	p_encrypted)
{
    this.m_action = {};
    this.m_action.m_competition_add_namevaluepairdefinition = 
    { 
        m_api_key:p_api_key,
        m_competition_id:p_competition_id,
        m_name:p_name,
        m_type:p_type,
        m_encrypted:p_encrypted
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_add_namevaluepairdefinition.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_add_namevaluepairdefinition = 
        {

        };
    return this;
}                   

// Reference to the request
var l_competition_add_namevaluepairdefinition = null;

// Reference to the action
var l_competition_add_namevaluepairdefinition_action = null;

// This is called on completion of a call to competition_add_namevaluepairdefinition
function oncomplete_competition_add_namevaluepairdefinition()
{
    alert("oncomplete_competition_add_namevaluepairdefinition");


    // Get response as object
    var l_obj = l_competition_add_namevaluepairdefinition.m_response.m_competition_add_namevaluepairdefinition;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_competition_add_namevaluepairdefinition_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_add_namevaluepairdefinition/status").text);

    // Get response as a single string
    alert(l_competition_add_namevaluepairdefinition_action.m_response_string);
}

// Create the request
l_competition_add_namevaluepairdefinition = new MetaWrap.XML.Action.WS.competition_add_namevaluepairdefinition
(
								
    'api_key',
    'competition_id',
    'name',
    'type',
    'encrypted'
);

// Create action
l_competition_add_namevaluepairdefinition_action = new MetaWrap.XML.Action(l_competition_add_namevaluepairdefinition,l_api_server + "/competition_add_namevaluepairdefinition");

// Call the action
if (!l_competition_add_namevaluepairdefinition_action.run(oncomplete_competition_add_namevaluepairdefinition))
{
    alert("There was an error calling 'competition_add_namevaluepairdefinition'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_add_namevaluepairdefinition
//

// JQuery GET request
    var dataString = 'api_key=api_key&competition_id=competition_id&name=name&type=type&encrypted=encrypted'
    $.get(
      l_api_server+'competition_add_namevaluepairdefinition',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_add_namevaluepairdefinition
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_add_namevaluepairdefinition version="V1.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<competition_id>competition_id</competition_id>\n';
    dataString += '<name>name</name>\n';
    dataString += '<type>type</type>\n';
    dataString += '<encrypted>encrypted</encrypted>\n';
    dataString += '</competition_add_namevaluepairdefinition></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_create_round - V0.0 - ThumbWhere

Create a new round for a competition.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_create_round (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_create_round = function(
	p_api_key,
	p_competition_id,
	p_name,
	p_description,
	p_submit_start,
	p_submit_end,
	p_vote_start,
	p_vote_end,
	p_vote_confirm_start,
	p_vote_confirm_end)
{
    this.m_action = {};
    this.m_action.m_competition_create_round = 
    { 
        m_api_key:p_api_key,
        m_competition_id:p_competition_id,
        m_name:p_name,
        m_description:p_description,
        m_submit_start:p_submit_start,
        m_submit_end:p_submit_end,
        m_vote_start:p_vote_start,
        m_vote_end:p_vote_end,
        m_vote_confirm_start:p_vote_confirm_start,
        m_vote_confirm_end:p_vote_confirm_end
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_create_round.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_create_round = 
        {

        };
    return this;
}                   

// Reference to the request
var l_competition_create_round = null;

// Reference to the action
var l_competition_create_round_action = null;

// This is called on completion of a call to competition_create_round
function oncomplete_competition_create_round()
{
    alert("oncomplete_competition_create_round");


    // Get response as object
    var l_obj = l_competition_create_round.m_response.m_competition_create_round;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_competition_create_round_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_create_round/status").text);

    // Get response as a single string
    alert(l_competition_create_round_action.m_response_string);
}

// Create the request
l_competition_create_round = new MetaWrap.XML.Action.WS.competition_create_round
(
								
    'api_key',
    'competition_id',
    'name',
    'description',
    'submit_start',
    'submit_end',
    'vote_start',
    'vote_end',
    'vote_confirm_start',
    'vote_confirm_end'
);

// Create action
l_competition_create_round_action = new MetaWrap.XML.Action(l_competition_create_round,l_api_server + "/competition_create_round");

// Call the action
if (!l_competition_create_round_action.run(oncomplete_competition_create_round))
{
    alert("There was an error calling 'competition_create_round'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_create_round
//

// JQuery GET request
    var dataString = 'api_key=api_key&competition_id=competition_id&name=name&description=description&submit_start=submit_start&submit_end=submit_end&vote_start=vote_start&vote_end=vote_end&vote_confirm_start=vote_confirm_start&vote_confirm_end=vote_confirm_end'
    $.get(
      l_api_server+'competition_create_round',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_create_round
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_create_round version="V0.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<competition_id>competition_id</competition_id>\n';
    dataString += '<name>name</name>\n';
    dataString += '<description>description</description>\n';
    dataString += '<submit_start>submit_start</submit_start>\n';
    dataString += '<submit_end>submit_end</submit_end>\n';
    dataString += '<vote_start>vote_start</vote_start>\n';
    dataString += '<vote_end>vote_end</vote_end>\n';
    dataString += '<vote_confirm_start>vote_confirm_start</vote_confirm_start>\n';
    dataString += '<vote_confirm_end>vote_confirm_end</vote_confirm_end>\n';
    dataString += '</competition_create_round></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_create_round - V1.0 - ThumbWhere

Create a new round for a competition.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_create_round (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_create_round = function(
	p_api_key,
	p_competition_id,
	p_name,
	p_description,
	p_submit_start,
	p_submit_end,
	p_vote_start,
	p_vote_end,
	p_vote_confirm_start,
	p_vote_confirm_end)
{
    this.m_action = {};
    this.m_action.m_competition_create_round = 
    { 
        m_api_key:p_api_key,
        m_competition_id:p_competition_id,
        m_name:p_name,
        m_description:p_description,
        m_submit_start:p_submit_start,
        m_submit_end:p_submit_end,
        m_vote_start:p_vote_start,
        m_vote_end:p_vote_end,
        m_vote_confirm_start:p_vote_confirm_start,
        m_vote_confirm_end:p_vote_confirm_end
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_create_round.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_create_round = 
        {

        };
    return this;
}                   

// Reference to the request
var l_competition_create_round = null;

// Reference to the action
var l_competition_create_round_action = null;

// This is called on completion of a call to competition_create_round
function oncomplete_competition_create_round()
{
    alert("oncomplete_competition_create_round");


    // Get response as object
    var l_obj = l_competition_create_round.m_response.m_competition_create_round;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_competition_create_round_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_create_round/status").text);

    // Get response as a single string
    alert(l_competition_create_round_action.m_response_string);
}

// Create the request
l_competition_create_round = new MetaWrap.XML.Action.WS.competition_create_round
(
								
    'api_key',
    'competition_id',
    'name',
    'description',
    'submit_start',
    'submit_end',
    'vote_start',
    'vote_end',
    'vote_confirm_start',
    'vote_confirm_end'
);

// Create action
l_competition_create_round_action = new MetaWrap.XML.Action(l_competition_create_round,l_api_server + "/competition_create_round");

// Call the action
if (!l_competition_create_round_action.run(oncomplete_competition_create_round))
{
    alert("There was an error calling 'competition_create_round'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_create_round
//

// JQuery GET request
    var dataString = 'api_key=api_key&competition_id=competition_id&name=name&description=description&submit_start=submit_start&submit_end=submit_end&vote_start=vote_start&vote_end=vote_end&vote_confirm_start=vote_confirm_start&vote_confirm_end=vote_confirm_end'
    $.get(
      l_api_server+'competition_create_round',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_create_round
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_create_round version="V1.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<competition_id>competition_id</competition_id>\n';
    dataString += '<name>name</name>\n';
    dataString += '<description>description</description>\n';
    dataString += '<submit_start>submit_start</submit_start>\n';
    dataString += '<submit_end>submit_end</submit_end>\n';
    dataString += '<vote_start>vote_start</vote_start>\n';
    dataString += '<vote_end>vote_end</vote_end>\n';
    dataString += '<vote_confirm_start>vote_confirm_start</vote_confirm_start>\n';
    dataString += '<vote_confirm_end>vote_confirm_end</vote_confirm_end>\n';
    dataString += '</competition_create_round></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_delete_namevaluepairdefinition - V0.0 - ThumbWhere

Deletes a name value pair definition for a competition.

This will delete the name value pair definition called #name# and all values of #name# across all competitions for this campaign.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_delete_namevaluepairdefinition (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_delete_namevaluepairdefinition = function(
	p_api_key,
	p_competition_id,
	p_name)
{
    this.m_action = {};
    this.m_action.m_competition_delete_namevaluepairdefinition = 
    { 
        m_api_key:p_api_key,
        m_competition_id:p_competition_id,
        m_name:p_name
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_delete_namevaluepairdefinition.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_delete_namevaluepairdefinition = 
        {

        };
    return this;
}                   

// Reference to the request
var l_competition_delete_namevaluepairdefinition = null;

// Reference to the action
var l_competition_delete_namevaluepairdefinition_action = null;

// This is called on completion of a call to competition_delete_namevaluepairdefinition
function oncomplete_competition_delete_namevaluepairdefinition()
{
    alert("oncomplete_competition_delete_namevaluepairdefinition");


    // Get response as object
    var l_obj = l_competition_delete_namevaluepairdefinition.m_response.m_competition_delete_namevaluepairdefinition;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_competition_delete_namevaluepairdefinition_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_delete_namevaluepairdefinition/status").text);

    // Get response as a single string
    alert(l_competition_delete_namevaluepairdefinition_action.m_response_string);
}

// Create the request
l_competition_delete_namevaluepairdefinition = new MetaWrap.XML.Action.WS.competition_delete_namevaluepairdefinition
(
								
    'api_key',
    'competition_id',
    'name'
);

// Create action
l_competition_delete_namevaluepairdefinition_action = new MetaWrap.XML.Action(l_competition_delete_namevaluepairdefinition,l_api_server + "/competition_delete_namevaluepairdefinition");

// Call the action
if (!l_competition_delete_namevaluepairdefinition_action.run(oncomplete_competition_delete_namevaluepairdefinition))
{
    alert("There was an error calling 'competition_delete_namevaluepairdefinition'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_delete_namevaluepairdefinition
//

// JQuery GET request
    var dataString = 'api_key=api_key&competition_id=competition_id&name=name'
    $.get(
      l_api_server+'competition_delete_namevaluepairdefinition',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_delete_namevaluepairdefinition
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_delete_namevaluepairdefinition version="V0.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<competition_id>competition_id</competition_id>\n';
    dataString += '<name>name</name>\n';
    dataString += '</competition_delete_namevaluepairdefinition></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_delete_namevaluepairdefinition - V1.0 - ThumbWhere

Deletes a name value pair definition for a competition.

This will delete the name value pair definition called #name# and all values of #name# across all competitions for this campaign.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_delete_namevaluepairdefinition (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_delete_namevaluepairdefinition = function(
	p_api_key,
	p_competition_id,
	p_name)
{
    this.m_action = {};
    this.m_action.m_competition_delete_namevaluepairdefinition = 
    { 
        m_api_key:p_api_key,
        m_competition_id:p_competition_id,
        m_name:p_name
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_delete_namevaluepairdefinition.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_delete_namevaluepairdefinition = 
        {

        };
    return this;
}                   

// Reference to the request
var l_competition_delete_namevaluepairdefinition = null;

// Reference to the action
var l_competition_delete_namevaluepairdefinition_action = null;

// This is called on completion of a call to competition_delete_namevaluepairdefinition
function oncomplete_competition_delete_namevaluepairdefinition()
{
    alert("oncomplete_competition_delete_namevaluepairdefinition");


    // Get response as object
    var l_obj = l_competition_delete_namevaluepairdefinition.m_response.m_competition_delete_namevaluepairdefinition;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_competition_delete_namevaluepairdefinition_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_delete_namevaluepairdefinition/status").text);

    // Get response as a single string
    alert(l_competition_delete_namevaluepairdefinition_action.m_response_string);
}

// Create the request
l_competition_delete_namevaluepairdefinition = new MetaWrap.XML.Action.WS.competition_delete_namevaluepairdefinition
(
								
    'api_key',
    'competition_id',
    'name'
);

// Create action
l_competition_delete_namevaluepairdefinition_action = new MetaWrap.XML.Action(l_competition_delete_namevaluepairdefinition,l_api_server + "/competition_delete_namevaluepairdefinition");

// Call the action
if (!l_competition_delete_namevaluepairdefinition_action.run(oncomplete_competition_delete_namevaluepairdefinition))
{
    alert("There was an error calling 'competition_delete_namevaluepairdefinition'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_delete_namevaluepairdefinition
//

// JQuery GET request
    var dataString = 'api_key=api_key&competition_id=competition_id&name=name'
    $.get(
      l_api_server+'competition_delete_namevaluepairdefinition',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_delete_namevaluepairdefinition
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_delete_namevaluepairdefinition version="V1.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<competition_id>competition_id</competition_id>\n';
    dataString += '<name>name</name>\n';
    dataString += '</competition_delete_namevaluepairdefinition></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_delete_round - V0.0 - ThumbWhere

Delete an existing round for a competition.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_delete_round (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_delete_round = function(
	p_api_key,
	p_competition_id,
	p_round_id)
{
    this.m_action = {};
    this.m_action.m_competition_delete_round = 
    { 
        m_api_key:p_api_key,
        m_competition_id:p_competition_id,
        m_round_id:p_round_id
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_delete_round.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_delete_round = 
        {

        };
    return this;
}                   

// Reference to the request
var l_competition_delete_round = null;

// Reference to the action
var l_competition_delete_round_action = null;

// This is called on completion of a call to competition_delete_round
function oncomplete_competition_delete_round()
{
    alert("oncomplete_competition_delete_round");


    // Get response as object
    var l_obj = l_competition_delete_round.m_response.m_competition_delete_round;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_competition_delete_round_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_delete_round/status").text);

    // Get response as a single string
    alert(l_competition_delete_round_action.m_response_string);
}

// Create the request
l_competition_delete_round = new MetaWrap.XML.Action.WS.competition_delete_round
(
								
    'api_key',
    'competition_id',
    'round_id'
);

// Create action
l_competition_delete_round_action = new MetaWrap.XML.Action(l_competition_delete_round,l_api_server + "/competition_delete_round");

// Call the action
if (!l_competition_delete_round_action.run(oncomplete_competition_delete_round))
{
    alert("There was an error calling 'competition_delete_round'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_delete_round
//

// JQuery GET request
    var dataString = 'api_key=api_key&competition_id=competition_id&round_id=round_id'
    $.get(
      l_api_server+'competition_delete_round',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_delete_round
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_delete_round version="V0.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<competition_id>competition_id</competition_id>\n';
    dataString += '<round_id>round_id</round_id>\n';
    dataString += '</competition_delete_round></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_delete_round - V1.0 - ThumbWhere

Delete an existing round for a competition.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_delete_round (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_delete_round = function(
	p_api_key,
	p_competition_id,
	p_round_id)
{
    this.m_action = {};
    this.m_action.m_competition_delete_round = 
    { 
        m_api_key:p_api_key,
        m_competition_id:p_competition_id,
        m_round_id:p_round_id
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_delete_round.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_delete_round = 
        {

        };
    return this;
}                   

// Reference to the request
var l_competition_delete_round = null;

// Reference to the action
var l_competition_delete_round_action = null;

// This is called on completion of a call to competition_delete_round
function oncomplete_competition_delete_round()
{
    alert("oncomplete_competition_delete_round");


    // Get response as object
    var l_obj = l_competition_delete_round.m_response.m_competition_delete_round;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_competition_delete_round_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_delete_round/status").text);

    // Get response as a single string
    alert(l_competition_delete_round_action.m_response_string);
}

// Create the request
l_competition_delete_round = new MetaWrap.XML.Action.WS.competition_delete_round
(
								
    'api_key',
    'competition_id',
    'round_id'
);

// Create action
l_competition_delete_round_action = new MetaWrap.XML.Action(l_competition_delete_round,l_api_server + "/competition_delete_round");

// Call the action
if (!l_competition_delete_round_action.run(oncomplete_competition_delete_round))
{
    alert("There was an error calling 'competition_delete_round'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_delete_round
//

// JQuery GET request
    var dataString = 'api_key=api_key&competition_id=competition_id&round_id=round_id'
    $.get(
      l_api_server+'competition_delete_round',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_delete_round
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_delete_round version="V1.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<competition_id>competition_id</competition_id>\n';
    dataString += '<round_id>round_id</round_id>\n';
    dataString += '</competition_delete_round></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_entry_confirm - V0.0 - ThumbWhere

Confirms a pending competition entry.

#api_key# is only used to determine that the caller is legitimate. The #code# will have been given to the member who submitted the #mediaitem# to the competition.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_entry_confirm (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_entry_confirm = function(
	p_api_key,
	p_code)
{
    this.m_action = {};
    this.m_action.m_competition_entry_confirm = 
    { 
        m_api_key:p_api_key,
        m_code:p_code
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_entry_confirm.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_entry_confirm = 
        {

        };
    return this;
}                   

// Reference to the request
var l_competition_entry_confirm = null;

// Reference to the action
var l_competition_entry_confirm_action = null;

// This is called on completion of a call to competition_entry_confirm
function oncomplete_competition_entry_confirm()
{
    alert("oncomplete_competition_entry_confirm");


    // Get response as object
    var l_obj = l_competition_entry_confirm.m_response.m_competition_entry_confirm;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_competition_entry_confirm_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_entry_confirm/status").text);

    // Get response as a single string
    alert(l_competition_entry_confirm_action.m_response_string);
}

// Create the request
l_competition_entry_confirm = new MetaWrap.XML.Action.WS.competition_entry_confirm
(
								
    'api_key',
    'code'
);

// Create action
l_competition_entry_confirm_action = new MetaWrap.XML.Action(l_competition_entry_confirm,l_api_server + "/competition_entry_confirm");

// Call the action
if (!l_competition_entry_confirm_action.run(oncomplete_competition_entry_confirm))
{
    alert("There was an error calling 'competition_entry_confirm'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_entry_confirm
//

// JQuery GET request
    var dataString = 'api_key=api_key&code=code'
    $.get(
      l_api_server+'competition_entry_confirm',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_entry_confirm
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_entry_confirm version="V0.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<code>code</code>\n';
    dataString += '</competition_entry_confirm></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_entry_confirm - V1.0 - ThumbWhere

Confirms a pending competition entry.

#api_key# is only used to determine that the caller is legitimate. The #code# will have been given to the member who submitted the #mediaitem# to the competition.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_entry_confirm (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_entry_confirm = function(
	p_api_key,
	p_code)
{
    this.m_action = {};
    this.m_action.m_competition_entry_confirm = 
    { 
        m_api_key:p_api_key,
        m_code:p_code
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_entry_confirm.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_entry_confirm = 
        {

            m_member:"",
            m_member_url:"",
            m_mediaitem_id:"",
            m_mediaitem_url:""
        };
    return this;
}                   

// Reference to the request
var l_competition_entry_confirm = null;

// Reference to the action
var l_competition_entry_confirm_action = null;

// This is called on completion of a call to competition_entry_confirm
function oncomplete_competition_entry_confirm()
{
    alert("oncomplete_competition_entry_confirm");


    // Get response as object
    var l_obj = l_competition_entry_confirm.m_response.m_competition_entry_confirm;
    alert("'status' = " + l_obj.m_status);
    alert("'member' = " + l_obj.m_member);
    alert("'member_url' = " + l_obj.m_member_url);
    alert("'mediaitem_id' = " + l_obj.m_mediaitem_id);
    alert("'mediaitem_url' = " + l_obj.m_mediaitem_url);

    // Get response as XML
    var l_xml = l_competition_entry_confirm_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_entry_confirm/status").text);    
    alert("'member' (from xml) = " +l_xml.selectSingleNode("response/competition_entry_confirm/member").text);    
    alert("'member_url' (from xml) = " +l_xml.selectSingleNode("response/competition_entry_confirm/member_url").text);    
    alert("'mediaitem_id' (from xml) = " +l_xml.selectSingleNode("response/competition_entry_confirm/mediaitem_id").text);    
    alert("'mediaitem_url' (from xml) = " +l_xml.selectSingleNode("response/competition_entry_confirm/mediaitem_url").text);

    // Get response as a single string
    alert(l_competition_entry_confirm_action.m_response_string);
}

// Create the request
l_competition_entry_confirm = new MetaWrap.XML.Action.WS.competition_entry_confirm
(
								
    'api_key',
    'code'
);

// Create action
l_competition_entry_confirm_action = new MetaWrap.XML.Action(l_competition_entry_confirm,l_api_server + "/competition_entry_confirm");

// Call the action
if (!l_competition_entry_confirm_action.run(oncomplete_competition_entry_confirm))
{
    alert("There was an error calling 'competition_entry_confirm'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_entry_confirm
//

// JQuery GET request
    var dataString = 'api_key=api_key&code=code'
    $.get(
      l_api_server+'competition_entry_confirm',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_entry_confirm
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_entry_confirm version="V1.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<code>code</code>\n';
    dataString += '</competition_entry_confirm></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_entry_create - V0.0 - ThumbWhere

Creates an competition entry

Takes a media item and enters it into a competition.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_entry_create (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_entry_create = function(
	p_api_key,
	p_api_member_token,
	p_round,
	p_mediaitem_id,
	p_approved)
{
    this.m_action = {};
    this.m_action.m_competition_entry_create = 
    { 
        m_api_key:p_api_key,
        m_api_member_token:p_api_member_token,
        m_round:p_round,
        m_mediaitem_id:p_mediaitem_id,
        m_approved:p_approved
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_entry_create.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_entry_create = 
        {

        };
    return this;
}                   

// Reference to the request
var l_competition_entry_create = null;

// Reference to the action
var l_competition_entry_create_action = null;

// This is called on completion of a call to competition_entry_create
function oncomplete_competition_entry_create()
{
    alert("oncomplete_competition_entry_create");


    // Get response as object
    var l_obj = l_competition_entry_create.m_response.m_competition_entry_create;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_competition_entry_create_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_entry_create/status").text);

    // Get response as a single string
    alert(l_competition_entry_create_action.m_response_string);
}

// Create the request
l_competition_entry_create = new MetaWrap.XML.Action.WS.competition_entry_create
(
								
    'api_key',
    'api_member_token',
    'round',
    'mediaitem_id',
    'approved'
);

// Create action
l_competition_entry_create_action = new MetaWrap.XML.Action(l_competition_entry_create,l_api_server + "/competition_entry_create");

// Call the action
if (!l_competition_entry_create_action.run(oncomplete_competition_entry_create))
{
    alert("There was an error calling 'competition_entry_create'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_entry_create
//

// JQuery GET request
    var dataString = 'api_key=api_key&api_member_token=api_member_token&round=round&mediaitem_id=mediaitem_id&approved=approved'
    $.get(
      l_api_server+'competition_entry_create',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_entry_create
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_entry_create version="V0.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<api_member_token>api_member_token</api_member_token>\n';
    dataString += '<round>round</round>\n';
    dataString += '<mediaitem_id>mediaitem_id</mediaitem_id>\n';
    dataString += '<approved>approved</approved>\n';
    dataString += '</competition_entry_create></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_entry_create - V1.0 - ThumbWhere

Creates an competition entry

Takes a media item and enters it into a competition.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_entry_create (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_entry_create = function(
	p_api_key,
	p_api_member_token,
	p_round,
	p_mediaitem_id,
	p_approved)
{
    this.m_action = {};
    this.m_action.m_competition_entry_create = 
    { 
        m_api_key:p_api_key,
        m_api_member_token:p_api_member_token,
        m_round:p_round,
        m_mediaitem_id:p_mediaitem_id,
        m_approved:p_approved
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_entry_create.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_entry_create = 
        {

            m_votecode:""
        };
    return this;
}                   

// Reference to the request
var l_competition_entry_create = null;

// Reference to the action
var l_competition_entry_create_action = null;

// This is called on completion of a call to competition_entry_create
function oncomplete_competition_entry_create()
{
    alert("oncomplete_competition_entry_create");


    // Get response as object
    var l_obj = l_competition_entry_create.m_response.m_competition_entry_create;
    alert("'status' = " + l_obj.m_status);
    alert("'votecode' = " + l_obj.m_votecode);

    // Get response as XML
    var l_xml = l_competition_entry_create_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_entry_create/status").text);    
    alert("'votecode' (from xml) = " +l_xml.selectSingleNode("response/competition_entry_create/votecode").text);

    // Get response as a single string
    alert(l_competition_entry_create_action.m_response_string);
}

// Create the request
l_competition_entry_create = new MetaWrap.XML.Action.WS.competition_entry_create
(
								
    'api_key',
    'api_member_token',
    'round',
    'mediaitem_id',
    'approved'
);

// Create action
l_competition_entry_create_action = new MetaWrap.XML.Action(l_competition_entry_create,l_api_server + "/competition_entry_create");

// Call the action
if (!l_competition_entry_create_action.run(oncomplete_competition_entry_create))
{
    alert("There was an error calling 'competition_entry_create'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_entry_create
//

// JQuery GET request
    var dataString = 'api_key=api_key&api_member_token=api_member_token&round=round&mediaitem_id=mediaitem_id&approved=approved'
    $.get(
      l_api_server+'competition_entry_create',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_entry_create
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_entry_create version="V1.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<api_member_token>api_member_token</api_member_token>\n';
    dataString += '<round>round</round>\n';
    dataString += '<mediaitem_id>mediaitem_id</mediaitem_id>\n';
    dataString += '<approved>approved</approved>\n';
    dataString += '</competition_entry_create></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_entry_query - V0.0 - ThumbWhere

Queries a pending competition entry.

#api_key# is only used to determine that the caller is legitimate. The #code# will have been given to the member who submitted the #mediaitem# to the competition.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_entry_query (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_entry_query = function(
	p_api_key,
	p_code)
{
    this.m_action = {};
    this.m_action.m_competition_entry_query = 
    { 
        m_api_key:p_api_key,
        m_code:p_code
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_entry_query.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_entry_query = 
        {

        };
    return this;
}                   

// Reference to the request
var l_competition_entry_query = null;

// Reference to the action
var l_competition_entry_query_action = null;

// This is called on completion of a call to competition_entry_query
function oncomplete_competition_entry_query()
{
    alert("oncomplete_competition_entry_query");


    // Get response as object
    var l_obj = l_competition_entry_query.m_response.m_competition_entry_query;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_competition_entry_query_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_entry_query/status").text);

    // Get response as a single string
    alert(l_competition_entry_query_action.m_response_string);
}

// Create the request
l_competition_entry_query = new MetaWrap.XML.Action.WS.competition_entry_query
(
								
    'api_key',
    'code'
);

// Create action
l_competition_entry_query_action = new MetaWrap.XML.Action(l_competition_entry_query,l_api_server + "/competition_entry_query");

// Call the action
if (!l_competition_entry_query_action.run(oncomplete_competition_entry_query))
{
    alert("There was an error calling 'competition_entry_query'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_entry_query
//

// JQuery GET request
    var dataString = 'api_key=api_key&code=code'
    $.get(
      l_api_server+'competition_entry_query',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_entry_query
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_entry_query version="V0.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<code>code</code>\n';
    dataString += '</competition_entry_query></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_entry_query - V1.0 - ThumbWhere

Queries a pending competition entry.

#api_key# is only used to determine that the caller is legitimate. The #code# will have been given to the member who submitted the #mediaitem# to the competition.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_entry_query (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_entry_query = function(
	p_api_key,
	p_code)
{
    this.m_action = {};
    this.m_action.m_competition_entry_query = 
    { 
        m_api_key:p_api_key,
        m_code:p_code
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_entry_query.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_entry_query = 
        {

            m_member:"",
            m_member_url:"",
            m_mediaitem_id:"",
            m_mediaitem_url:""
        };
    return this;
}                   

// Reference to the request
var l_competition_entry_query = null;

// Reference to the action
var l_competition_entry_query_action = null;

// This is called on completion of a call to competition_entry_query
function oncomplete_competition_entry_query()
{
    alert("oncomplete_competition_entry_query");


    // Get response as object
    var l_obj = l_competition_entry_query.m_response.m_competition_entry_query;
    alert("'status' = " + l_obj.m_status);
    alert("'member' = " + l_obj.m_member);
    alert("'member_url' = " + l_obj.m_member_url);
    alert("'mediaitem_id' = " + l_obj.m_mediaitem_id);
    alert("'mediaitem_url' = " + l_obj.m_mediaitem_url);

    // Get response as XML
    var l_xml = l_competition_entry_query_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_entry_query/status").text);    
    alert("'member' (from xml) = " +l_xml.selectSingleNode("response/competition_entry_query/member").text);    
    alert("'member_url' (from xml) = " +l_xml.selectSingleNode("response/competition_entry_query/member_url").text);    
    alert("'mediaitem_id' (from xml) = " +l_xml.selectSingleNode("response/competition_entry_query/mediaitem_id").text);    
    alert("'mediaitem_url' (from xml) = " +l_xml.selectSingleNode("response/competition_entry_query/mediaitem_url").text);

    // Get response as a single string
    alert(l_competition_entry_query_action.m_response_string);
}

// Create the request
l_competition_entry_query = new MetaWrap.XML.Action.WS.competition_entry_query
(
								
    'api_key',
    'code'
);

// Create action
l_competition_entry_query_action = new MetaWrap.XML.Action(l_competition_entry_query,l_api_server + "/competition_entry_query");

// Call the action
if (!l_competition_entry_query_action.run(oncomplete_competition_entry_query))
{
    alert("There was an error calling 'competition_entry_query'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_entry_query
//

// JQuery GET request
    var dataString = 'api_key=api_key&code=code'
    $.get(
      l_api_server+'competition_entry_query',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_entry_query
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_entry_query version="V1.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<code>code</code>\n';
    dataString += '</competition_entry_query></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_entry_set_approved - V0.0 - ThumbWhere

Sets the approved flag for a competition entry.

Approves an entry. After approval this entry will be available in the competitions.xml manifest file.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_entry_set_approved (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_entry_set_approved = function(
	p_api_key,
	p_votecode,
	p_approved)
{
    this.m_action = {};
    this.m_action.m_competition_entry_set_approved = 
    { 
        m_api_key:p_api_key,
        m_votecode:p_votecode,
        m_approved:p_approved
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_entry_set_approved.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_entry_set_approved = 
        {

        };
    return this;
}                   

// Reference to the request
var l_competition_entry_set_approved = null;

// Reference to the action
var l_competition_entry_set_approved_action = null;

// This is called on completion of a call to competition_entry_set_approved
function oncomplete_competition_entry_set_approved()
{
    alert("oncomplete_competition_entry_set_approved");


    // Get response as object
    var l_obj = l_competition_entry_set_approved.m_response.m_competition_entry_set_approved;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_competition_entry_set_approved_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_entry_set_approved/status").text);

    // Get response as a single string
    alert(l_competition_entry_set_approved_action.m_response_string);
}

// Create the request
l_competition_entry_set_approved = new MetaWrap.XML.Action.WS.competition_entry_set_approved
(
								
    'api_key',
    'votecode',
    'approved'
);

// Create action
l_competition_entry_set_approved_action = new MetaWrap.XML.Action(l_competition_entry_set_approved,l_api_server + "/competition_entry_set_approved");

// Call the action
if (!l_competition_entry_set_approved_action.run(oncomplete_competition_entry_set_approved))
{
    alert("There was an error calling 'competition_entry_set_approved'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_entry_set_approved
//

// JQuery GET request
    var dataString = 'api_key=api_key&votecode=votecode&approved=approved'
    $.get(
      l_api_server+'competition_entry_set_approved',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_entry_set_approved
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_entry_set_approved version="V0.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<votecode>votecode</votecode>\n';
    dataString += '<approved>approved</approved>\n';
    dataString += '</competition_entry_set_approved></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_entry_set_approved - V1.0 - ThumbWhere

Sets the approved flag for a competition entry.

Approves an entry. After approval this entry will be available in the competitions.xml manifest file.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_entry_set_approved (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_entry_set_approved = function(
	p_api_key,
	p_votecode,
	p_approved)
{
    this.m_action = {};
    this.m_action.m_competition_entry_set_approved = 
    { 
        m_api_key:p_api_key,
        m_votecode:p_votecode,
        m_approved:p_approved
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_entry_set_approved.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_entry_set_approved = 
        {

        };
    return this;
}                   

// Reference to the request
var l_competition_entry_set_approved = null;

// Reference to the action
var l_competition_entry_set_approved_action = null;

// This is called on completion of a call to competition_entry_set_approved
function oncomplete_competition_entry_set_approved()
{
    alert("oncomplete_competition_entry_set_approved");


    // Get response as object
    var l_obj = l_competition_entry_set_approved.m_response.m_competition_entry_set_approved;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_competition_entry_set_approved_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_entry_set_approved/status").text);

    // Get response as a single string
    alert(l_competition_entry_set_approved_action.m_response_string);
}

// Create the request
l_competition_entry_set_approved = new MetaWrap.XML.Action.WS.competition_entry_set_approved
(
								
    'api_key',
    'votecode',
    'approved'
);

// Create action
l_competition_entry_set_approved_action = new MetaWrap.XML.Action(l_competition_entry_set_approved,l_api_server + "/competition_entry_set_approved");

// Call the action
if (!l_competition_entry_set_approved_action.run(oncomplete_competition_entry_set_approved))
{
    alert("There was an error calling 'competition_entry_set_approved'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_entry_set_approved
//

// JQuery GET request
    var dataString = 'api_key=api_key&votecode=votecode&approved=approved'
    $.get(
      l_api_server+'competition_entry_set_approved',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_entry_set_approved
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_entry_set_approved version="V1.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<votecode>votecode</votecode>\n';
    dataString += '<approved>approved</approved>\n';
    dataString += '</competition_entry_set_approved></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_entry_set_competitionfinalist - V0.0 - ThumbWhere

Sets the competitionfinalist flag for a competition entry.

Sets the value for the entry competitionfinalist attribute which is used to signify that this entry is the finalist of a round.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_entry_set_competitionfinalist (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_entry_set_competitionfinalist = function(
	p_api_key,
	p_votecode,
	p_competitionfinalist)
{
    this.m_action = {};
    this.m_action.m_competition_entry_set_competitionfinalist = 
    { 
        m_api_key:p_api_key,
        m_votecode:p_votecode,
        m_competitionfinalist:p_competitionfinalist
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_entry_set_competitionfinalist.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_entry_set_competitionfinalist = 
        {

        };
    return this;
}                   

// Reference to the request
var l_competition_entry_set_competitionfinalist = null;

// Reference to the action
var l_competition_entry_set_competitionfinalist_action = null;

// This is called on completion of a call to competition_entry_set_competitionfinalist
function oncomplete_competition_entry_set_competitionfinalist()
{
    alert("oncomplete_competition_entry_set_competitionfinalist");


    // Get response as object
    var l_obj = l_competition_entry_set_competitionfinalist.m_response.m_competition_entry_set_competitionfinalist;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_competition_entry_set_competitionfinalist_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_entry_set_competitionfinalist/status").text);

    // Get response as a single string
    alert(l_competition_entry_set_competitionfinalist_action.m_response_string);
}

// Create the request
l_competition_entry_set_competitionfinalist = new MetaWrap.XML.Action.WS.competition_entry_set_competitionfinalist
(
								
    'api_key',
    'votecode',
    'competitionfinalist'
);

// Create action
l_competition_entry_set_competitionfinalist_action = new MetaWrap.XML.Action(l_competition_entry_set_competitionfinalist,l_api_server + "/competition_entry_set_competitionfinalist");

// Call the action
if (!l_competition_entry_set_competitionfinalist_action.run(oncomplete_competition_entry_set_competitionfinalist))
{
    alert("There was an error calling 'competition_entry_set_competitionfinalist'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_entry_set_competitionfinalist
//

// JQuery GET request
    var dataString = 'api_key=api_key&votecode=votecode&competitionfinalist=competitionfinalist'
    $.get(
      l_api_server+'competition_entry_set_competitionfinalist',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_entry_set_competitionfinalist
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_entry_set_competitionfinalist version="V0.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<votecode>votecode</votecode>\n';
    dataString += '<competitionfinalist>competitionfinalist</competitionfinalist>\n';
    dataString += '</competition_entry_set_competitionfinalist></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_entry_set_competitionfinalist - V1.0 - ThumbWhere

Sets the competitionfinalist flag for a competition entry.

Sets the value for the entry competitionfinalist attribute which is used to signify that this entry is the finalist of a round.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_entry_set_competitionfinalist (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_entry_set_competitionfinalist = function(
	p_api_key,
	p_votecode,
	p_competitionfinalist)
{
    this.m_action = {};
    this.m_action.m_competition_entry_set_competitionfinalist = 
    { 
        m_api_key:p_api_key,
        m_votecode:p_votecode,
        m_competitionfinalist:p_competitionfinalist
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_entry_set_competitionfinalist.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_entry_set_competitionfinalist = 
        {

        };
    return this;
}                   

// Reference to the request
var l_competition_entry_set_competitionfinalist = null;

// Reference to the action
var l_competition_entry_set_competitionfinalist_action = null;

// This is called on completion of a call to competition_entry_set_competitionfinalist
function oncomplete_competition_entry_set_competitionfinalist()
{
    alert("oncomplete_competition_entry_set_competitionfinalist");


    // Get response as object
    var l_obj = l_competition_entry_set_competitionfinalist.m_response.m_competition_entry_set_competitionfinalist;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_competition_entry_set_competitionfinalist_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_entry_set_competitionfinalist/status").text);

    // Get response as a single string
    alert(l_competition_entry_set_competitionfinalist_action.m_response_string);
}

// Create the request
l_competition_entry_set_competitionfinalist = new MetaWrap.XML.Action.WS.competition_entry_set_competitionfinalist
(
								
    'api_key',
    'votecode',
    'competitionfinalist'
);

// Create action
l_competition_entry_set_competitionfinalist_action = new MetaWrap.XML.Action(l_competition_entry_set_competitionfinalist,l_api_server + "/competition_entry_set_competitionfinalist");

// Call the action
if (!l_competition_entry_set_competitionfinalist_action.run(oncomplete_competition_entry_set_competitionfinalist))
{
    alert("There was an error calling 'competition_entry_set_competitionfinalist'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_entry_set_competitionfinalist
//

// JQuery GET request
    var dataString = 'api_key=api_key&votecode=votecode&competitionfinalist=competitionfinalist'
    $.get(
      l_api_server+'competition_entry_set_competitionfinalist',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_entry_set_competitionfinalist
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_entry_set_competitionfinalist version="V1.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<votecode>votecode</votecode>\n';
    dataString += '<competitionfinalist>competitionfinalist</competitionfinalist>\n';
    dataString += '</competition_entry_set_competitionfinalist></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_entry_set_competitionwinner - V0.0 - ThumbWhere

Sets the compeitionwinner flag for a competition entry.

Sets the value for the entry competitionwinner attribute which is used to signify that this entry is the winner of a round.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_entry_set_competitionwinner (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_entry_set_competitionwinner = function(
	p_api_key,
	p_votecode,
	p_competitionwinner)
{
    this.m_action = {};
    this.m_action.m_competition_entry_set_competitionwinner = 
    { 
        m_api_key:p_api_key,
        m_votecode:p_votecode,
        m_competitionwinner:p_competitionwinner
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_entry_set_competitionwinner.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_entry_set_competitionwinner = 
        {

        };
    return this;
}                   

// Reference to the request
var l_competition_entry_set_competitionwinner = null;

// Reference to the action
var l_competition_entry_set_competitionwinner_action = null;

// This is called on completion of a call to competition_entry_set_competitionwinner
function oncomplete_competition_entry_set_competitionwinner()
{
    alert("oncomplete_competition_entry_set_competitionwinner");


    // Get response as object
    var l_obj = l_competition_entry_set_competitionwinner.m_response.m_competition_entry_set_competitionwinner;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_competition_entry_set_competitionwinner_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_entry_set_competitionwinner/status").text);

    // Get response as a single string
    alert(l_competition_entry_set_competitionwinner_action.m_response_string);
}

// Create the request
l_competition_entry_set_competitionwinner = new MetaWrap.XML.Action.WS.competition_entry_set_competitionwinner
(
								
    'api_key',
    'votecode',
    'competitionwinner'
);

// Create action
l_competition_entry_set_competitionwinner_action = new MetaWrap.XML.Action(l_competition_entry_set_competitionwinner,l_api_server + "/competition_entry_set_competitionwinner");

// Call the action
if (!l_competition_entry_set_competitionwinner_action.run(oncomplete_competition_entry_set_competitionwinner))
{
    alert("There was an error calling 'competition_entry_set_competitionwinner'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_entry_set_competitionwinner
//

// JQuery GET request
    var dataString = 'api_key=api_key&votecode=votecode&competitionwinner=competitionwinner'
    $.get(
      l_api_server+'competition_entry_set_competitionwinner',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_entry_set_competitionwinner
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_entry_set_competitionwinner version="V0.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<votecode>votecode</votecode>\n';
    dataString += '<competitionwinner>competitionwinner</competitionwinner>\n';
    dataString += '</competition_entry_set_competitionwinner></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_entry_set_competitionwinner - V1.0 - ThumbWhere

Sets the compeitionwinner flag for a competition entry.

Sets the value for the entry competitionwinner attribute which is used to signify that this entry is the winner of a round.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_entry_set_competitionwinner (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_entry_set_competitionwinner = function(
	p_api_key,
	p_votecode,
	p_competitionwinner)
{
    this.m_action = {};
    this.m_action.m_competition_entry_set_competitionwinner = 
    { 
        m_api_key:p_api_key,
        m_votecode:p_votecode,
        m_competitionwinner:p_competitionwinner
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_entry_set_competitionwinner.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_entry_set_competitionwinner = 
        {

        };
    return this;
}                   

// Reference to the request
var l_competition_entry_set_competitionwinner = null;

// Reference to the action
var l_competition_entry_set_competitionwinner_action = null;

// This is called on completion of a call to competition_entry_set_competitionwinner
function oncomplete_competition_entry_set_competitionwinner()
{
    alert("oncomplete_competition_entry_set_competitionwinner");


    // Get response as object
    var l_obj = l_competition_entry_set_competitionwinner.m_response.m_competition_entry_set_competitionwinner;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_competition_entry_set_competitionwinner_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_entry_set_competitionwinner/status").text);

    // Get response as a single string
    alert(l_competition_entry_set_competitionwinner_action.m_response_string);
}

// Create the request
l_competition_entry_set_competitionwinner = new MetaWrap.XML.Action.WS.competition_entry_set_competitionwinner
(
								
    'api_key',
    'votecode',
    'competitionwinner'
);

// Create action
l_competition_entry_set_competitionwinner_action = new MetaWrap.XML.Action(l_competition_entry_set_competitionwinner,l_api_server + "/competition_entry_set_competitionwinner");

// Call the action
if (!l_competition_entry_set_competitionwinner_action.run(oncomplete_competition_entry_set_competitionwinner))
{
    alert("There was an error calling 'competition_entry_set_competitionwinner'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_entry_set_competitionwinner
//

// JQuery GET request
    var dataString = 'api_key=api_key&votecode=votecode&competitionwinner=competitionwinner'
    $.get(
      l_api_server+'competition_entry_set_competitionwinner',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_entry_set_competitionwinner
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_entry_set_competitionwinner version="V1.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<votecode>votecode</votecode>\n';
    dataString += '<competitionwinner>competitionwinner</competitionwinner>\n';
    dataString += '</competition_entry_set_competitionwinner></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_entry_set_deleted - V0.0 - ThumbWhere

Sets the deleted flag for a competition entry.

Approves an entry. After approval this entry will be available in the competitions.xml manifest file.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_entry_set_deleted (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_entry_set_deleted = function(
	p_api_key,
	p_votecode,
	p_deleted)
{
    this.m_action = {};
    this.m_action.m_competition_entry_set_deleted = 
    { 
        m_api_key:p_api_key,
        m_votecode:p_votecode,
        m_deleted:p_deleted
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_entry_set_deleted.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_entry_set_deleted = 
        {

        };
    return this;
}                   

// Reference to the request
var l_competition_entry_set_deleted = null;

// Reference to the action
var l_competition_entry_set_deleted_action = null;

// This is called on completion of a call to competition_entry_set_deleted
function oncomplete_competition_entry_set_deleted()
{
    alert("oncomplete_competition_entry_set_deleted");


    // Get response as object
    var l_obj = l_competition_entry_set_deleted.m_response.m_competition_entry_set_deleted;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_competition_entry_set_deleted_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_entry_set_deleted/status").text);

    // Get response as a single string
    alert(l_competition_entry_set_deleted_action.m_response_string);
}

// Create the request
l_competition_entry_set_deleted = new MetaWrap.XML.Action.WS.competition_entry_set_deleted
(
								
    'api_key',
    'votecode',
    'deleted'
);

// Create action
l_competition_entry_set_deleted_action = new MetaWrap.XML.Action(l_competition_entry_set_deleted,l_api_server + "/competition_entry_set_deleted");

// Call the action
if (!l_competition_entry_set_deleted_action.run(oncomplete_competition_entry_set_deleted))
{
    alert("There was an error calling 'competition_entry_set_deleted'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_entry_set_deleted
//

// JQuery GET request
    var dataString = 'api_key=api_key&votecode=votecode&deleted=deleted'
    $.get(
      l_api_server+'competition_entry_set_deleted',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_entry_set_deleted
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_entry_set_deleted version="V0.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<votecode>votecode</votecode>\n';
    dataString += '<deleted>deleted</deleted>\n';
    dataString += '</competition_entry_set_deleted></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_entry_set_deleted - V1.0 - ThumbWhere

Sets the deleted flag for a competition entry.

Approves an entry. After approval this entry will be available in the competitions.xml manifest file.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_entry_set_deleted (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_entry_set_deleted = function(
	p_api_key,
	p_votecode,
	p_deleted)
{
    this.m_action = {};
    this.m_action.m_competition_entry_set_deleted = 
    { 
        m_api_key:p_api_key,
        m_votecode:p_votecode,
        m_deleted:p_deleted
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_entry_set_deleted.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_entry_set_deleted = 
        {

        };
    return this;
}                   

// Reference to the request
var l_competition_entry_set_deleted = null;

// Reference to the action
var l_competition_entry_set_deleted_action = null;

// This is called on completion of a call to competition_entry_set_deleted
function oncomplete_competition_entry_set_deleted()
{
    alert("oncomplete_competition_entry_set_deleted");


    // Get response as object
    var l_obj = l_competition_entry_set_deleted.m_response.m_competition_entry_set_deleted;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_competition_entry_set_deleted_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_entry_set_deleted/status").text);

    // Get response as a single string
    alert(l_competition_entry_set_deleted_action.m_response_string);
}

// Create the request
l_competition_entry_set_deleted = new MetaWrap.XML.Action.WS.competition_entry_set_deleted
(
								
    'api_key',
    'votecode',
    'deleted'
);

// Create action
l_competition_entry_set_deleted_action = new MetaWrap.XML.Action(l_competition_entry_set_deleted,l_api_server + "/competition_entry_set_deleted");

// Call the action
if (!l_competition_entry_set_deleted_action.run(oncomplete_competition_entry_set_deleted))
{
    alert("There was an error calling 'competition_entry_set_deleted'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_entry_set_deleted
//

// JQuery GET request
    var dataString = 'api_key=api_key&votecode=votecode&deleted=deleted'
    $.get(
      l_api_server+'competition_entry_set_deleted',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_entry_set_deleted
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_entry_set_deleted version="V1.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<votecode>votecode</votecode>\n';
    dataString += '<deleted>deleted</deleted>\n';
    dataString += '</competition_entry_set_deleted></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_entry_set_rejected - V0.0 - ThumbWhere

Sets the rejected flag for a competition entry.

Marks an entry as rejected.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_entry_set_rejected (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_entry_set_rejected = function(
	p_api_key,
	p_votecode,
	p_rejected)
{
    this.m_action = {};
    this.m_action.m_competition_entry_set_rejected = 
    { 
        m_api_key:p_api_key,
        m_votecode:p_votecode,
        m_rejected:p_rejected
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_entry_set_rejected.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_entry_set_rejected = 
        {

        };
    return this;
}                   

// Reference to the request
var l_competition_entry_set_rejected = null;

// Reference to the action
var l_competition_entry_set_rejected_action = null;

// This is called on completion of a call to competition_entry_set_rejected
function oncomplete_competition_entry_set_rejected()
{
    alert("oncomplete_competition_entry_set_rejected");


    // Get response as object
    var l_obj = l_competition_entry_set_rejected.m_response.m_competition_entry_set_rejected;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_competition_entry_set_rejected_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_entry_set_rejected/status").text);

    // Get response as a single string
    alert(l_competition_entry_set_rejected_action.m_response_string);
}

// Create the request
l_competition_entry_set_rejected = new MetaWrap.XML.Action.WS.competition_entry_set_rejected
(
								
    'api_key',
    'votecode',
    'rejected'
);

// Create action
l_competition_entry_set_rejected_action = new MetaWrap.XML.Action(l_competition_entry_set_rejected,l_api_server + "/competition_entry_set_rejected");

// Call the action
if (!l_competition_entry_set_rejected_action.run(oncomplete_competition_entry_set_rejected))
{
    alert("There was an error calling 'competition_entry_set_rejected'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_entry_set_rejected
//

// JQuery GET request
    var dataString = 'api_key=api_key&votecode=votecode&rejected=rejected'
    $.get(
      l_api_server+'competition_entry_set_rejected',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_entry_set_rejected
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_entry_set_rejected version="V0.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<votecode>votecode</votecode>\n';
    dataString += '<rejected>rejected</rejected>\n';
    dataString += '</competition_entry_set_rejected></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_entry_set_rejected - V1.0 - ThumbWhere

Sets the rejected flag for a competition entry.

Marks an entry as rejected.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_entry_set_rejected (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_entry_set_rejected = function(
	p_api_key,
	p_votecode,
	p_rejected)
{
    this.m_action = {};
    this.m_action.m_competition_entry_set_rejected = 
    { 
        m_api_key:p_api_key,
        m_votecode:p_votecode,
        m_rejected:p_rejected
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_entry_set_rejected.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_entry_set_rejected = 
        {

        };
    return this;
}                   

// Reference to the request
var l_competition_entry_set_rejected = null;

// Reference to the action
var l_competition_entry_set_rejected_action = null;

// This is called on completion of a call to competition_entry_set_rejected
function oncomplete_competition_entry_set_rejected()
{
    alert("oncomplete_competition_entry_set_rejected");


    // Get response as object
    var l_obj = l_competition_entry_set_rejected.m_response.m_competition_entry_set_rejected;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_competition_entry_set_rejected_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_entry_set_rejected/status").text);

    // Get response as a single string
    alert(l_competition_entry_set_rejected_action.m_response_string);
}

// Create the request
l_competition_entry_set_rejected = new MetaWrap.XML.Action.WS.competition_entry_set_rejected
(
								
    'api_key',
    'votecode',
    'rejected'
);

// Create action
l_competition_entry_set_rejected_action = new MetaWrap.XML.Action(l_competition_entry_set_rejected,l_api_server + "/competition_entry_set_rejected");

// Call the action
if (!l_competition_entry_set_rejected_action.run(oncomplete_competition_entry_set_rejected))
{
    alert("There was an error calling 'competition_entry_set_rejected'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_entry_set_rejected
//

// JQuery GET request
    var dataString = 'api_key=api_key&votecode=votecode&rejected=rejected'
    $.get(
      l_api_server+'competition_entry_set_rejected',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_entry_set_rejected
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_entry_set_rejected version="V1.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<votecode>votecode</votecode>\n';
    dataString += '<rejected>rejected</rejected>\n';
    dataString += '</competition_entry_set_rejected></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_entry_set_roundfinalist - V0.0 - ThumbWhere

Sets the roundfinalist flag for a competition entry.

Sets the value for the entry roundfinalist attribute which is used to signify that this entry is the finalist of a round.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_entry_set_roundfinalist (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_entry_set_roundfinalist = function(
	p_api_key,
	p_votecode,
	p_roundfinalist)
{
    this.m_action = {};
    this.m_action.m_competition_entry_set_roundfinalist = 
    { 
        m_api_key:p_api_key,
        m_votecode:p_votecode,
        m_roundfinalist:p_roundfinalist
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_entry_set_roundfinalist.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_entry_set_roundfinalist = 
        {

        };
    return this;
}                   

// Reference to the request
var l_competition_entry_set_roundfinalist = null;

// Reference to the action
var l_competition_entry_set_roundfinalist_action = null;

// This is called on completion of a call to competition_entry_set_roundfinalist
function oncomplete_competition_entry_set_roundfinalist()
{
    alert("oncomplete_competition_entry_set_roundfinalist");


    // Get response as object
    var l_obj = l_competition_entry_set_roundfinalist.m_response.m_competition_entry_set_roundfinalist;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_competition_entry_set_roundfinalist_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_entry_set_roundfinalist/status").text);

    // Get response as a single string
    alert(l_competition_entry_set_roundfinalist_action.m_response_string);
}

// Create the request
l_competition_entry_set_roundfinalist = new MetaWrap.XML.Action.WS.competition_entry_set_roundfinalist
(
								
    'api_key',
    'votecode',
    'roundfinalist'
);

// Create action
l_competition_entry_set_roundfinalist_action = new MetaWrap.XML.Action(l_competition_entry_set_roundfinalist,l_api_server + "/competition_entry_set_roundfinalist");

// Call the action
if (!l_competition_entry_set_roundfinalist_action.run(oncomplete_competition_entry_set_roundfinalist))
{
    alert("There was an error calling 'competition_entry_set_roundfinalist'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_entry_set_roundfinalist
//

// JQuery GET request
    var dataString = 'api_key=api_key&votecode=votecode&roundfinalist=roundfinalist'
    $.get(
      l_api_server+'competition_entry_set_roundfinalist',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_entry_set_roundfinalist
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_entry_set_roundfinalist version="V0.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<votecode>votecode</votecode>\n';
    dataString += '<roundfinalist>roundfinalist</roundfinalist>\n';
    dataString += '</competition_entry_set_roundfinalist></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_entry_set_roundfinalist - V1.0 - ThumbWhere

Sets the roundfinalist flag for a competition entry.

Sets the value for the entry roundfinalist attribute which is used to signify that this entry is the finalist of a round.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_entry_set_roundfinalist (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_entry_set_roundfinalist = function(
	p_api_key,
	p_votecode,
	p_roundfinalist)
{
    this.m_action = {};
    this.m_action.m_competition_entry_set_roundfinalist = 
    { 
        m_api_key:p_api_key,
        m_votecode:p_votecode,
        m_roundfinalist:p_roundfinalist
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_entry_set_roundfinalist.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_entry_set_roundfinalist = 
        {

        };
    return this;
}                   

// Reference to the request
var l_competition_entry_set_roundfinalist = null;

// Reference to the action
var l_competition_entry_set_roundfinalist_action = null;

// This is called on completion of a call to competition_entry_set_roundfinalist
function oncomplete_competition_entry_set_roundfinalist()
{
    alert("oncomplete_competition_entry_set_roundfinalist");


    // Get response as object
    var l_obj = l_competition_entry_set_roundfinalist.m_response.m_competition_entry_set_roundfinalist;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_competition_entry_set_roundfinalist_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_entry_set_roundfinalist/status").text);

    // Get response as a single string
    alert(l_competition_entry_set_roundfinalist_action.m_response_string);
}

// Create the request
l_competition_entry_set_roundfinalist = new MetaWrap.XML.Action.WS.competition_entry_set_roundfinalist
(
								
    'api_key',
    'votecode',
    'roundfinalist'
);

// Create action
l_competition_entry_set_roundfinalist_action = new MetaWrap.XML.Action(l_competition_entry_set_roundfinalist,l_api_server + "/competition_entry_set_roundfinalist");

// Call the action
if (!l_competition_entry_set_roundfinalist_action.run(oncomplete_competition_entry_set_roundfinalist))
{
    alert("There was an error calling 'competition_entry_set_roundfinalist'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_entry_set_roundfinalist
//

// JQuery GET request
    var dataString = 'api_key=api_key&votecode=votecode&roundfinalist=roundfinalist'
    $.get(
      l_api_server+'competition_entry_set_roundfinalist',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_entry_set_roundfinalist
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_entry_set_roundfinalist version="V1.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<votecode>votecode</votecode>\n';
    dataString += '<roundfinalist>roundfinalist</roundfinalist>\n';
    dataString += '</competition_entry_set_roundfinalist></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_entry_set_roundwinner - V0.0 - ThumbWhere

Sets the roundwinner flag for a competition entry.

Sets the value for the entry roundwinner attribute which is used to signify that this entry is the winner of a round.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_entry_set_roundwinner (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_entry_set_roundwinner = function(
	p_api_key,
	p_votecode,
	p_roundwinner)
{
    this.m_action = {};
    this.m_action.m_competition_entry_set_roundwinner = 
    { 
        m_api_key:p_api_key,
        m_votecode:p_votecode,
        m_roundwinner:p_roundwinner
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_entry_set_roundwinner.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_entry_set_roundwinner = 
        {

        };
    return this;
}                   

// Reference to the request
var l_competition_entry_set_roundwinner = null;

// Reference to the action
var l_competition_entry_set_roundwinner_action = null;

// This is called on completion of a call to competition_entry_set_roundwinner
function oncomplete_competition_entry_set_roundwinner()
{
    alert("oncomplete_competition_entry_set_roundwinner");


    // Get response as object
    var l_obj = l_competition_entry_set_roundwinner.m_response.m_competition_entry_set_roundwinner;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_competition_entry_set_roundwinner_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_entry_set_roundwinner/status").text);

    // Get response as a single string
    alert(l_competition_entry_set_roundwinner_action.m_response_string);
}

// Create the request
l_competition_entry_set_roundwinner = new MetaWrap.XML.Action.WS.competition_entry_set_roundwinner
(
								
    'api_key',
    'votecode',
    'roundwinner'
);

// Create action
l_competition_entry_set_roundwinner_action = new MetaWrap.XML.Action(l_competition_entry_set_roundwinner,l_api_server + "/competition_entry_set_roundwinner");

// Call the action
if (!l_competition_entry_set_roundwinner_action.run(oncomplete_competition_entry_set_roundwinner))
{
    alert("There was an error calling 'competition_entry_set_roundwinner'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_entry_set_roundwinner
//

// JQuery GET request
    var dataString = 'api_key=api_key&votecode=votecode&roundwinner=roundwinner'
    $.get(
      l_api_server+'competition_entry_set_roundwinner',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_entry_set_roundwinner
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_entry_set_roundwinner version="V0.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<votecode>votecode</votecode>\n';
    dataString += '<roundwinner>roundwinner</roundwinner>\n';
    dataString += '</competition_entry_set_roundwinner></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_entry_set_roundwinner - V1.0 - ThumbWhere

Sets the roundwinner flag for a competition entry.

Sets the value for the entry roundwinner attribute which is used to signify that this entry is the winner of a round.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_entry_set_roundwinner (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_entry_set_roundwinner = function(
	p_api_key,
	p_votecode,
	p_roundwinner)
{
    this.m_action = {};
    this.m_action.m_competition_entry_set_roundwinner = 
    { 
        m_api_key:p_api_key,
        m_votecode:p_votecode,
        m_roundwinner:p_roundwinner
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_entry_set_roundwinner.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_entry_set_roundwinner = 
        {

        };
    return this;
}                   

// Reference to the request
var l_competition_entry_set_roundwinner = null;

// Reference to the action
var l_competition_entry_set_roundwinner_action = null;

// This is called on completion of a call to competition_entry_set_roundwinner
function oncomplete_competition_entry_set_roundwinner()
{
    alert("oncomplete_competition_entry_set_roundwinner");


    // Get response as object
    var l_obj = l_competition_entry_set_roundwinner.m_response.m_competition_entry_set_roundwinner;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_competition_entry_set_roundwinner_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_entry_set_roundwinner/status").text);

    // Get response as a single string
    alert(l_competition_entry_set_roundwinner_action.m_response_string);
}

// Create the request
l_competition_entry_set_roundwinner = new MetaWrap.XML.Action.WS.competition_entry_set_roundwinner
(
								
    'api_key',
    'votecode',
    'roundwinner'
);

// Create action
l_competition_entry_set_roundwinner_action = new MetaWrap.XML.Action(l_competition_entry_set_roundwinner,l_api_server + "/competition_entry_set_roundwinner");

// Call the action
if (!l_competition_entry_set_roundwinner_action.run(oncomplete_competition_entry_set_roundwinner))
{
    alert("There was an error calling 'competition_entry_set_roundwinner'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_entry_set_roundwinner
//

// JQuery GET request
    var dataString = 'api_key=api_key&votecode=votecode&roundwinner=roundwinner'
    $.get(
      l_api_server+'competition_entry_set_roundwinner',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_entry_set_roundwinner
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_entry_set_roundwinner version="V1.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<votecode>votecode</votecode>\n';
    dataString += '<roundwinner>roundwinner</roundwinner>\n';
    dataString += '</competition_entry_set_roundwinner></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_get_summary - V0.0 - ThumbWhere

Get a summary of the competition. Its url and its name value pair definitions.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_get_summary (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_get_summary = function(
	p_api_key,
	p_competition_id)
{
    this.m_action = {};
    this.m_action.m_competition_get_summary = 
    { 
        m_api_key:p_api_key,
        m_competition_id:p_competition_id
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_get_summary.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_get_summary = 
        {

        };
    return this;
}                   

// Reference to the request
var l_competition_get_summary = null;

// Reference to the action
var l_competition_get_summary_action = null;

// This is called on completion of a call to competition_get_summary
function oncomplete_competition_get_summary()
{
    alert("oncomplete_competition_get_summary");


    // Get response as object
    var l_obj = l_competition_get_summary.m_response.m_competition_get_summary;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_competition_get_summary_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_get_summary/status").text);

    // Get response as a single string
    alert(l_competition_get_summary_action.m_response_string);
}

// Create the request
l_competition_get_summary = new MetaWrap.XML.Action.WS.competition_get_summary
(
								
    'api_key',
    'competition_id'
);

// Create action
l_competition_get_summary_action = new MetaWrap.XML.Action(l_competition_get_summary,l_api_server + "/competition_get_summary");

// Call the action
if (!l_competition_get_summary_action.run(oncomplete_competition_get_summary))
{
    alert("There was an error calling 'competition_get_summary'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_get_summary
//

// JQuery GET request
    var dataString = 'api_key=api_key&competition_id=competition_id'
    $.get(
      l_api_server+'competition_get_summary',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_get_summary
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_get_summary version="V0.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<competition_id>competition_id</competition_id>\n';
    dataString += '</competition_get_summary></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_get_summary - V1.0 - ThumbWhere

Get a summary of the competition. Its url and its name value pair definitions.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_get_summary (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_get_summary = function(
	p_api_key,
	p_competition_id)
{
    this.m_action = {};
    this.m_action.m_competition_get_summary = 
    { 
        m_api_key:p_api_key,
        m_competition_id:p_competition_id
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_get_summary.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_get_summary = 
        {

        };
    return this;
}                   

// Reference to the request
var l_competition_get_summary = null;

// Reference to the action
var l_competition_get_summary_action = null;

// This is called on completion of a call to competition_get_summary
function oncomplete_competition_get_summary()
{
    alert("oncomplete_competition_get_summary");


    // Get response as object
    var l_obj = l_competition_get_summary.m_response.m_competition_get_summary;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_competition_get_summary_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_get_summary/status").text);

    // Get response as a single string
    alert(l_competition_get_summary_action.m_response_string);
}

// Create the request
l_competition_get_summary = new MetaWrap.XML.Action.WS.competition_get_summary
(
								
    'api_key',
    'competition_id'
);

// Create action
l_competition_get_summary_action = new MetaWrap.XML.Action(l_competition_get_summary,l_api_server + "/competition_get_summary");

// Call the action
if (!l_competition_get_summary_action.run(oncomplete_competition_get_summary))
{
    alert("There was an error calling 'competition_get_summary'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_get_summary
//

// JQuery GET request
    var dataString = 'api_key=api_key&competition_id=competition_id'
    $.get(
      l_api_server+'competition_get_summary',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_get_summary
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_get_summary version="V1.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<competition_id>competition_id</competition_id>\n';
    dataString += '</competition_get_summary></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_get_value - V0.0 - ThumbWhere

Returns the value from the name value pair collection for the competition specified by #key".

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_get_value (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_get_value = function(
	p_api_key,
	p_competition_id,
	p_name)
{
    this.m_action = {};
    this.m_action.m_competition_get_value = 
    { 
        m_api_key:p_api_key,
        m_competition_id:p_competition_id,
        m_name:p_name
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_get_value.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_get_value = 
        {

        };
    return this;
}                   

// Reference to the request
var l_competition_get_value = null;

// Reference to the action
var l_competition_get_value_action = null;

// This is called on completion of a call to competition_get_value
function oncomplete_competition_get_value()
{
    alert("oncomplete_competition_get_value");


    // Get response as object
    var l_obj = l_competition_get_value.m_response.m_competition_get_value;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_competition_get_value_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_get_value/status").text);

    // Get response as a single string
    alert(l_competition_get_value_action.m_response_string);
}

// Create the request
l_competition_get_value = new MetaWrap.XML.Action.WS.competition_get_value
(
								
    'api_key',
    'competition_id',
    'name'
);

// Create action
l_competition_get_value_action = new MetaWrap.XML.Action(l_competition_get_value,l_api_server + "/competition_get_value");

// Call the action
if (!l_competition_get_value_action.run(oncomplete_competition_get_value))
{
    alert("There was an error calling 'competition_get_value'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_get_value
//

// JQuery GET request
    var dataString = 'api_key=api_key&competition_id=competition_id&name=name'
    $.get(
      l_api_server+'competition_get_value',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_get_value
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_get_value version="V0.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<competition_id>competition_id</competition_id>\n';
    dataString += '<name>name</name>\n';
    dataString += '</competition_get_value></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_get_value - V1.0 - ThumbWhere

Returns the value from the name value pair collection for the competition specified by #key".

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_get_value (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_get_value = function(
	p_api_key,
	p_competition_id,
	p_name)
{
    this.m_action = {};
    this.m_action.m_competition_get_value = 
    { 
        m_api_key:p_api_key,
        m_competition_id:p_competition_id,
        m_name:p_name
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_get_value.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_get_value = 
        {

            m_encrypted:"",
            m_name:"",
            m_value:""
        };
    return this;
}                   

// Reference to the request
var l_competition_get_value = null;

// Reference to the action
var l_competition_get_value_action = null;

// This is called on completion of a call to competition_get_value
function oncomplete_competition_get_value()
{
    alert("oncomplete_competition_get_value");


    // Get response as object
    var l_obj = l_competition_get_value.m_response.m_competition_get_value;
    alert("'status' = " + l_obj.m_status);
    alert("'encrypted' = " + l_obj.m_encrypted);
    alert("'name' = " + l_obj.m_name);
    alert("'value' = " + l_obj.m_value);

    // Get response as XML
    var l_xml = l_competition_get_value_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_get_value/status").text);    
    alert("'encrypted' (from xml) = " +l_xml.selectSingleNode("response/competition_get_value/encrypted").text);    
    alert("'name' (from xml) = " +l_xml.selectSingleNode("response/competition_get_value/name").text);    
    alert("'value' (from xml) = " +l_xml.selectSingleNode("response/competition_get_value/value").text);

    // Get response as a single string
    alert(l_competition_get_value_action.m_response_string);
}

// Create the request
l_competition_get_value = new MetaWrap.XML.Action.WS.competition_get_value
(
								
    'api_key',
    'competition_id',
    'name'
);

// Create action
l_competition_get_value_action = new MetaWrap.XML.Action(l_competition_get_value,l_api_server + "/competition_get_value");

// Call the action
if (!l_competition_get_value_action.run(oncomplete_competition_get_value))
{
    alert("There was an error calling 'competition_get_value'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_get_value
//

// JQuery GET request
    var dataString = 'api_key=api_key&competition_id=competition_id&name=name'
    $.get(
      l_api_server+'competition_get_value',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_get_value
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_get_value version="V1.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<competition_id>competition_id</competition_id>\n';
    dataString += '<name>name</name>\n';
    dataString += '</competition_get_value></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_get_values - V0.0 - ThumbWhere

Returns the values from the name values pair for the competitions external application.

The competition must be a competition of the external application. The returned values is encrypted with the cruds encryption key.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_get_values (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_get_values = function(
	p_api_key,
	p_competition_id)
{
    this.m_action = {};
    this.m_action.m_competition_get_values = 
    { 
        m_api_key:p_api_key,
        m_competition_id:p_competition_id
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_get_values.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_get_values = 
        {

        };
    return this;
}                   

// Reference to the request
var l_competition_get_values = null;

// Reference to the action
var l_competition_get_values_action = null;

// This is called on completion of a call to competition_get_values
function oncomplete_competition_get_values()
{
    alert("oncomplete_competition_get_values");


    // Get response as object
    var l_obj = l_competition_get_values.m_response.m_competition_get_values;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_competition_get_values_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_get_values/status").text);

    // Get response as a single string
    alert(l_competition_get_values_action.m_response_string);
}

// Create the request
l_competition_get_values = new MetaWrap.XML.Action.WS.competition_get_values
(
								
    'api_key',
    'competition_id'
);

// Create action
l_competition_get_values_action = new MetaWrap.XML.Action(l_competition_get_values,l_api_server + "/competition_get_values");

// Call the action
if (!l_competition_get_values_action.run(oncomplete_competition_get_values))
{
    alert("There was an error calling 'competition_get_values'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_get_values
//

// JQuery GET request
    var dataString = 'api_key=api_key&competition_id=competition_id'
    $.get(
      l_api_server+'competition_get_values',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_get_values
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_get_values version="V0.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<competition_id>competition_id</competition_id>\n';
    dataString += '</competition_get_values></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_get_values - V1.0 - ThumbWhere

Returns the values from the name values pair for the competitions external application.

The competition must be a competition of the external application. The returned values is encrypted with the cruds encryption key.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_get_values (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_get_values = function(
	p_api_key,
	p_competition_id)
{
    this.m_action = {};
    this.m_action.m_competition_get_values = 
    { 
        m_api_key:p_api_key,
        m_competition_id:p_competition_id
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_get_values.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_get_values = 
        {

        };
    return this;
}                   

// Reference to the request
var l_competition_get_values = null;

// Reference to the action
var l_competition_get_values_action = null;

// This is called on completion of a call to competition_get_values
function oncomplete_competition_get_values()
{
    alert("oncomplete_competition_get_values");


    // Get response as object
    var l_obj = l_competition_get_values.m_response.m_competition_get_values;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_competition_get_values_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_get_values/status").text);

    // Get response as a single string
    alert(l_competition_get_values_action.m_response_string);
}

// Create the request
l_competition_get_values = new MetaWrap.XML.Action.WS.competition_get_values
(
								
    'api_key',
    'competition_id'
);

// Create action
l_competition_get_values_action = new MetaWrap.XML.Action(l_competition_get_values,l_api_server + "/competition_get_values");

// Call the action
if (!l_competition_get_values_action.run(oncomplete_competition_get_values))
{
    alert("There was an error calling 'competition_get_values'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_get_values
//

// JQuery GET request
    var dataString = 'api_key=api_key&competition_id=competition_id'
    $.get(
      l_api_server+'competition_get_values',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_get_values
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_get_values version="V1.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<competition_id>competition_id</competition_id>\n';
    dataString += '</competition_get_values></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_set_value - V0.0 - ThumbWhere

Sets the value of the name value pair for a competition.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_set_value (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_set_value = function(
	p_api_key,
	p_competition_id,
	p_name,
	p_value)
{
    this.m_action = {};
    this.m_action.m_competition_set_value = 
    { 
        m_api_key:p_api_key,
        m_competition_id:p_competition_id,
        m_name:p_name,
        m_value:p_value
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_set_value.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_set_value = 
        {

        };
    return this;
}                   

// Reference to the request
var l_competition_set_value = null;

// Reference to the action
var l_competition_set_value_action = null;

// This is called on completion of a call to competition_set_value
function oncomplete_competition_set_value()
{
    alert("oncomplete_competition_set_value");


    // Get response as object
    var l_obj = l_competition_set_value.m_response.m_competition_set_value;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_competition_set_value_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_set_value/status").text);

    // Get response as a single string
    alert(l_competition_set_value_action.m_response_string);
}

// Create the request
l_competition_set_value = new MetaWrap.XML.Action.WS.competition_set_value
(
								
    'api_key',
    'competition_id',
    'name',
    'value'
);

// Create action
l_competition_set_value_action = new MetaWrap.XML.Action(l_competition_set_value,l_api_server + "/competition_set_value");

// Call the action
if (!l_competition_set_value_action.run(oncomplete_competition_set_value))
{
    alert("There was an error calling 'competition_set_value'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_set_value
//

// JQuery GET request
    var dataString = 'api_key=api_key&competition_id=competition_id&name=name&value=value'
    $.get(
      l_api_server+'competition_set_value',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_set_value
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_set_value version="V0.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<competition_id>competition_id</competition_id>\n';
    dataString += '<name>name</name>\n';
    dataString += '<value>value</value>\n';
    dataString += '</competition_set_value></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_set_value - V1.0 - ThumbWhere

Sets the value of the name value pair for a competition.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_set_value (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_set_value = function(
	p_api_key,
	p_competition_id,
	p_name,
	p_value)
{
    this.m_action = {};
    this.m_action.m_competition_set_value = 
    { 
        m_api_key:p_api_key,
        m_competition_id:p_competition_id,
        m_name:p_name,
        m_value:p_value
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_set_value.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_set_value = 
        {

        };
    return this;
}                   

// Reference to the request
var l_competition_set_value = null;

// Reference to the action
var l_competition_set_value_action = null;

// This is called on completion of a call to competition_set_value
function oncomplete_competition_set_value()
{
    alert("oncomplete_competition_set_value");


    // Get response as object
    var l_obj = l_competition_set_value.m_response.m_competition_set_value;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_competition_set_value_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_set_value/status").text);

    // Get response as a single string
    alert(l_competition_set_value_action.m_response_string);
}

// Create the request
l_competition_set_value = new MetaWrap.XML.Action.WS.competition_set_value
(
								
    'api_key',
    'competition_id',
    'name',
    'value'
);

// Create action
l_competition_set_value_action = new MetaWrap.XML.Action(l_competition_set_value,l_api_server + "/competition_set_value");

// Call the action
if (!l_competition_set_value_action.run(oncomplete_competition_set_value))
{
    alert("There was an error calling 'competition_set_value'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_set_value
//

// JQuery GET request
    var dataString = 'api_key=api_key&competition_id=competition_id&name=name&value=value'
    $.get(
      l_api_server+'competition_set_value',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_set_value
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_set_value version="V1.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<competition_id>competition_id</competition_id>\n';
    dataString += '<name>name</name>\n';
    dataString += '<value>value</value>\n';
    dataString += '</competition_set_value></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_set_values - V0.0 - ThumbWhere

Sets the values of the name values pair for an competition who is a competition of an external application.

Values are provided as elements. The competition must be a competition of the external application.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_set_values (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_set_values = function(
	p_api_key,
	p_competition_id)
{
    this.m_action = {};
    this.m_action.m_competition_set_values = 
    { 
        m_api_key:p_api_key,
        m_competition_id:p_competition_id
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_set_values.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_set_values = 
        {

        };
    return this;
}                   

// Reference to the request
var l_competition_set_values = null;

// Reference to the action
var l_competition_set_values_action = null;

// This is called on completion of a call to competition_set_values
function oncomplete_competition_set_values()
{
    alert("oncomplete_competition_set_values");


    // Get response as object
    var l_obj = l_competition_set_values.m_response.m_competition_set_values;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_competition_set_values_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_set_values/status").text);

    // Get response as a single string
    alert(l_competition_set_values_action.m_response_string);
}

// Create the request
l_competition_set_values = new MetaWrap.XML.Action.WS.competition_set_values
(
								
    'api_key',
    'competition_id'
);

// Create action
l_competition_set_values_action = new MetaWrap.XML.Action(l_competition_set_values,l_api_server + "/competition_set_values");

// Call the action
if (!l_competition_set_values_action.run(oncomplete_competition_set_values))
{
    alert("There was an error calling 'competition_set_values'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_set_values
//

// JQuery GET request
    var dataString = 'api_key=api_key&competition_id=competition_id'
    $.get(
      l_api_server+'competition_set_values',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_set_values
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_set_values version="V0.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<competition_id>competition_id</competition_id>\n';
    dataString += '</competition_set_values></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_set_values - V1.0 - ThumbWhere

Sets the values of the name values pair for an competition who is a competition of an external application.

Values are provided as elements. The competition must be a competition of the external application.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_set_values (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_set_values = function(
	p_api_key,
	p_competition_id)
{
    this.m_action = {};
    this.m_action.m_competition_set_values = 
    { 
        m_api_key:p_api_key,
        m_competition_id:p_competition_id
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_set_values.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_set_values = 
        {

        };
    return this;
}                   

// Reference to the request
var l_competition_set_values = null;

// Reference to the action
var l_competition_set_values_action = null;

// This is called on completion of a call to competition_set_values
function oncomplete_competition_set_values()
{
    alert("oncomplete_competition_set_values");


    // Get response as object
    var l_obj = l_competition_set_values.m_response.m_competition_set_values;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_competition_set_values_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_set_values/status").text);

    // Get response as a single string
    alert(l_competition_set_values_action.m_response_string);
}

// Create the request
l_competition_set_values = new MetaWrap.XML.Action.WS.competition_set_values
(
								
    'api_key',
    'competition_id'
);

// Create action
l_competition_set_values_action = new MetaWrap.XML.Action(l_competition_set_values,l_api_server + "/competition_set_values");

// Call the action
if (!l_competition_set_values_action.run(oncomplete_competition_set_values))
{
    alert("There was an error calling 'competition_set_values'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_set_values
//

// JQuery GET request
    var dataString = 'api_key=api_key&competition_id=competition_id'
    $.get(
      l_api_server+'competition_set_values',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_set_values
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_set_values version="V1.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<competition_id>competition_id</competition_id>\n';
    dataString += '</competition_set_values></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_update_round - V0.0 - ThumbWhere

Update an existing round for a competition.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_update_round (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_update_round = function(
	p_api_key,
	p_competition_id,
	p_round_id,
	p_name,
	p_description,
	p_submit_start,
	p_submit_end,
	p_vote_start,
	p_vote_end,
	p_vote_confirm_start,
	p_vote_confirm_end)
{
    this.m_action = {};
    this.m_action.m_competition_update_round = 
    { 
        m_api_key:p_api_key,
        m_competition_id:p_competition_id,
        m_round_id:p_round_id,
        m_name:p_name,
        m_description:p_description,
        m_submit_start:p_submit_start,
        m_submit_end:p_submit_end,
        m_vote_start:p_vote_start,
        m_vote_end:p_vote_end,
        m_vote_confirm_start:p_vote_confirm_start,
        m_vote_confirm_end:p_vote_confirm_end
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_update_round.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_update_round = 
        {

        };
    return this;
}                   

// Reference to the request
var l_competition_update_round = null;

// Reference to the action
var l_competition_update_round_action = null;

// This is called on completion of a call to competition_update_round
function oncomplete_competition_update_round()
{
    alert("oncomplete_competition_update_round");


    // Get response as object
    var l_obj = l_competition_update_round.m_response.m_competition_update_round;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_competition_update_round_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_update_round/status").text);

    // Get response as a single string
    alert(l_competition_update_round_action.m_response_string);
}

// Create the request
l_competition_update_round = new MetaWrap.XML.Action.WS.competition_update_round
(
								
    'api_key',
    'competition_id',
    'round_id',
    'name',
    'description',
    'submit_start',
    'submit_end',
    'vote_start',
    'vote_end',
    'vote_confirm_start',
    'vote_confirm_end'
);

// Create action
l_competition_update_round_action = new MetaWrap.XML.Action(l_competition_update_round,l_api_server + "/competition_update_round");

// Call the action
if (!l_competition_update_round_action.run(oncomplete_competition_update_round))
{
    alert("There was an error calling 'competition_update_round'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_update_round
//

// JQuery GET request
    var dataString = 'api_key=api_key&competition_id=competition_id&round_id=round_id&name=name&description=description&submit_start=submit_start&submit_end=submit_end&vote_start=vote_start&vote_end=vote_end&vote_confirm_start=vote_confirm_start&vote_confirm_end=vote_confirm_end'
    $.get(
      l_api_server+'competition_update_round',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_update_round
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_update_round version="V0.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<competition_id>competition_id</competition_id>\n';
    dataString += '<round_id>round_id</round_id>\n';
    dataString += '<name>name</name>\n';
    dataString += '<description>description</description>\n';
    dataString += '<submit_start>submit_start</submit_start>\n';
    dataString += '<submit_end>submit_end</submit_end>\n';
    dataString += '<vote_start>vote_start</vote_start>\n';
    dataString += '<vote_end>vote_end</vote_end>\n';
    dataString += '<vote_confirm_start>vote_confirm_start</vote_confirm_start>\n';
    dataString += '<vote_confirm_end>vote_confirm_end</vote_confirm_end>\n';
    dataString += '</competition_update_round></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_update_round - V1.0 - ThumbWhere

Update an existing round for a competition.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_update_round (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_update_round = function(
	p_api_key,
	p_competition_id,
	p_round_id,
	p_name,
	p_description,
	p_submit_start,
	p_submit_end,
	p_vote_start,
	p_vote_end,
	p_vote_confirm_start,
	p_vote_confirm_end)
{
    this.m_action = {};
    this.m_action.m_competition_update_round = 
    { 
        m_api_key:p_api_key,
        m_competition_id:p_competition_id,
        m_round_id:p_round_id,
        m_name:p_name,
        m_description:p_description,
        m_submit_start:p_submit_start,
        m_submit_end:p_submit_end,
        m_vote_start:p_vote_start,
        m_vote_end:p_vote_end,
        m_vote_confirm_start:p_vote_confirm_start,
        m_vote_confirm_end:p_vote_confirm_end
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_update_round.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_update_round = 
        {

        };
    return this;
}                   

// Reference to the request
var l_competition_update_round = null;

// Reference to the action
var l_competition_update_round_action = null;

// This is called on completion of a call to competition_update_round
function oncomplete_competition_update_round()
{
    alert("oncomplete_competition_update_round");


    // Get response as object
    var l_obj = l_competition_update_round.m_response.m_competition_update_round;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_competition_update_round_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_update_round/status").text);

    // Get response as a single string
    alert(l_competition_update_round_action.m_response_string);
}

// Create the request
l_competition_update_round = new MetaWrap.XML.Action.WS.competition_update_round
(
								
    'api_key',
    'competition_id',
    'round_id',
    'name',
    'description',
    'submit_start',
    'submit_end',
    'vote_start',
    'vote_end',
    'vote_confirm_start',
    'vote_confirm_end'
);

// Create action
l_competition_update_round_action = new MetaWrap.XML.Action(l_competition_update_round,l_api_server + "/competition_update_round");

// Call the action
if (!l_competition_update_round_action.run(oncomplete_competition_update_round))
{
    alert("There was an error calling 'competition_update_round'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_update_round
//

// JQuery GET request
    var dataString = 'api_key=api_key&competition_id=competition_id&round_id=round_id&name=name&description=description&submit_start=submit_start&submit_end=submit_end&vote_start=vote_start&vote_end=vote_end&vote_confirm_start=vote_confirm_start&vote_confirm_end=vote_confirm_end'
    $.get(
      l_api_server+'competition_update_round',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_update_round
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_update_round version="V1.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<competition_id>competition_id</competition_id>\n';
    dataString += '<round_id>round_id</round_id>\n';
    dataString += '<name>name</name>\n';
    dataString += '<description>description</description>\n';
    dataString += '<submit_start>submit_start</submit_start>\n';
    dataString += '<submit_end>submit_end</submit_end>\n';
    dataString += '<vote_start>vote_start</vote_start>\n';
    dataString += '<vote_end>vote_end</vote_end>\n';
    dataString += '<vote_confirm_start>vote_confirm_start</vote_confirm_start>\n';
    dataString += '<vote_confirm_end>vote_confirm_end</vote_confirm_end>\n';
    dataString += '</competition_update_round></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_vote - V0.0 - ThumbWhere

Votes for an entry in a competition.

This creates a pending vote for an entry in a competition. A code is returned. The vote will not be counted unless it is confirmed by a call to ^competition_vote_confirm^.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_vote (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_vote = function(
	p_api_key,
	p_api_member_token,
	p_code)
{
    this.m_action = {};
    this.m_action.m_competition_vote = 
    { 
        m_api_key:p_api_key,
        m_api_member_token:p_api_member_token,
        m_code:p_code
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_vote.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_vote = 
        {

        };
    return this;
}                   

// Reference to the request
var l_competition_vote = null;

// Reference to the action
var l_competition_vote_action = null;

// This is called on completion of a call to competition_vote
function oncomplete_competition_vote()
{
    alert("oncomplete_competition_vote");


    // Get response as object
    var l_obj = l_competition_vote.m_response.m_competition_vote;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_competition_vote_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_vote/status").text);

    // Get response as a single string
    alert(l_competition_vote_action.m_response_string);
}

// Create the request
l_competition_vote = new MetaWrap.XML.Action.WS.competition_vote
(
								
    'api_key',
    'api_member_token',
    'code'
);

// Create action
l_competition_vote_action = new MetaWrap.XML.Action(l_competition_vote,l_api_server + "/competition_vote");

// Call the action
if (!l_competition_vote_action.run(oncomplete_competition_vote))
{
    alert("There was an error calling 'competition_vote'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_vote
//

// JQuery GET request
    var dataString = 'api_key=api_key&api_member_token=api_member_token&code=code'
    $.get(
      l_api_server+'competition_vote',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_vote
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_vote version="V0.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<api_member_token>api_member_token</api_member_token>\n';
    dataString += '<code>code</code>\n';
    dataString += '</competition_vote></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_vote - V1.0 - ThumbWhere

Votes for an entry in a competition.

This creates a pending vote for an entry in a competition. A code is returned. The vote will not be counted unless it is confirmed by a call to ^competition_vote_confirm^.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_vote (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_vote = function(
	p_api_key,
	p_api_member_token,
	p_code)
{
    this.m_action = {};
    this.m_action.m_competition_vote = 
    { 
        m_api_key:p_api_key,
        m_api_member_token:p_api_member_token,
        m_code:p_code
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_vote.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_vote = 
        {

        };
    return this;
}                   

// Reference to the request
var l_competition_vote = null;

// Reference to the action
var l_competition_vote_action = null;

// This is called on completion of a call to competition_vote
function oncomplete_competition_vote()
{
    alert("oncomplete_competition_vote");


    // Get response as object
    var l_obj = l_competition_vote.m_response.m_competition_vote;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_competition_vote_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_vote/status").text);

    // Get response as a single string
    alert(l_competition_vote_action.m_response_string);
}

// Create the request
l_competition_vote = new MetaWrap.XML.Action.WS.competition_vote
(
								
    'api_key',
    'api_member_token',
    'code'
);

// Create action
l_competition_vote_action = new MetaWrap.XML.Action(l_competition_vote,l_api_server + "/competition_vote");

// Call the action
if (!l_competition_vote_action.run(oncomplete_competition_vote))
{
    alert("There was an error calling 'competition_vote'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_vote
//

// JQuery GET request
    var dataString = 'api_key=api_key&api_member_token=api_member_token&code=code'
    $.get(
      l_api_server+'competition_vote',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_vote
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_vote version="V1.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<api_member_token>api_member_token</api_member_token>\n';
    dataString += '<code>code</code>\n';
    dataString += '</competition_vote></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_vote_confirm - V0.0 - ThumbWhere

Confirms a vote on an entry in a competition.

This is normally used via SMS or via an email form as a way og making sure that the vote was made from a real email address or mobile phone.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_vote_confirm (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_vote_confirm = function(
	p_api_key,
	p_vote_confirmation_code)
{
    this.m_action = {};
    this.m_action.m_competition_vote_confirm = 
    { 
        m_api_key:p_api_key,
        m_vote_confirmation_code:p_vote_confirmation_code
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_vote_confirm.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_vote_confirm = 
        {

        };
    return this;
}                   

// Reference to the request
var l_competition_vote_confirm = null;

// Reference to the action
var l_competition_vote_confirm_action = null;

// This is called on completion of a call to competition_vote_confirm
function oncomplete_competition_vote_confirm()
{
    alert("oncomplete_competition_vote_confirm");


    // Get response as object
    var l_obj = l_competition_vote_confirm.m_response.m_competition_vote_confirm;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_competition_vote_confirm_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_vote_confirm/status").text);

    // Get response as a single string
    alert(l_competition_vote_confirm_action.m_response_string);
}

// Create the request
l_competition_vote_confirm = new MetaWrap.XML.Action.WS.competition_vote_confirm
(
								
    'api_key',
    'vote_confirmation_code'
);

// Create action
l_competition_vote_confirm_action = new MetaWrap.XML.Action(l_competition_vote_confirm,l_api_server + "/competition_vote_confirm");

// Call the action
if (!l_competition_vote_confirm_action.run(oncomplete_competition_vote_confirm))
{
    alert("There was an error calling 'competition_vote_confirm'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_vote_confirm
//

// JQuery GET request
    var dataString = 'api_key=api_key&vote_confirmation_code=vote_confirmation_code'
    $.get(
      l_api_server+'competition_vote_confirm',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_vote_confirm
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_vote_confirm version="V0.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<vote_confirmation_code>vote_confirmation_code</vote_confirmation_code>\n';
    dataString += '</competition_vote_confirm></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

competition_vote_confirm - V1.0 - ThumbWhere

Confirms a vote on an entry in a competition.

This is normally used via SMS or via an email form as a way og making sure that the vote was made from a real email address or mobile phone.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_vote_confirm (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.competition_vote_confirm = function(
	p_api_key,
	p_vote_confirmation_code)
{
    this.m_action = {};
    this.m_action.m_competition_vote_confirm = 
    { 
        m_api_key:p_api_key,
        m_vote_confirmation_code:p_vote_confirmation_code
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.competition_vote_confirm.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_competition_vote_confirm = 
        {

        };
    return this;
}                   

// Reference to the request
var l_competition_vote_confirm = null;

// Reference to the action
var l_competition_vote_confirm_action = null;

// This is called on completion of a call to competition_vote_confirm
function oncomplete_competition_vote_confirm()
{
    alert("oncomplete_competition_vote_confirm");


    // Get response as object
    var l_obj = l_competition_vote_confirm.m_response.m_competition_vote_confirm;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_competition_vote_confirm_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/competition_vote_confirm/status").text);

    // Get response as a single string
    alert(l_competition_vote_confirm_action.m_response_string);
}

// Create the request
l_competition_vote_confirm = new MetaWrap.XML.Action.WS.competition_vote_confirm
(
								
    'api_key',
    'vote_confirmation_code'
);

// Create action
l_competition_vote_confirm_action = new MetaWrap.XML.Action(l_competition_vote_confirm,l_api_server + "/competition_vote_confirm");

// Call the action
if (!l_competition_vote_confirm_action.run(oncomplete_competition_vote_confirm))
{
    alert("There was an error calling 'competition_vote_confirm'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for competition_vote_confirm
//

// JQuery GET request
    var dataString = 'api_key=api_key&vote_confirmation_code=vote_confirmation_code'
    $.get(
      l_api_server+'competition_vote_confirm',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for competition_vote_confirm
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<competition_vote_confirm version="V1.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<vote_confirmation_code>vote_confirmation_code</vote_confirmation_code>\n';
    dataString += '</competition_vote_confirm></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

consume_mediaitem - V1.1 - Content

Add some consumption

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for consume_mediaitem (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.consume_mediaitem = function(
	p_key,
	p_member,
	p_mediaitem,
	p_documentation)
{
    this.m_action = {};
    this.m_action.m_consume_mediaitem = 
    { 
        m_key:p_key,
        m_member:p_member,
        m_mediaitem:p_mediaitem,
        m_documentation:p_documentation
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.consume_mediaitem.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_consume_mediaitem = 
        {

        };
    return this;
}                   

// Reference to the request
var l_consume_mediaitem = null;

// Reference to the action
var l_consume_mediaitem_action = null;

// This is called on completion of a call to consume_mediaitem
function oncomplete_consume_mediaitem()
{
    alert("oncomplete_consume_mediaitem");


    // Get response as object
    var l_obj = l_consume_mediaitem.m_response.m_consume_mediaitem;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_consume_mediaitem_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/consume_mediaitem/status").text);

    // Get response as a single string
    alert(l_consume_mediaitem_action.m_response_string);
}

// Create the request
l_consume_mediaitem = new MetaWrap.XML.Action.WS.consume_mediaitem
(
								
    'key',
    'member',
    'mediaitem',
    'documentation'
);

// Create action
l_consume_mediaitem_action = new MetaWrap.XML.Action(l_consume_mediaitem,l_api_server + "/consume_mediaitem");

// Call the action
if (!l_consume_mediaitem_action.run(oncomplete_consume_mediaitem))
{
    alert("There was an error calling 'consume_mediaitem'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for consume_mediaitem
//

// JQuery GET request
    var dataString = 'key=key&member=member&mediaitem=mediaitem&documentation=documentation'
    $.get(
      l_api_server+'consume_mediaitem',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for consume_mediaitem
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<consume_mediaitem version="V1.1" service="Content">\n';
    dataString += '<key>key</key>\n';
    dataString += '<member>member</member>\n';
    dataString += '<mediaitem>mediaitem</mediaitem>\n';
    dataString += '<documentation>documentation</documentation>\n';
    dataString += '</consume_mediaitem></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

create - V1.1 - Member

Creates a create member.

Creates a create member if one is not supplied.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for create (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.create = function(
	p_key,
	p_id,
	p_secret,
	p_email)
{
    this.m_action = {};
    this.m_action.m_create = 
    { 
        m_key:p_key,
        m_id:p_id,
        m_secret:p_secret,
        m_email:p_email
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.create.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_create = 
        {

        };
    return this;
}                   

// Reference to the request
var l_create = null;

// Reference to the action
var l_create_action = null;

// This is called on completion of a call to create
function oncomplete_create()
{
    alert("oncomplete_create");


    // Get response as object
    var l_obj = l_create.m_response.m_create;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_create_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/create/status").text);

    // Get response as a single string
    alert(l_create_action.m_response_string);
}

// Create the request
l_create = new MetaWrap.XML.Action.WS.create
(
								
    'key',
    'id',
    'secret',
    'email'
);

// Create action
l_create_action = new MetaWrap.XML.Action(l_create,l_api_server + "/create");

// Call the action
if (!l_create_action.run(oncomplete_create))
{
    alert("There was an error calling 'create'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for create
//

// JQuery GET request
    var dataString = 'key=key&id=id&secret=secret&email=email'
    $.get(
      l_api_server+'create',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for create
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<create version="V1.1" service="Member">\n';
    dataString += '<key>key</key>\n';
    dataString += '<id>id</id>\n';
    dataString += '<secret>secret</secret>\n';
    dataString += '<email>email</email>\n';
    dataString += '</create></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

deploy - V1.1 - Media

This will deploy the media for the mediaitem.

This will deploy all the media and then if the standard workflow is in use, deploy the media to storage.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for deploy (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.deploy = function(
	p_key,
	p_mediaitem)
{
    this.m_action = {};
    this.m_action.m_deploy = 
    { 
        m_key:p_key,
        m_mediaitem:p_mediaitem
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.deploy.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_deploy = 
        {

        };
    return this;
}                   

// Reference to the request
var l_deploy = null;

// Reference to the action
var l_deploy_action = null;

// This is called on completion of a call to deploy
function oncomplete_deploy()
{
    alert("oncomplete_deploy");


    // Get response as object
    var l_obj = l_deploy.m_response.m_deploy;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_deploy_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/deploy/status").text);

    // Get response as a single string
    alert(l_deploy_action.m_response_string);
}

// Create the request
l_deploy = new MetaWrap.XML.Action.WS.deploy
(
								
    'key',
    'mediaitem'
);

// Create action
l_deploy_action = new MetaWrap.XML.Action(l_deploy,l_api_server + "/deploy");

// Call the action
if (!l_deploy_action.run(oncomplete_deploy))
{
    alert("There was an error calling 'deploy'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for deploy
//

// JQuery GET request
    var dataString = 'key=key&mediaitem=mediaitem'
    $.get(
      l_api_server+'deploy',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for deploy
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<deploy version="V1.1" service="Media">\n';
    dataString += '<key>key</key>\n';
    dataString += '<mediaitem>mediaitem</mediaitem>\n';
    dataString += '</deploy></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

fingerprint - V1.1 - Media

Fingerprints the #mediaitem#

Takes a mediaitem and fingerprints it.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for fingerprint (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.fingerprint = function(
	p_key,
	p_mediaitem)
{
    this.m_action = {};
    this.m_action.m_fingerprint = 
    { 
        m_key:p_key,
        m_mediaitem:p_mediaitem
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.fingerprint.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_fingerprint = 
        {

        };
    return this;
}                   

// Reference to the request
var l_fingerprint = null;

// Reference to the action
var l_fingerprint_action = null;

// This is called on completion of a call to fingerprint
function oncomplete_fingerprint()
{
    alert("oncomplete_fingerprint");


    // Get response as object
    var l_obj = l_fingerprint.m_response.m_fingerprint;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_fingerprint_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/fingerprint/status").text);

    // Get response as a single string
    alert(l_fingerprint_action.m_response_string);
}

// Create the request
l_fingerprint = new MetaWrap.XML.Action.WS.fingerprint
(
								
    'key',
    'mediaitem'
);

// Create action
l_fingerprint_action = new MetaWrap.XML.Action(l_fingerprint,l_api_server + "/fingerprint");

// Call the action
if (!l_fingerprint_action.run(oncomplete_fingerprint))
{
    alert("There was an error calling 'fingerprint'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for fingerprint
//

// JQuery GET request
    var dataString = 'key=key&mediaitem=mediaitem'
    $.get(
      l_api_server+'fingerprint',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for fingerprint
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<fingerprint version="V1.1" service="Media">\n';
    dataString += '<key>key</key>\n';
    dataString += '<mediaitem>mediaitem</mediaitem>\n';
    dataString += '</fingerprint></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

generate - V1.1 - Media

This will generate the media for the mediaitem.

This will generate all the media and then if the standard workflow is in use, deploy the media to storage.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for generate (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.generate = function(
	p_key,
	p_mediaitem)
{
    this.m_action = {};
    this.m_action.m_generate = 
    { 
        m_key:p_key,
        m_mediaitem:p_mediaitem
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.generate.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_generate = 
        {

        };
    return this;
}                   

// Reference to the request
var l_generate = null;

// Reference to the action
var l_generate_action = null;

// This is called on completion of a call to generate
function oncomplete_generate()
{
    alert("oncomplete_generate");


    // Get response as object
    var l_obj = l_generate.m_response.m_generate;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_generate_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/generate/status").text);

    // Get response as a single string
    alert(l_generate_action.m_response_string);
}

// Create the request
l_generate = new MetaWrap.XML.Action.WS.generate
(
								
    'key',
    'mediaitem'
);

// Create action
l_generate_action = new MetaWrap.XML.Action(l_generate,l_api_server + "/generate");

// Call the action
if (!l_generate_action.run(oncomplete_generate))
{
    alert("There was an error calling 'generate'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for generate
//

// JQuery GET request
    var dataString = 'key=key&mediaitem=mediaitem'
    $.get(
      l_api_server+'generate',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for generate
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<generate version="V1.1" service="Media">\n';
    dataString += '<key>key</key>\n';
    dataString += '<mediaitem>mediaitem</mediaitem>\n';
    dataString += '</generate></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

get_url - V1.1 - Media

Returns the URL for the specified #mediaitem#

This function is in for convenience. It is possible to calculate the url for a media item, but this a simple way to have the API calculate it for you. From the campaign xml, grab the campaign/details/core_rooturl value eg http://core.thumbwhere.com/ Then take the mediaitem id and split it up so that there is a / between each digit. So 100 becomes 1/0/0 and 23 becomes 2/3. 7 would just be 7. For this example we will use 1/2/3 Then take the mediaitem and put a / at the start of it and add a .xml onto the end of it. eg /123.xml If you add all these together you end up with http://core.thumbwhere.com/1/2/3/123.xml The folder structure is done this way so that ThumbWhere can serve content from dumb (scriptless) storage systems without ending up with thousands of files in the one directory.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for get_url (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.get_url = function(
	p_key,
	p_mediaitem,
	p_redirect)
{
    this.m_action = {};
    this.m_action.m_get_url = 
    { 
        m_key:p_key,
        m_mediaitem:p_mediaitem,
        m_redirect:p_redirect
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.get_url.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_get_url = 
        {

        };
    return this;
}                   

// Reference to the request
var l_get_url = null;

// Reference to the action
var l_get_url_action = null;

// This is called on completion of a call to get_url
function oncomplete_get_url()
{
    alert("oncomplete_get_url");


    // Get response as object
    var l_obj = l_get_url.m_response.m_get_url;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_get_url_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/get_url/status").text);

    // Get response as a single string
    alert(l_get_url_action.m_response_string);
}

// Create the request
l_get_url = new MetaWrap.XML.Action.WS.get_url
(
								
    'key',
    'mediaitem',
    'redirect'
);

// Create action
l_get_url_action = new MetaWrap.XML.Action(l_get_url,l_api_server + "/get_url");

// Call the action
if (!l_get_url_action.run(oncomplete_get_url))
{
    alert("There was an error calling 'get_url'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for get_url
//

// JQuery GET request
    var dataString = 'key=key&mediaitem=mediaitem&redirect=redirect'
    $.get(
      l_api_server+'get_url',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for get_url
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<get_url version="V1.1" service="Media">\n';
    dataString += '<key>key</key>\n';
    dataString += '<mediaitem>mediaitem</mediaitem>\n';
    dataString += '<redirect>redirect</redirect>\n';
    dataString += '</get_url></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

info - V1.1 - Identity

Query account info.

Returns member info.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for info (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.info = function(
	p_key,
	p_member)
{
    this.m_action = {};
    this.m_action.m_info = 
    { 
        m_key:p_key,
        m_member:p_member
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.info.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_info = 
        {

        };
    return this;
}                   

// Reference to the request
var l_info = null;

// Reference to the action
var l_info_action = null;

// This is called on completion of a call to info
function oncomplete_info()
{
    alert("oncomplete_info");


    // Get response as object
    var l_obj = l_info.m_response.m_info;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_info_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/info/status").text);

    // Get response as a single string
    alert(l_info_action.m_response_string);
}

// Create the request
l_info = new MetaWrap.XML.Action.WS.info
(
								
    'key',
    'member'
);

// Create action
l_info_action = new MetaWrap.XML.Action(l_info,l_api_server + "/info");

// Call the action
if (!l_info_action.run(oncomplete_info))
{
    alert("There was an error calling 'info'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for info
//

// JQuery GET request
    var dataString = 'key=key&member=member'
    $.get(
      l_api_server+'info',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for info
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<info version="V1.1" service="Identity">\n';
    dataString += '<key>key</key>\n';
    dataString += '<member>member</member>\n';
    dataString += '</info></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

info - V1.1 - Member

Returns information about a member

Creates a create member if one is not supplied.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for info (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.info = function(
	p_key,
	p_member)
{
    this.m_action = {};
    this.m_action.m_info = 
    { 
        m_key:p_key,
        m_member:p_member
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.info.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_info = 
        {

        };
    return this;
}                   

// Reference to the request
var l_info = null;

// Reference to the action
var l_info_action = null;

// This is called on completion of a call to info
function oncomplete_info()
{
    alert("oncomplete_info");


    // Get response as object
    var l_obj = l_info.m_response.m_info;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_info_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/info/status").text);

    // Get response as a single string
    alert(l_info_action.m_response_string);
}

// Create the request
l_info = new MetaWrap.XML.Action.WS.info
(
								
    'key',
    'member'
);

// Create action
l_info_action = new MetaWrap.XML.Action(l_info,l_api_server + "/info");

// Call the action
if (!l_info_action.run(oncomplete_info))
{
    alert("There was an error calling 'info'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for info
//

// JQuery GET request
    var dataString = 'key=key&member=member'
    $.get(
      l_api_server+'info',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for info
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<info version="V1.1" service="Member">\n';
    dataString += '<key>key</key>\n';
    dataString += '<member>member</member>\n';
    dataString += '</info></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

ingest - V1.1 - Content

Ingests media.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for ingest (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.ingest = function(
	p_key,
	p_name,
	p_member,
	p_identity,
	p_consumer,
	p_producer,
	p_content,
	p_url)
{
    this.m_action = {};
    this.m_action.m_ingest = 
    { 
        m_key:p_key,
        m_name:p_name,
        m_member:p_member,
        m_identity:p_identity,
        m_consumer:p_consumer,
        m_producer:p_producer,
        m_content:p_content,
        m_url:p_url
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.ingest.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_ingest = 
        {

        };
    return this;
}                   

// Reference to the request
var l_ingest = null;

// Reference to the action
var l_ingest_action = null;

// This is called on completion of a call to ingest
function oncomplete_ingest()
{
    alert("oncomplete_ingest");


    // Get response as object
    var l_obj = l_ingest.m_response.m_ingest;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_ingest_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/ingest/status").text);

    // Get response as a single string
    alert(l_ingest_action.m_response_string);
}

// Create the request
l_ingest = new MetaWrap.XML.Action.WS.ingest
(
								
    'key',
    'name',
    'member',
    'identity',
    'consumer',
    'producer',
    'content',
    'url'
);

// Create action
l_ingest_action = new MetaWrap.XML.Action(l_ingest,l_api_server + "/ingest");

// Call the action
if (!l_ingest_action.run(oncomplete_ingest))
{
    alert("There was an error calling 'ingest'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for ingest
//

// JQuery GET request
    var dataString = 'key=key&name=name&member=member&identity=identity&consumer=consumer&producer=producer&content=content&url=url'
    $.get(
      l_api_server+'ingest',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for ingest
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<ingest version="V1.1" service="Content">\n';
    dataString += '<key>key</key>\n';
    dataString += '<name>name</name>\n';
    dataString += '<member>member</member>\n';
    dataString += '<identity>identity</identity>\n';
    dataString += '<consumer>consumer</consumer>\n';
    dataString += '<producer>producer</producer>\n';
    dataString += '<content>content</content>\n';
    dataString += '<url>url</url>\n';
    dataString += '</ingest></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

invite - V0.0 - ThumbWhere

Creates an invitation that can be sent out to the provided #email#.

Invitations are associated with the provided #api_key#

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for invite (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.invite = function(
	p_api_key,
	p_email)
{
    this.m_action = {};
    this.m_action.m_invite = 
    { 
        m_api_key:p_api_key,
        m_email:p_email
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.invite.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_invite = 
        {

        };
    return this;
}                   

// Reference to the request
var l_invite = null;

// Reference to the action
var l_invite_action = null;

// This is called on completion of a call to invite
function oncomplete_invite()
{
    alert("oncomplete_invite");


    // Get response as object
    var l_obj = l_invite.m_response.m_invite;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_invite_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/invite/status").text);

    // Get response as a single string
    alert(l_invite_action.m_response_string);
}

// Create the request
l_invite = new MetaWrap.XML.Action.WS.invite
(
								
    'api_key',
    'email'
);

// Create action
l_invite_action = new MetaWrap.XML.Action(l_invite,l_api_server + "/invite");

// Call the action
if (!l_invite_action.run(oncomplete_invite))
{
    alert("There was an error calling 'invite'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for invite
//

// JQuery GET request
    var dataString = 'api_key=api_key&email=email'
    $.get(
      l_api_server+'invite',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for invite
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<invite version="V0.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<email>email</email>\n';
    dataString += '</invite></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

invite - V1.0 - ThumbWhere

Creates an invitation that can be sent out to the provided #email#.

Invitations are associated with the provided #api_key#

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for invite (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.invite = function(
	p_api_key,
	p_email)
{
    this.m_action = {};
    this.m_action.m_invite = 
    { 
        m_api_key:p_api_key,
        m_email:p_email
    };
}

// Create the webservice action response
MetaWrap.XML.Action.WS.invite.prototype.response = function()
{   
    this.m_response = {};
    this.m_response.m_invite = 
        {

        };
    return this;
}                   

// Reference to the request
var l_invite = null;

// Reference to the action
var l_invite_action = null;

// This is called on completion of a call to invite
function oncomplete_invite()
{
    alert("oncomplete_invite");


    // Get response as object
    var l_obj = l_invite.m_response.m_invite;
    alert("'status' = " + l_obj.m_status);

    // Get response as XML
    var l_xml = l_invite_action.m_response_xml;
    alert("'status' (from xml) = " + l_xml.selectSingleNode("response/invite/status").text);

    // Get response as a single string
    alert(l_invite_action.m_response_string);
}

// Create the request
l_invite = new MetaWrap.XML.Action.WS.invite
(
								
    'api_key',
    'email'
);

// Create action
l_invite_action = new MetaWrap.XML.Action(l_invite,l_api_server + "/invite");

// Call the action
if (!l_invite_action.run(oncomplete_invite))
{
    alert("There was an error calling 'invite'");
}

//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery GET request

///////////////////////////////////////////////////////////
//
// Get Value Action Interface Generated for invite
//

// JQuery GET request
    var dataString = 'api_key=api_key&email=email'
    $.get(
      l_api_server+'invite',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

Example JavaScript Code For JQuery BATCH request

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for invite
//

// JQuery BATCH request
    var dataString = "";
	dataString += '<action>\n';
    dataString += '<invite version="V1.0" service="ThumbWhere">\n';
    dataString += '<api_key>api_key</api_key>\n';
    dataString += '<email>email</email>\n';
    dataString += '</invite></action>\n';
    $.post(
      l_api_server+'batch/',
      dataString,
      function($xml) 
      {
	$xml = $($xml);
	var $status = $xml.find('status').text();
	var statusString = $status;
	if ($status == 'error')
	{
	  alert("status: error - message:\n"+$xml.find('errorMessage').text());
	}
	else 
	{
	  alert("status: "+$status);
	}
      },
      'xml'
    );
//
//
//
///////////////////////////////////////////////////////////

							

location_get_identity_ad - V0.0 - ThumbWhere

For the specified location and individial, return an ad tailored to that individual at that location.

Parameters

Returns

Scenarios

Example JavaScript Code For MetaWrap JavaScript Library

///////////////////////////////////////////////////////////
//
// XML Action Interface Generated for location_get_identity_ad (DEPRICATED)
//

// Create the webservice action request
MetaWrap.XML.Action.WS.location_get_identity_ad = function(
	p_api_key,
	p_location_type,
	p_location_id,
	p_identity_type,
	p_identity_id)
{
    this.m_action = {};
    this.m_action.m_location_get_identity_ad = 
    { 
        m_api_key:p_api_key,
        m_location_type:p_location_type,
        m_location_id:p_location_id,
        m_identity_type:p_identity_type,
        m_identity_id:p_identity_id
    };
}

// Create the