account_create - V1.1 - Admin

Creates a new account.

Parameters

• masterkey

  The master key.

  
  

• name

  The name of the account.

  
  

• email

  Users email.

  
  

• password

  Users password.

  
  

Returns

Scenarios

• simple

  Encrypt a simple string.

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  masterkey
  name
  email
  password
  

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

• masterkey

  The master key.

  
  

• name

  The name of the account

  
  

Returns

Scenarios

• simple

  Encrypt a simple string.

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  masterkey
  name
  

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

• key

  The API Key.

  
  

• producer

  The producer being added to

  
  

• member

  The member that will be a producer.

  
  

• consumer

  The consumer that will be created producer.

  
  

Returns

Scenarios

• member

  Register james as a producer of content.

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  key
  producer
  member
  

• consumer

  Register james as a producer of content.

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  key
  producer
  consumer
  

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 - V1.1 - Application

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

• api_key

  If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the API's domain name.

  
  

• api_member_token

  Member that this identity will be added to. If this is blank and this is not a pre-existing member then a new member will be created after this request is completed

  
  

• id

  The identity id - eg email address or mobile phone number.

  
  

• type

  The identity type

  
  

Returns

• code

  The code to be sent via SMS or MMS. This is also used to request a status update on the request by making a call to ^api_identity_token_request_query^.

• number

  The number to send this code to to complete the API registration. #code# should be sent to this number via SMS or MMS. After which a request to ^api_identity_token_request_query^ should return the new API identity_token

Scenarios

• simple

  Assert that you own the email address drmiaow@gmail.com

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  api_member_token
  id
  type
  

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.1" service="Application">\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.1 - Commerce

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

• api_key

  If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the API's domain name.

  
  

• api_member_token

  Member that this identity will be added to. If this is blank and this is not a pre-existing member then a new member will be created after this request is completed

  
  

• id

  The identity id - eg email address or mobile phone number.

  
  

• type

  The identity type

  
  

Returns

• code

  The code to be sent via SMS or MMS. This is also used to request a status update on the request by making a call to ^api_identity_token_request_query^.

• number

  The number to send this code to to complete the API registration. #code# should be sent to this number via SMS or MMS. After which a request to ^api_identity_token_request_query^ should return the new API identity_token

Scenarios

• simple

  Assert that you own the email address drmiaow@gmail.com

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  api_member_token
  id
  type
  

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.1" service="Commerce">\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.1 - Competition

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

• api_key

  If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the API's domain name.

  
  

• api_member_token

  Member that this identity will be added to. If this is blank and this is not a pre-existing member then a new member will be created after this request is completed

  
  

• id

  The identity id - eg email address or mobile phone number.

  
  

• type

  The identity type

  
  

Returns

• code

  The code to be sent via SMS or MMS. This is also used to request a status update on the request by making a call to ^api_identity_token_request_query^.

• number

  The number to send this code to to complete the API registration. #code# should be sent to this number via SMS or MMS. After which a request to ^api_identity_token_request_query^ should return the new API identity_token

Scenarios

• simple

  Assert that you own the email address drmiaow@gmail.com

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  api_member_token
  id
  type
  

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.1" service="Competition">\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 - 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

• api_key

  If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the API's domain name.

  
  

• api_member_token

  Member that this identity will be added to. If this is blank and this is not a pre-existing member then a new member will be created after this request is completed

  
  

• id

  The identity id - eg email address or mobile phone number.

  
  

• type

  The identity type

  
  

Returns

Scenarios

• simple

  Assert that you own the email address drmiaow@gmail.com

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  api_member_token
  id
  type
  

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

• api_key

  If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the API's domain name.

  
  

• api_member_token

  Member that this identity will be added to. If this is blank and this is not a pre-existing member then a new member will be created after this request is completed

  
  

• id

  The identity id - eg email address or mobile phone number.

  
  

• type

  The identity type

  
  

Returns

• code

  The code to be sent via SMS or MMS. This is also used to request a status update on the request by making a call to ^api_identity_token_request_query^.

• number

  The number to send this code to to complete the API registration. #code# should be sent to this number via SMS or MMS. After which a request to ^api_identity_token_request_query^ should return the new API identity_token

Scenarios

• simple

  Assert that you own the email address drmiaow@gmail.com

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  api_member_token
  id
  type
  

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 - V1.1 - Application

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

• api_key

  The API Key that a API Identity Token request has been made against. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the API's domain name.

  
  

• code

  The code that was returned by a previous call to ^api_identity_token_request^. This code should have been sent via SMS or MMS to the number also returned by ^api_identity_token_request^.

  
  

Returns

• api_identity_token

  This is the api identity token that was created or found matching the original request..

• api_member_token

  The API Identity Token returned. This be the same as the one supplied to ^api_identity_token_request^, or if one was supplied, it will be a be for a newly created Member.

Scenarios

• simple

  Request Status of an API Identity Token that will not exist

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  code
  

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.1" service="Application">\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.1 - Commerce

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

• api_key

  The API Key that a API Identity Token request has been made against. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the API's domain name.

  
  

• code

  The code that was returned by a previous call to ^api_identity_token_request^. This code should have been sent via SMS or MMS to the number also returned by ^api_identity_token_request^.

  
  

Returns

• api_identity_token

  This is the api identity token that was created or found matching the original request..

• api_member_token

  The API Identity Token returned. This be the same as the one supplied to ^api_identity_token_request^, or if one was supplied, it will be a be for a newly created Member.

Scenarios

• simple

  Request Status of an API Identity Token that will not exist

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  code
  

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.1" service="Commerce">\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.1 - Competition

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

• api_key

  The API Key that a API Identity Token request has been made against. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the API's domain name.

  
  

• code

  The code that was returned by a previous call to ^api_identity_token_request^. This code should have been sent via SMS or MMS to the number also returned by ^api_identity_token_request^.

  
  

Returns

• api_identity_token

  This is the api identity token that was created or found matching the original request..

• api_member_token

  The API Identity Token returned. This be the same as the one supplied to ^api_identity_token_request^, or if one was supplied, it will be a be for a newly created Member.

Scenarios

• simple

  Request Status of an API Identity Token that will not exist

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  code
  

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.1" service="Competition">\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 - 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

• api_key

  The API Key that a API Identity Token request has been made against. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the API's domain name.

  
  

• code

  The code that was returned by a previous call to ^api_identity_token_request^. This code should have been sent via SMS or MMS to the number also returned by ^api_identity_token_request^.

  
  

Returns

Scenarios

• simple

  Request Status of an API Identity Token that will not exist

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  code
  

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

• api_key

  The API Key that a API Identity Token request has been made against. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the API's domain name.

  
  

• code

  The code that was returned by a previous call to ^api_identity_token_request^. This code should have been sent via SMS or MMS to the number also returned by ^api_identity_token_request^.

  
  

Returns

• api_identity_token

  This is the api identity token that was created or found matching the original request..

• api_member_token

  The API Identity Token returned. This be the same as the one supplied to ^api_identity_token_request^, or if one was supplied, it will be a be for a newly created Member.

Scenarios

• simple

  Request Status of an API Identity Token that will not exist

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  code
  

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 - V1.1 - Application

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

• api_key

  The API Key that a API Identity Token request has been made against. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the API's domain name.

  
  

• code

  The code that was returned by a previous call to ^api_identity_token_request^. This code should have been sent via SMS or MMS to the number also returned by ^api_identity_token_request^.

  
  

Returns

• request

  If the API Identity Token is ready for use, this will be 'ready' and the #api_identity_token# element will be present and populated, else it will be 'waiting' or 'expired' if the request has expired.

• expiry_seconds

  The number of seconds you have before the API Identity Token request expires. Will not show if #request# is 'expired' or 'ready'

• api_member_token

  The API Identity Token returned. This will only be present if #request# has a value of 'ready'

Scenarios

• simple

  Request Status of an API Identity Token that will not exist

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  code
  

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.1" service="Application">\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.1 - Commerce

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

• api_key

  The API Key that a API Identity Token request has been made against. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the API's domain name.

  
  

• code

  The code that was returned by a previous call to ^api_identity_token_request^. This code should have been sent via SMS or MMS to the number also returned by ^api_identity_token_request^.

  
  

Returns

• request

  If the API Identity Token is ready for use, this will be 'ready' and the #api_identity_token# element will be present and populated, else it will be 'waiting' or 'expired' if the request has expired.

• expiry_seconds

  The number of seconds you have before the API Identity Token request expires. Will not show if #request# is 'expired' or 'ready'

• api_member_token

  The API Identity Token returned. This will only be present if #request# has a value of 'ready'

Scenarios

• simple

  Request Status of an API Identity Token that will not exist

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  code
  

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.1" service="Commerce">\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.1 - Competition

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

• api_key

  The API Key that a API Identity Token request has been made against. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the API's domain name.

  
  

• code

  The code that was returned by a previous call to ^api_identity_token_request^. This code should have been sent via SMS or MMS to the number also returned by ^api_identity_token_request^.

  
  

Returns

• request

  If the API Identity Token is ready for use, this will be 'ready' and the #api_identity_token# element will be present and populated, else it will be 'waiting' or 'expired' if the request has expired.

• expiry_seconds

  The number of seconds you have before the API Identity Token request expires. Will not show if #request# is 'expired' or 'ready'

• api_member_token

  The API Identity Token returned. This will only be present if #request# has a value of 'ready'

Scenarios

• simple

  Request Status of an API Identity Token that will not exist

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  code
  

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.1" service="Competition">\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 - 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

• api_key

  The API Key that a API Identity Token request has been made against. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the API's domain name.

  
  

• code

  The code that was returned by a previous call to ^api_identity_token_request^. This code should have been sent via SMS or MMS to the number also returned by ^api_identity_token_request^.

  
  

Returns

Scenarios

• simple

  Request Status of an API Identity Token that will not exist

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  code
  

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

• api_key

  The API Key that a API Identity Token request has been made against. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the API's domain name.

  
  

• code

  The code that was returned by a previous call to ^api_identity_token_request^. This code should have been sent via SMS or MMS to the number also returned by ^api_identity_token_request^.

  
  

Returns

• request

  If the API Identity Token is ready for use, this will be 'ready' and the #api_identity_token# element will be present and populated, else it will be 'waiting' or 'expired' if the request has expired.

• expiry_seconds

  The number of seconds you have before the API Identity Token request expires. Will not show if #request# is 'expired' or 'ready'

• api_member_token

  The API Identity Token returned. This will only be present if #request# has a value of 'ready'

Scenarios

• simple

  Request Status of an API Identity Token that will not exist

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  code
  

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 - V1.1 - Application

Validates #api_identity_token# and returns its current state.

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

Parameters

• api_member_token

  The API Identity Token to validate.

  
  

Returns

• state

  The state of the API Identity Token.

Scenarios

• simple

  validate an API Identity Token

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_member_token
  

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.1" service="Application">\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.1 - Commerce

Validates #api_identity_token# and returns its current state.

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

Parameters

• api_member_token

  The API Identity Token to validate.

  
  

Returns

• state

  The state of the API Identity Token.

Scenarios

• simple

  validate an API Identity Token

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_member_token
  

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.1" service="Commerce">\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.1 - Competition

Validates #api_identity_token# and returns its current state.

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

Parameters

• api_member_token

  The API Identity Token to validate.

  
  

Returns

• state

  The state of the API Identity Token.

Scenarios

• simple

  validate an API Identity Token

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_member_token
  

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.1" service="Competition">\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 - 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

• api_member_token

  The API Identity Token to validate.

  
  

Returns

Scenarios

• simple

  validate an API Identity Token

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_member_token
  

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

• api_member_token

  The API Identity Token to validate.

  
  

Returns

• state

  The state of the API Identity Token.

Scenarios

• simple

  validate an API Identity Token

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_member_token
  

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 - V1.1 - Application

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

• campaign_id

  The campaign these API calls will be made against.

  
  

• name

  The name of the application to be registered.

  
  

• url

  The url of the application to be registsted.

  
  

• description

  A description for the application to be registered.

  
  

Returns

• code

  The code to be sent via SMS or MMS. This is also used to request a status update on the request by making a call to ^api_key_request_query^.

• number

  The number to send this code to to complete the API registration. #code# should be sent to this number via SMS or MMS. After which a request to ^api_key_request_query^ should return the new API key

Scenarios

• simple

  Register A Test Application

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  campaign_id
  name
  url
  description
  

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.1" service="Application">\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.1 - Commerce

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

• campaign_id

  The campaign these API calls will be made against.

  
  

• name

  The name of the application to be registered.

  
  

• url

  The url of the application to be registsted.

  
  

• description

  A description for the application to be registered.

  
  

Returns

• code

  The code to be sent via SMS or MMS. This is also used to request a status update on the request by making a call to ^api_key_request_query^.

• number

  The number to send this code to to complete the API registration. #code# should be sent to this number via SMS or MMS. After which a request to ^api_key_request_query^ should return the new API key

Scenarios

• simple

  Register A Test Application

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  campaign_id
  name
  url
  description
  

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.1" service="Commerce">\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.1 - Competition

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

• campaign_id

  The campaign these API calls will be made against.

  
  

• name

  The name of the application to be registered.

  
  

• url

  The url of the application to be registsted.

  
  

• description

  A description for the application to be registered.

  
  

Returns

• code

  The code to be sent via SMS or MMS. This is also used to request a status update on the request by making a call to ^api_key_request_query^.

• number

  The number to send this code to to complete the API registration. #code# should be sent to this number via SMS or MMS. After which a request to ^api_key_request_query^ should return the new API key

Scenarios

• simple

  Register A Test Application

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  campaign_id
  name
  url
  description
  

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.1" service="Competition">\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 - 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

• campaign_id

  The campaign these API calls will be made against.

  
  

• name

  The name of the application to be registered.

  
  

• url

  The url of the application to be registsted.

  
  

• description

  A description for the application to be registered.

  
  

Returns

Scenarios

• simple

  Register A Test Application

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  campaign_id
  name
  url
  description
  

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

• campaign_id

  The campaign these API calls will be made against.

  
  

• name

  The name of the application to be registered.

  
  

• url

  The url of the application to be registsted.

  
  

• description

  A description for the application to be registered.

  
  

Returns

• code

  The code to be sent via SMS or MMS. This is also used to request a status update on the request by making a call to ^api_key_request_query^.

• number

  The number to send this code to to complete the API registration. #code# should be sent to this number via SMS or MMS. After which a request to ^api_key_request_query^ should return the new API key

Scenarios

• simple

  Register A Test Application

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  campaign_id
  name
  url
  description
  

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 - V1.1 - Application

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

• campaign_id

  The campaign these API calls will be made against.

  
  

• code

  The code that was returned by a previous call to ^api_key_request^. This code should have been sent via SMS or MMS to the number also returned by ^api_key_request^.

  
  

Returns

• request

  If the API Key is ready for use, this will be 'ready' and the #api_key# element will be present and populated, else it will be 'waiting' or 'expired' if the request has expired.

• expiry_seconds

  The number of seconds you have before the API Key request expires. Will not show if #request# is 'expired' or 'ready'

• api_key

  The API Key returned. This will only be present if #request# has a value of 'ready'

Scenarios

• simple

  Request Status of an API Key that will not exist

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  campaign_id
  code
  

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.1" service="Application">\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.1 - Commerce

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

• campaign_id

  The campaign these API calls will be made against.

  
  

• code

  The code that was returned by a previous call to ^api_key_request^. This code should have been sent via SMS or MMS to the number also returned by ^api_key_request^.

  
  

Returns

• request

  If the API Key is ready for use, this will be 'ready' and the #api_key# element will be present and populated, else it will be 'waiting' or 'expired' if the request has expired.

• expiry_seconds

  The number of seconds you have before the API Key request expires. Will not show if #request# is 'expired' or 'ready'

• api_key

  The API Key returned. This will only be present if #request# has a value of 'ready'

Scenarios

• simple

  Request Status of an API Key that will not exist

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  campaign_id
  code
  

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.1" service="Commerce">\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.1 - Competition

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

• campaign_id

  The campaign these API calls will be made against.

  
  

• code

  The code that was returned by a previous call to ^api_key_request^. This code should have been sent via SMS or MMS to the number also returned by ^api_key_request^.

  
  

Returns

• request

  If the API Key is ready for use, this will be 'ready' and the #api_key# element will be present and populated, else it will be 'waiting' or 'expired' if the request has expired.

• expiry_seconds

  The number of seconds you have before the API Key request expires. Will not show if #request# is 'expired' or 'ready'

• api_key

  The API Key returned. This will only be present if #request# has a value of 'ready'

Scenarios

• simple

  Request Status of an API Key that will not exist

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  campaign_id
  code
  

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.1" service="Competition">\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 - 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

• campaign_id

  The campaign these API calls will be made against.

  
  

• code

  The code that was returned by a previous call to ^api_key_request^. This code should have been sent via SMS or MMS to the number also returned by ^api_key_request^.

  
  

Returns

Scenarios

• simple

  Request Status of an API Key that will not exist

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  campaign_id
  code
  

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

• campaign_id

  The campaign these API calls will be made against.

  
  

• code

  The code that was returned by a previous call to ^api_key_request^. This code should have been sent via SMS or MMS to the number also returned by ^api_key_request^.

  
  

Returns

• request

  If the API Key is ready for use, this will be 'ready' and the #api_key# element will be present and populated, else it will be 'waiting' or 'expired' if the request has expired.

• expiry_seconds

  The number of seconds you have before the API Key request expires. Will not show if #request# is 'expired' or 'ready'

• api_key

  The API Key returned. This will only be present if #request# has a value of 'ready'

Scenarios

• simple

  Request Status of an API Key that will not exist

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  campaign_id
  code
  

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 - V1.1 - Application

Validates #api_key# and returns its current state

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

Parameters

• api_key

  API Key for the registered application that is calling this method. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the API's domain name.

  
  

Returns

• state

  The state of the API Key.

Scenarios

• simple

  validate an API Key

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  

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.1" service="Application">\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.1 - Commerce

Validates #api_key# and returns its current state

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

Parameters

• api_key

  API Key for the registered application that is calling this method. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the API's domain name.

  
  

Returns

• state

  The state of the API Key.

Scenarios

• simple

  validate an API Key

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  

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.1" service="Commerce">\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.1 - Competition

Validates #api_key# and returns its current state

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

Parameters

• api_key

  API Key for the registered application that is calling this method. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the API's domain name.

  
  

Returns

• state

  The state of the API Key.

Scenarios

• simple

  validate an API Key

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  

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.1" service="Competition">\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 - V0.0 - ThumbWhere

Validates #api_key# and returns its current state

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

Parameters

• api_key

  API Key for the registered application that is calling this method. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the API's domain name.

  
  

Returns

Scenarios

• simple

  validate an API Key

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  

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

• api_key

  API Key for the registered application that is calling this method. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the API's domain name.

  
  

Returns

• state

  The state of the API Key.

Scenarios

• simple

  validate an API Key

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  

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 - V1.1 - Application

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

Parameters

• api_key

  The API key for the campaign or external application. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the calling domain name

  
  

• api_member_token

  API Member token that you want turned into a lookup code

  
  

• alphabet

  string - The dictionary that you want to use to construct the code

  
  

• length

  integer - The length of the code you want to construct

  
  

Returns

• code

  The created code

Scenarios

• something

  Request URL for a media item

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  api_member_token
  alphabet
  length
  

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.1" service="Application">\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.1 - Commerce

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

Parameters

• api_key

  The API key for the campaign or external application. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the calling domain name

  
  

• api_member_token

  API Member token that you want turned into a lookup code

  
  

• alphabet

  string - The dictionary that you want to use to construct the code

  
  

• length

  integer - The length of the code you want to construct

  
  

Returns

• code

  The created code

Scenarios

• something

  Request URL for a media item

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  api_member_token
  alphabet
  length
  

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.1" service="Commerce">\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.1 - Competition

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

Parameters

• api_key

  The API key for the campaign or external application. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the calling domain name

  
  

• api_member_token

  API Member token that you want turned into a lookup code

  
  

• alphabet

  string - The dictionary that you want to use to construct the code

  
  

• length

  integer - The length of the code you want to construct

  
  

Returns

• code

  The created code

Scenarios

• something

  Request URL for a media item

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  api_member_token
  alphabet
  length
  

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.1" service="Competition">\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 - V0.0 - ThumbWhere

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

Parameters

• api_key

  The API key for the campaign or external application. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the calling domain name

  
  

• api_member_token

  API Member token that you want turned into a lookup code

  
  

• alphabet

  string - The dictionary that you want to use to construct the code

  
  

• length

  integer - The length of the code you want to construct

  
  

Returns

Scenarios

• something

  Request URL for a media item

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  api_member_token
  alphabet
  length
  

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

• api_key

  The API key for the campaign or external application. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the calling domain name

  
  

• api_member_token

  API Member token that you want turned into a lookup code

  
  

• alphabet

  string - The dictionary that you want to use to construct the code

  
  

• length

  integer - The length of the code you want to construct

  
  

Returns

• code

  The created code

Scenarios

• something

  Request URL for a media item

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  api_member_token
  alphabet
  length
  

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 - V1.1 - Application

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

Parameters

• master_key

  Master key for this instance of ThumbWhere

  
  

• api_key

  The API key for the campaign or external application. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the calling domain name

  
  

• id

  Identity id

  
  

• type

  Identity type

  
  

• alphabet

  string - The dictionary that you want to use to construct the code

  
  

• length

  integer - The length of the code you want to construct

  
  

Returns

• code

  The created code

Scenarios

• something

  Request code for a member token based on an identity id

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  master_key
  api_key
  type
  id
  alphabet
  length
  

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.1" service="Application">\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.1 - Commerce

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

Parameters

• master_key

  Master key for this instance of ThumbWhere

  
  

• api_key

  The API key for the campaign or external application. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the calling domain name

  
  

• id

  Identity id

  
  

• type

  Identity type

  
  

• alphabet

  string - The dictionary that you want to use to construct the code

  
  

• length

  integer - The length of the code you want to construct

  
  

Returns

• code

  The created code

Scenarios

• something

  Request code for a member token based on an identity id

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  master_key
  api_key
  type
  id
  alphabet
  length
  

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.1" service="Commerce">\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.1 - Competition

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

Parameters

• master_key

  Master key for this instance of ThumbWhere

  
  

• api_key

  The API key for the campaign or external application. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the calling domain name

  
  

• id

  Identity id

  
  

• type

  Identity type

  
  

• alphabet

  string - The dictionary that you want to use to construct the code

  
  

• length

  integer - The length of the code you want to construct

  
  

Returns

• code

  The created code

Scenarios

• something

  Request code for a member token based on an identity id

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  master_key
  api_key
  type
  id
  alphabet
  length
  

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.1" service="Competition">\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 - V0.0 - ThumbWhere

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

Parameters

• master_key

  Master key for this instance of ThumbWhere

  
  

• api_key

  The API key for the campaign or external application. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the calling domain name

  
  

• id

  Identity id

  
  

• type

  Identity type

  
  

• alphabet

  string - The dictionary that you want to use to construct the code

  
  

• length

  integer - The length of the code you want to construct

  
  

Returns

Scenarios

• something

  Request code for a member token based on an identity id

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  master_key
  api_key
  type
  id
  alphabet
  length
  

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

• master_key

  Master key for this instance of ThumbWhere

  
  

• api_key

  The API key for the campaign or external application. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the calling domain name

  
  

• id

  Identity id

  
  

• type

  Identity type

  
  

• alphabet

  string - The dictionary that you want to use to construct the code

  
  

• length

  integer - The length of the code you want to construct

  
  

Returns

• code

  The created code

Scenarios

• something

  Request code for a member token based on an identity id

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  master_key
  api_key
  type
  id
  alphabet
  length
  

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 - V1.1 - Application

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

• api_key

  The API key for the campaign or external application. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the calling domain name

  
  

• api_member_token

  The API Member Token that we want to login as.

  
  

Returns

• username

  The name of the member

• feedurl

  URL to the XML feed that describes this member

Scenarios

• simple

  Login as member using the saved member token

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  api_member_token
  

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.1" service="Application">\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.1 - Commerce

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

• api_key

  The API key for the campaign or external application. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the calling domain name

  
  

• api_member_token

  The API Member Token that we want to login as.

  
  

Returns

• username

  The name of the member

• feedurl

  URL to the XML feed that describes this member

Scenarios

• simple

  Login as member using the saved member token

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  api_member_token
  

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.1" service="Commerce">\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.1 - Competition

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

• api_key

  The API key for the campaign or external application. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the calling domain name

  
  

• api_member_token

  The API Member Token that we want to login as.

  
  

Returns

• username

  The name of the member

• feedurl

  URL to the XML feed that describes this member

Scenarios

• simple

  Login as member using the saved member token

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  api_member_token
  

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.1" service="Competition">\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 - 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

• api_key

  The API key for the campaign or external application. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the calling domain name

  
  

• api_member_token

  The API Member Token that we want to login as.

  
  

Returns

Scenarios

• simple

  Login as member using the saved member token

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  api_member_token
  

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

• api_key

  The API key for the campaign or external application. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the calling domain name

  
  

• api_member_token

  The API Member Token that we want to login as.

  
  

Returns

• username

  The name of the member

• feedurl

  URL to the XML feed that describes this member

Scenarios

• simple

  Login as member using the saved member token

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  api_member_token
  

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 - V1.1 - Application

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

• api_key

  The API key for the campaign or external application. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the calling domain name

  
  

• code

  The code you want to lookup.

  
  

Returns

• api_member_token

  The created code

Scenarios

• something

  Simple code lookup

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  code
  

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.1" service="Application">\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.1 - Commerce

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

• api_key

  The API key for the campaign or external application. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the calling domain name

  
  

• code

  The code you want to lookup.

  
  

Returns

• api_member_token

  The created code

Scenarios

• something

  Simple code lookup

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  code
  

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.1" service="Commerce">\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.1 - Competition

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

• api_key

  The API key for the campaign or external application. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the calling domain name

  
  

• code

  The code you want to lookup.

  
  

Returns

• api_member_token

  The created code

Scenarios

• something

  Simple code lookup

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  code
  

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.1" service="Competition">\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 - 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

• api_key

  The API key for the campaign or external application. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the calling domain name

  
  

• code

  The code you want to lookup.

  
  

Returns

Scenarios

• something

  Simple code lookup

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  code
  

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

• api_key

  The API key for the campaign or external application. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the calling domain name

  
  

• code

  The code you want to lookup.

  
  

Returns

• api_member_token

  The created code

Scenarios

• something

  Simple code lookup

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  code
  

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 - V1.1 - Application

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

• api_key

  If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the API's domain name.

  
  

Returns

• code

  The code to be sent via SMS or MMS. This is also used to request a status update on the request by making a call to ^api_member_token_request_query^.

• number

  The number to send this code to to complete the API registration. #code# should be sent to this number via SMS or MMS. After which a request to ^api_member_token_request_query^ should return the new API member_token

Scenarios

• simple

  Register A Test Application

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  

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.1" service="Application">\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.1 - Commerce

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

• api_key

  If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the API's domain name.

  
  

Returns

• code

  The code to be sent via SMS or MMS. This is also used to request a status update on the request by making a call to ^api_member_token_request_query^.

• number

  The number to send this code to to complete the API registration. #code# should be sent to this number via SMS or MMS. After which a request to ^api_member_token_request_query^ should return the new API member_token

Scenarios

• simple

  Register A Test Application

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  

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.1" service="Commerce">\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.1 - Competition

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

• api_key

  If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the API's domain name.

  
  

Returns

• code

  The code to be sent via SMS or MMS. This is also used to request a status update on the request by making a call to ^api_member_token_request_query^.

• number

  The number to send this code to to complete the API registration. #code# should be sent to this number via SMS or MMS. After which a request to ^api_member_token_request_query^ should return the new API member_token

Scenarios

• simple

  Register A Test Application

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  

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.1" service="Competition">\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 - 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

• api_key

  If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the API's domain name.

  
  

Returns

Scenarios

• simple

  Register A Test Application

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  

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

• api_key

  If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the API's domain name.

  
  

Returns

• code

  The code to be sent via SMS or MMS. This is also used to request a status update on the request by making a call to ^api_member_token_request_query^.

• number

  The number to send this code to to complete the API registration. #code# should be sent to this number via SMS or MMS. After which a request to ^api_member_token_request_query^ should return the new API member_token

Scenarios

• simple

  Register A Test Application

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  

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 - V1.1 - Application

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

• api_key

  The API Key that a API Member Token request has been made against. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the API's domain name.

  
  

• code

  The code that was returned by a previous call to ^api_member_token_request^. This code should have been sent via SMS or MMS to the number also returned by ^api_member_token_request^.

  
  

Returns

• request

  If the API Member Token is ready for use, this will be 'ready' and the #api_member_token# element will be present and populated, else it will be 'waiting' or 'expired' if the request has expired.

• expiry_seconds

  The number of seconds you have before the API Member Token request expires. Will not show if #request# is 'expired' or 'ready'

• api_member_token

  The API Member Token returned. This will only be present if #request# has a value of 'ready'

Scenarios

• simple

  Request Status of an API Member Token that will not exist

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  code
  

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.1" service="Application">\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.1 - Commerce

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

• api_key

  The API Key that a API Member Token request has been made against. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the API's domain name.

  
  

• code

  The code that was returned by a previous call to ^api_member_token_request^. This code should have been sent via SMS or MMS to the number also returned by ^api_member_token_request^.

  
  

Returns

• request

  If the API Member Token is ready for use, this will be 'ready' and the #api_member_token# element will be present and populated, else it will be 'waiting' or 'expired' if the request has expired.

• expiry_seconds

  The number of seconds you have before the API Member Token request expires. Will not show if #request# is 'expired' or 'ready'

• api_member_token

  The API Member Token returned. This will only be present if #request# has a value of 'ready'

Scenarios

• simple

  Request Status of an API Member Token that will not exist

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  code
  

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.1" service="Commerce">\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.1 - Competition

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

• api_key

  The API Key that a API Member Token request has been made against. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the API's domain name.

  
  

• code

  The code that was returned by a previous call to ^api_member_token_request^. This code should have been sent via SMS or MMS to the number also returned by ^api_member_token_request^.

  
  

Returns

• request

  If the API Member Token is ready for use, this will be 'ready' and the #api_member_token# element will be present and populated, else it will be 'waiting' or 'expired' if the request has expired.

• expiry_seconds

  The number of seconds you have before the API Member Token request expires. Will not show if #request# is 'expired' or 'ready'

• api_member_token

  The API Member Token returned. This will only be present if #request# has a value of 'ready'

Scenarios

• simple

  Request Status of an API Member Token that will not exist

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  code
  

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.1" service="Competition">\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 - 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

• api_key

  The API Key that a API Member Token request has been made against. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the API's domain name.

  
  

• code

  The code that was returned by a previous call to ^api_member_token_request^. This code should have been sent via SMS or MMS to the number also returned by ^api_member_token_request^.

  
  

Returns

Scenarios

• simple

  Request Status of an API Member Token that will not exist

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  code
  

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

• api_key

  The API Key that a API Member Token request has been made against. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the API's domain name.

  
  

• code

  The code that was returned by a previous call to ^api_member_token_request^. This code should have been sent via SMS or MMS to the number also returned by ^api_member_token_request^.

  
  

Returns

• request

  If the API Member Token is ready for use, this will be 'ready' and the #api_member_token# element will be present and populated, else it will be 'waiting' or 'expired' if the request has expired.

• expiry_seconds

  The number of seconds you have before the API Member Token request expires. Will not show if #request# is 'expired' or 'ready'

• api_member_token

  The API Member Token returned. This will only be present if #request# has a value of 'ready'

Scenarios

• simple

  Request Status of an API Member Token that will not exist

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  code
  

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 - V1.1 - Application

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

• api_key

  The API key for the campaign or external application. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the calling domain name

  
  

• code

  The code you want to revoke.

  
  

Returns

Scenarios

• something

  Simple code lookup

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  code
  

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.1" service="Application">\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.1 - Commerce

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

• api_key

  The API key for the campaign or external application. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the calling domain name

  
  

• code

  The code you want to revoke.

  
  

Returns

Scenarios

• something

  Simple code lookup

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  code
  

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.1" service="Commerce">\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.1 - Competition

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

• api_key

  The API key for the campaign or external application. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the calling domain name

  
  

• code

  The code you want to revoke.

  
  

Returns

Scenarios

• something

  Simple code lookup

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  code
  

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.1" service="Competition">\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 - 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

• api_key

  The API key for the campaign or external application. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the calling domain name

  
  

• code

  The code you want to revoke.

  
  

Returns

Scenarios

• something

  Simple code lookup

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  code
  

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

• api_key

  The API key for the campaign or external application. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the calling domain name

  
  

• code

  The code you want to revoke.

  
  

Returns

Scenarios

• something

  Simple code lookup

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  code
  

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 - V1.1 - Application

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

Parameters

• api_member_token

  The API Member Token to validate.

  
  

Returns

• state

  The state of the API Member Token.

Scenarios

• simple

  validate an API Member Token

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_member_token
  

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.1" service="Application">\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.1 - Commerce

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

Parameters

• api_member_token

  The API Member Token to validate.

  
  

Returns

• state

  The state of the API Member Token.

Scenarios

• simple

  validate an API Member Token

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_member_token
  

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.1" service="Commerce">\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.1 - Competition

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

Parameters

• api_member_token

  The API Member Token to validate.

  
  

Returns

• state

  The state of the API Member Token.

Scenarios

• simple

  validate an API Member Token

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_member_token
  

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.1" service="Competition">\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 - 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

• api_member_token

  The API Member Token to validate.

  
  

Returns

Scenarios

• simple

  validate an API Member Token

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_member_token
  

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

• api_member_token

  The API Member Token to validate.

  
  

Returns

• state

  The state of the API Member Token.

Scenarios

• simple

  validate an API Member Token

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_member_token
  

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 - V1.1 - Application

Adds a name value pair definition for an application.

This is shared across all campaigns that use this application.

Parameters

• api_key

  The API key for the external application.

  
  

• name

  The name of the name value pair.

  
  

• type

  The type of the name value pair eg. 'string','integer','parsecs etc.'.

  
  

• encrypted

  If this is true then the name value pair is encrypted in feeds and when transported accross the net.

  
  

Returns

Scenarios

• simple

  Add a new name value pair definition for this application.

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  name
  type
  encrypted
  

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.1" service="Application">\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.1 - Commerce

Adds a name value pair definition for an application.

This is shared across all campaigns that use this application.

Parameters

• api_key

  The API key for the external application.

  
  

• name

  The name of the name value pair.

  
  

• type

  The type of the name value pair eg. 'string','integer','parsecs etc.'.

  
  

• encrypted

  If this is true then the name value pair is encrypted in feeds and when transported accross the net.

  
  

Returns

Scenarios

• simple

  Add a new name value pair definition for this application.

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  name
  type
  encrypted
  

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.1" service="Commerce">\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.1 - Competition

Adds a name value pair definition for an application.

This is shared across all campaigns that use this application.

Parameters

• api_key

  The API key for the external application.

  
  

• name

  The name of the name value pair.

  
  

• type

  The type of the name value pair eg. 'string','integer','parsecs etc.'.

  
  

• encrypted

  If this is true then the name value pair is encrypted in feeds and when transported accross the net.

  
  

Returns

Scenarios

• simple

  Add a new name value pair definition for this application.

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  name
  type
  encrypted
  

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.1" service="Competition">\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 - V0.0 - ThumbWhere

Adds a name value pair definition for an application.

This is shared across all campaigns that use this application.

Parameters

• api_key

  The API key for the external application.

  
  

• name

  The name of the name value pair.

  
  

• type

  The type of the name value pair eg. 'string','integer','parsecs etc.'.

  
  

• encrypted

  If this is true then the name value pair is encrypted in feeds and when transported accross the net.

  
  

Returns

Scenarios

• simple

  Add a new name value pair definition for this application.

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  name
  type
  encrypted
  

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

• api_key

  The API key for the external application.

  
  

• name

  The name of the name value pair.

  
  

• type

  The type of the name value pair eg. 'string','integer','parsecs etc.'.

  
  

• encrypted

  If this is true then the name value pair is encrypted in feeds and when transported accross the net.

  
  

Returns

Scenarios

• simple

  Add a new name value pair definition for this application.

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  name
  type
  encrypted
  

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 - V1.1 - Application

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

• api_key

  The API key for the external application.

  
  

• name

  The name of the name valie pair to be deleted.

  
  

Returns

Scenarios

• simple

  Delete a name value pair definition for this application.

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  name
  

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.1" service="Application">\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.1 - Commerce

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

• api_key

  The API key for the external application.

  
  

• name

  The name of the name valie pair to be deleted.

  
  

Returns

Scenarios

• simple

  Delete a name value pair definition for this application.

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  name
  

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.1" service="Commerce">\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.1 - Competition

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

• api_key

  The API key for the external application.

  
  

• name

  The name of the name valie pair to be deleted.

  
  

Returns

Scenarios

• simple

  Delete a name value pair definition for this application.

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  name
  

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.1" service="Competition">\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 - 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

• api_key

  The API key for the external application.

  
  

• name

  The name of the name valie pair to be deleted.

  
  

Returns

Scenarios

• simple

  Delete a name value pair definition for this application.

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  name
  

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

• api_key

  The API key for the external application.

  
  

• name

  The name of the name valie pair to be deleted.

  
  

Returns

Scenarios

• simple

  Delete a name value pair definition for this application.

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  name
  

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 - V1.1 - Application

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

Parameters

• api_key

  The API key for external application.

  
  

Returns

Scenarios

• simple

  Get a summary of the specified application

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  

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.1" service="Application">\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.1 - Commerce

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

Parameters

• api_key

  The API key for external application.

  
  

Returns

Scenarios

• simple

  Get a summary of the specified application

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  

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.1" service="Commerce">\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.1 - Competition

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

Parameters

• api_key

  The API key for external application.

  
  

Returns

Scenarios

• simple

  Get a summary of the specified application

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  

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.1" service="Competition">\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 - V0.0 - ThumbWhere

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

Parameters

• api_key

  The API key for external application.

  
  

Returns

Scenarios

• simple

  Get a summary of the specified application

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  

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

• api_key

  The API key for external application.

  
  

Returns

Scenarios

• simple

  Get a summary of the specified application

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  

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

• key

  The API Key to provide context for this request.

  
  

• type

  The identity type

  
  

• id

  The id you want to validate against.

  
  

• secret

  The secret you want to supply to complete your validation.

  
  

Returns

Scenarios

• simple

  Request Status of an Identity Token that will not exist

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  key
  type
  id
  secret
  

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

• key

  The API Key that a Identity Token request has been made against. If this is blank, the server will assume the API token for the campaign based on the configuration of the API service and the API's domain name.

  
  

• code

  The code that was returned by a previous call to ^request^. This code should have been sent via SMS or MMS to the number also returned by ^request^.

  
  

• id

  The id you want to validate against.

  
  

• secret

  The secret you want to supply to complete your validation.

  
  

• label

  Optional label you want to apply to the new identity.

  
  

Returns

Scenarios

• simple

  Request Status of an Identity Token that will not exist

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  key
  code
  secret
  label
  

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

• key

  The API Key to provide context for this request.

  
  

• type

  The identity type

  
  

• id

  The id you want to validate against.

  
  

Returns

Scenarios

• simple

  Request Status of an Identity Token that will not exist

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  key
  type
  id
  

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

• key

  The API key for the campaign.

  
  

• member

  The member registering this dish.

  
  

• mediaitem

  The media item we are bookmarking.

  
  

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.1 - Application

Parameters

• api_key

  
  

• api_member_token

  
  

• actor

  
  

• action

  
  

• target

  
  

• magnitide

  
  

Returns

Scenarios

• simple

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.

  api_key
  api_member_token
  actor
  action
  target
  magnitude
  

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.1" service="Application">\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_bandwidthusage_create - V1.1 - Commerce

Parameters

• api_key

  
  

• api_member_token

  
  

• actor

  
  

• action

  
  

• target

  
  

• magnitide

  
  

Returns

Scenarios

• simple

  Test

  The values in the parameters are examples only. You will need to provide valid values for the form to function.