View All Methods in this API

endCampaign

Version 1 This method allows you to delete a campaign.

https://api.peoplevine.com/campaign.asmx/endCampaign

For non required fields, you can either omit from the JSON string or set it to a default value
(e.g. String = "", Integer/Double = 0, Boolean = false, DateTime = 1900-01-01T00:00:00.000Z)

INPUT

Name Type Description Required
{"auth": {"api_username": "", "api_password": "", "api_key": "", "company_no": 0, "username": "", "password": "", "timezone_offset": 0, "auth_type": "", "system_name": "", "system_company_no": 0 }, "campaign": {"campaign_name": "", "totalWait": <int>, "trigger_value": "", "company_no": 0, "totalQueue": <int>, "trigger_type": "", "created_on": "1/1/1900 12:00 AM", "totalSent": <int>, "trigger_no": 0, "totalFailed": <int>, "includeItems": false, "reference_action": "", "totalCustomers": <int>, "campaign_type": "", "wait_time": 0, "assign_type": "", "user_no": 0, "assign_no": 0, "message_type": "", "item_title": "", "campaign_assign_no": 0, "campaign_description": "", "campaign_no": 0, "campaign_start": "1/1/1900 12:00 AM", "campaign_end": "1/1/1900 12:00 AM", "reference_type": "", "reference_no": 0, "order_no": 0, "campaign_status": "" } }
{"auth": {"api_username": "", "api_password": "", "api_key": "", "company_no": 0, "username": "", "password": "" }, "campaign": {"campaign_name": "", "totalWait": <int>, "trigger_value": "", "company_no": 0, "totalQueue": <int>, "trigger_type": "", "created_on": "1/1/1900 12:00 AM", "totalSent": <int>, "trigger_no": 0, "totalFailed": <int>, "includeItems": false, "reference_action": "", "totalCustomers": <int>, "campaign_type": "", "wait_time": 0, "assign_type": "", "user_no": 0, "assign_no": 0, "message_type": "", "item_title": "", "campaign_assign_no": 0, "campaign_description": "", "campaign_no": 0, "campaign_start": "1/1/1900 12:00 AM", "campaign_end": "1/1/1900 12:00 AM", "reference_type": "", "reference_no": 0, "order_no": 0, "campaign_status": "" } }

OUTPUT

By default, every API call returns an object of returnMessage as either XML or JSON depending on your content-type of the request.  With in the returnMessage structure the returnObject is specified above and differs based on the API meth.

Name Type Description
responseCode String This identifies the error that occurred for additional handling. Response codes starting with "A" are a success or "E" are an error.
message String Additional minor details on the response to display to your customers.
isError Boolean True if an error. False if succesful.
methodFailed String If there's an error, this is the method it failed at for debugging purposes.
extendedMessage String Additional instructions on how you can fix the error or what you can do with the return object.
reason String Explains why this error occurred or what was completed.
reponseTime Double How long it took to respond in seconds.
{"responseCode": "", "message": "", "isError": false, "methodFailed": "", "extendedMessage": "", "reason": "", "responseTime": 0, }

Sample Code

This sample code is to generate a function leveraging existing core functions you've already built.

                
func getAPIKit() -> (url: String, dict: Dictionary<String, AnyObject>) {

    var campaign_name = ""
    var totalWait = <int>
    var trigger_value = ""
    var company_no = 0
    var totalQueue = <int>
    var trigger_type = ""
    var created_on = "1/1/1900 12:00 AM"
    var totalSent = <int>
    var trigger_no = 0
    var totalFailed = <int>
    var includeItems = false
    var reference_action = ""
    var totalCustomers = <int>
    var campaign_type = ""
    var wait_time = 0
    var assign_type = ""
    var user_no = 0
    var assign_no = 0
    var message_type = ""
    var item_title = ""
    var campaign_assign_no = 0
    var campaign_description = ""
    var campaign_no = 0
    var campaign_start = "1/1/1900 12:00 AM"
    var campaign_end = "1/1/1900 12:00 AM"
    var reference_type = ""
    var reference_no = 0
    var order_no = 0
    var campaign_status = ""

    let url = "https://api.peoplevine.com/campaign.asmx/endCampaign"
    
    let key = "campaign"
    let campaignDict: Dictionary<String, AnyObject> = ["campaign_name": campaign_name, "totalWait": totalWait, "trigger_value": trigger_value, "company_no": company_no, "totalQueue": totalQueue, "trigger_type": trigger_type, "created_on": created_on, "totalSent": totalSent, "trigger_no": trigger_no, "totalFailed": totalFailed, "includeItems": includeItems, "reference_action": reference_action, "totalCustomers": totalCustomers, "campaign_type": campaign_type, "wait_time": wait_time, "assign_type": assign_type, "user_no": user_no, "assign_no": assign_no, "message_type": message_type, "item_title": item_title, "campaign_assign_no": campaign_assign_no, "campaign_description": campaign_description, "campaign_no": campaign_no, "campaign_start": campaign_start, "campaign_end": campaign_end, "reference_type": reference_type, "reference_no": reference_no, "order_no": order_no, "campaign_status": campaign_status ]
    let finalDict = User.getAuthDict(dictToAdd: campaignDict, dictKey: key)
    
    return (url, finalDict)
  }

                
            

To get started we reccomend that you download the Alamofire project to simplify integration: https://github.com/Alamofire/Alamofire, in addition to SwiftyJSON: https://github.com/SwiftyJSON/SwiftyJSON

                
import Foundation

struct AUTH {
    static var api_username = <string>
    static var api_password = <string>
    static var api_key = <string>
    static var company_no = <double>
    static var username = <string>
    static var password = <string>
    static var timezone_offset = <double>
    static var auth_type = <string>
    static var system_name = <string>
    static var system_company_no = <double>}
    
struct CAMPAIGN {
    static var campaign_name = <string>
    static var totalWait = <int>
    static var trigger_value = <string>
    static var company_no = <double>
    static var totalQueue = <int>
    static var trigger_type = <string>
    static var created_on = <dateTime>
    static var totalSent = <int>
    static var trigger_no = <double>
    static var totalFailed = <int>
    static var includeItems = <boolean>
    static var reference_action = <string>
    static var totalCustomers = <int>
    static var campaign_type = <string>
    static var wait_time = <double>
    static var assign_type = <string>
    static var user_no = <double>
    static var assign_no = <double>
    static var message_type = <string>
    static var item_title = <string>
    static var campaign_assign_no = <double>
    static var campaign_description = <string>
    static var campaign_no = <double>
    static var campaign_start = <dateTime>
    static var campaign_end = <dateTime>
    static var reference_type = <string>
    static var reference_no = <double>
    static var order_no = <double>
    static var campaign_status = <string>}
    
func endCampaignRequest() {
    
    var endCampaignObjects = [AnyObject]()
    let postsEndpoint: String = "https://api.peoplevine.com/campaign.asmx/endCampaign"

    let authAndFieldsDict = ["auth": ["api_username": AUTH.api_username, "api_password": AUTH.api_password, "api_key": AUTH.api_key, "company_no": AUTH.company_no, "username": AUTH.username, "password": AUTH.password, "timezone_offset": AUTH.timezone_offset, "auth_type": AUTH.auth_type, "system_name": AUTH.system_name, "system_company_no": AUTH.system_company_no ], "campaign": ["campaign_name": CAMPAIGN.campaign_name, "totalWait": CAMPAIGN.totalWait, "trigger_value": CAMPAIGN.trigger_value, "company_no": CAMPAIGN.company_no, "totalQueue": CAMPAIGN.totalQueue, "trigger_type": CAMPAIGN.trigger_type, "created_on": CAMPAIGN.created_on, "totalSent": CAMPAIGN.totalSent, "trigger_no": CAMPAIGN.trigger_no, "totalFailed": CAMPAIGN.totalFailed, "includeItems": CAMPAIGN.includeItems, "reference_action": CAMPAIGN.reference_action, "totalCustomers": CAMPAIGN.totalCustomers, "campaign_type": CAMPAIGN.campaign_type, "wait_time": CAMPAIGN.wait_time, "assign_type": CAMPAIGN.assign_type, "user_no": CAMPAIGN.user_no, "assign_no": CAMPAIGN.assign_no, "message_type": CAMPAIGN.message_type, "item_title": CAMPAIGN.item_title, "campaign_assign_no": CAMPAIGN.campaign_assign_no, "campaign_description": CAMPAIGN.campaign_description, "campaign_no": CAMPAIGN.campaign_no, "campaign_start": CAMPAIGN.campaign_start, "campaign_end": CAMPAIGN.campaign_end, "reference_type": CAMPAIGN.reference_type, "reference_no": CAMPAIGN.reference_no, "order_no": CAMPAIGN.order_no, "campaign_status": CAMPAIGN.campaign_status ] ]

    Alamofire.request(.POST, postsEndpoint, parameters: authAndFieldsDict, encoding: .JSON).responseJSON { (request, response, data, error) in

      if let anError = error {

        println("error calling POST on /posts")
        println(error)

      } else if let jsonData: AnyObject = data {
        if let dataString = (jsonData.valueForKey("d") as! String).dataUsingEncoding(NSUTF8StringEncoding) {
            let json = JSON(data: dataString)  //use this object to parse data
            
            //SAMPLE PARSING
            let varData = json["returnObject"][0]["object"].stringValue

            // ----------
            // BELOW REPRESENTS AN EXAMPLE USING PURE SWIFT JSONSERIALIZATION INSTEAD OF SWIFTYJSON --------//

            //          if let endCampaignDict = NSJSONSerialization.JSONObjectWithData(encoString, options: .MutableContainers, error: nil) as? NSDictionary {
            //            if let returnObjectArray = endCampaignDict["returnObject"] as? NSArray {
            //
            //              for endCampaignObject in returnObjectArray {
            //                endCampaignObjects.append(endCampaignObject)
            //                if let item = endCampaignObject["object_name"] as? NSDictionary {
            //                  let varItem = item["field_name"] as! String
            //                }
            //              }
            //
            //              println("\n\(endCampaignObjects.count) Total")
            //            }
            //          }
        }
      }
    }
  }



            
<!DOCTYPE html>
<html>
<head>
<title>API Call - endCampaign</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
   $(function() {
      var dataValue = {
         
            "auth": {
                "api_username": "", 
                "api_password": "", 
                "api_key": "", 
                "company_no": 0, 
                "username": "", 
                "password": "", 
                "timezone_offset": 0, 
                "auth_type": "", 
                "system_name": "", 
                "system_company_no": 0, 
                },
            
            "campaign": {
                "campaign_name": "", 
                "totalWait": <int>, 
                "trigger_value": "", 
                "company_no": 0, 
                "totalQueue": <int>, 
                "trigger_type": "", 
                "created_on": "1/1/1900 12:00 AM", 
                "totalSent": <int>, 
                "trigger_no": 0, 
                "totalFailed": <int>, 
                "includeItems": false, 
                "reference_action": "", 
                "totalCustomers": <int>, 
                "campaign_type": "", 
                "wait_time": 0, 
                "assign_type": "", 
                "user_no": 0, 
                "assign_no": 0, 
                "message_type": "", 
                "item_title": "", 
                "campaign_assign_no": 0, 
                "campaign_description": "", 
                "campaign_no": 0, 
                "campaign_start": "1/1/1900 12:00 AM", 
                "campaign_end": "1/1/1900 12:00 AM", 
                "reference_type": "", 
                "reference_no": 0, 
                "order_no": 0, 
                "campaign_status": "", 
                },
            
      };
      
      $.ajax({
         url: 'https://api.peoplevine.com/campaign.asmx/endCampaign',
         type: 'POST',
         data: JSON.stringify(dataValue),
         contentType: 'application/json; charset=utf-8',
         dataType: 'json',
         error: function (XMLHttpRequest, textStatus, errorThrown) {
                alert("ERROR");
         },
         success: function (result) {
                var obj = JSON.parse(result.d).returnObject;

                $.each(obj, function(i) {
                    $("#divID").html(obj[i].field_name); //do something with the data
                })
         }
      })
   });
</script>
</body>
</html>
            
    
System.Net.HttpWebRequest req = System.Net.HttpWebRequest.Create("https://api.peoplevine.com/campaign.asmx/endCampaign");
req.Method = "POST";
req.ContentType = "application/json; charset=utf-8";

string dataValue = "{auth: {api_username: <string>, api_password: <string>, api_key: <string>, company_no: <double>, username: <string>, password: <string>, timezone_offset: <double>, auth_type: <string>, system_name: <string>, system_company_no: <double> },campaign: {campaign_name: <string>, totalWait: <int>, trigger_value: <string>, company_no: <double>, totalQueue: <int>, trigger_type: <string>, created_on: <dateTime>, totalSent: <int>, trigger_no: <double>, totalFailed: <int>, includeItems: <boolean>, reference_action: <string>, totalCustomers: <int>, campaign_type: <string>, wait_time: <double>, assign_type: <string>, user_no: <double>, assign_no: <double>, message_type: <string>, item_title: <string>, campaign_assign_no: <double>, campaign_description: <string>, campaign_no: <double>, campaign_start: <dateTime>, campaign_end: <dateTime>, reference_type: <string>, reference_no: <double>, order_no: <double>, campaign_status: <string> }}";

ASCIIEncoding encoding = new ASCIIEncoding();
byte[] bytes = encoding.GetBytes(dataValue);

req.ContentLength = bytes.Length;

System.IO.Stream strm = req.GetRequestStream();
strm.Write(bytes, 0, bytes.Length);
strm.Close();

System.Net.HttpWebResponse rsp = req.GetResponse();
System.IO.Stream data = rsp.GetResponseStream();
System.IO.StreamReader rdr = new System.IO.StreamReader(data);

string response = rdr.ReadToEnd();

Dim req As System.Net.HttpWebRequest = System.Net.HttpWebRequest.Create("https://api.peoplevine.com/campaign.asmx/endCampaign")
req.Method = "POST"
req.ContentType = "application/json; charset=utf-8"
        
Dim dataValue As String = "{auth: {api_username: <string>, api_password: <string>, api_key: <string>, company_no: <double>, username: <string>, password: <string>, timezone_offset: <double>, auth_type: <string>, system_name: <string>, system_company_no: <double> },campaign: {campaign_name: <string>, totalWait: <int>, trigger_value: <string>, company_no: <double>, totalQueue: <int>, trigger_type: <string>, created_on: <dateTime>, totalSent: <int>, trigger_no: <double>, totalFailed: <int>, includeItems: <boolean>, reference_action: <string>, totalCustomers: <int>, campaign_type: <string>, wait_time: <double>, assign_type: <string>, user_no: <double>, assign_no: <double>, message_type: <string>, item_title: <string>, campaign_assign_no: <double>, campaign_description: <string>, campaign_no: <double>, campaign_start: <dateTime>, campaign_end: <dateTime>, reference_type: <string>, reference_no: <double>, order_no: <double>, campaign_status: <string> }}"
        
Dim encoding As New ASCIIEncoding()
Dim bytes As Byte() = encoding.GetBytes(dataValue)
        
req.ContentLength = bytes.Length
        
Dim strm As System.IO.Stream = req.GetRequestStream()
strm.Write(bytes, 0, bytes.Length)
strm.Close()
        
Dim rsp As System.Net.HttpWebResponse = req.GetResponse()
Dim data As System.IO.Stream = rsp.GetResponseStream()
Dim rdr As New System.IO.StreamReader(data)

Dim response As String = rdr.ReadToEnd()
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;

import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample {

  public static void main(String[] args) {
   HttpClient httpclient = HttpClients.createDefault();

   try
   {
      URIBuilder builder = new URIBuilder("https://peoplevine.azure-api.net/customer/customer/registerCustomer");
      // Specify your subscription key
      builder.setParameter("subscription-key", "");
      URI uri = builder.build();
      HttpPost request = new HttpPost(uri);
      StringEntity reqEntity = new StringEntity("", ContentType.create("application/json"));
      request.setEntity(reqEntity);
      HttpResponse response = httpclient.execute(request);
      HttpEntity entity = response.getEntity();
      if (entity != null) {
         System.out.println(EntityUtils.toString(entity));
      }
   }
   catch (Exception e)
   {
      System.out.println(e.getMessage());
   }
  }
}
<?php

// This sample uses the HTTP_Request2 package. (for more information: http://pear.php.net/package/HTTP_Request2)
require_once 'HTTP/Request2.php';
$headers = array(
   'Content-Type' => 'application/json',
);

$query_params = array(
   // Specify your subscription key
   'subscription-key' => '',
);

$request = new Http_Request2('https://peoplevine.azure-api.net/customer/customer/registerCustomer');
$request->setMethod(HTTP_Request2::METHOD_POST);
// Basic Authorization Sample
// $request-setAuth('{username}', '{password}');
$request->setHeader($headers);

$url = $request->getUrl();
$url->setQueryVariables($query_params);
$request->setBody("");

try
{
   $response = $request->send();
   
   echo $response->getBody();
}
catch (HttpException $ex)
{
   echo $ex;
}

?>

    #import <Foundation/Foundation.h>
    
    NSDictionary *authDic = [NSDictionary dictionaryWithObjectsAndKeys:
            <string>, @"api_username",
            <string>, @"api_password",
            <string>, @"api_key",
            <double>, @"company_no",
            <string>, @"username",
            <string>, @"password",
            <double>, @"timezone_offset",
            <string>, @"auth_type",
            <string>, @"system_name",
            <double>, @"system_company_no", nil];
    
    NSDictionary *campaignDic = [NSDictionary dictionaryWithObjectsAndKeys:
            <string>, @"campaign_name",
            <int>, @"totalWait",
            <string>, @"trigger_value",
            <double>, @"company_no",
            <int>, @"totalQueue",
            <string>, @"trigger_type",
            <dateTime>, @"created_on",
            <int>, @"totalSent",
            <double>, @"trigger_no",
            <int>, @"totalFailed",
            <boolean>, @"includeItems",
            <string>, @"reference_action",
            <int>, @"totalCustomers",
            <string>, @"campaign_type",
            <double>, @"wait_time",
            <string>, @"assign_type",
            <double>, @"user_no",
            <double>, @"assign_no",
            <string>, @"message_type",
            <string>, @"item_title",
            <double>, @"campaign_assign_no",
            <string>, @"campaign_description",
            <double>, @"campaign_no",
            <dateTime>, @"campaign_start",
            <dateTime>, @"campaign_end",
            <string>, @"reference_type",
            <double>, @"reference_no",
            <double>, @"order_no",
            <string>, @"campaign_status", nil];
    
    NSDictionary *finalDic = [NSDictionary dictionaryWithObjectsAndKeys:
                authDic, @"auth",campaignDic, @"campaign", nil];
 
    NSMutableDictionary* jsonString = nil;
    jsonString = [NSJSONSerialization JSONObjectWithData: findalDic options:NSJSONReadingMutableContainers];
    
    NSMutableData *bodyData = [NSMutableData dataWithData:[jsonString dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSString *urlString = @"https://api.peoplevine.com/campaign.asmx/endCampaign";
    
    ASIFormDataRequest *request = [ASIFormDataRequest requestWithURL:[NSURL URLWithString:urlString]];    
    [request setTimeOutSeconds:250];    
    [request setRequestMethod:@"POST"];    
    [request addRequestHeader:@"Content-Type" value:@"application/json"];    
    [request addRequestHeader:[NSString stringWithFormat:@"%d",bodyData.length] value:@"Content-length"];    
    [request setPostBody:bodyData];    
    [request startSynchronous];

    NSDictionary *responseDic = (NSDictionary*)[request.responseString JSONValue];   
   
    if (responseDic || [responseDic objectForKey:@"d"])
    {
        NSMutableDictionary *dicSave=[responseDic objectForKey:@"d"];
        // -------------------------------------------------------------------
        // convert into the data and NSUTF8StringEncoding
        // -------------------------------------------------------------------
        NSString *strDic=[dicSave copy];
        NSMutableDictionary *dirJson;
        if (strDic)
        {
            NSData* dataFile=[strDic dataUsingEncoding:NSUTF8StringEncoding];
            NSString* newStr = [[NSString alloc] initWithData:dataFile
                                                     encoding:NSUTF8StringEncoding];
           
            dirJson = [newStr JSONValue] ;
        }
        // -------------------------------------------------------------------
        
        NSString *str=[[dirJson objectForKey:@"returnObject"]valueForKey:@"customer_no"];
    }
    else
    {
        UIAlertView *alert=[[UIAlertView alloc]initWithTitle:@"Error" message:@"An Error Occurred" delegate:nil cancelButtonTitle:@"Ok" otherButtonTitles:nil];
        [alert show];
    }
require 'net/http'

uri = URI('https://peoplevine.azure-api.net/customer/customer/registerCustomer')

uri.query = URI.encode_www_form({
   # Specify your subscription key
   'subscription-key' => '',
})

request = Net::HTTP::Post.new(uri.request_uri)

# Basic Authorization Sample
# request.basic_auth 'username', 'password'
request['Content-type'] = 'application/json'

request.body = ""

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
   # Basic Authorization Sample
   # 'Authorization': 'Basic %s' % base64.encodestring('{username}:{password}'),
   'Content-type': 'application/json',
}

params = urllib.urlencode({
   # Specify your subscription key
   'subscription-key': '',
})

try:
   conn = httplib.HTTPSConnection('peoplevine.azure-api.net')
   conn.request("POST", "/customer/customer/registerCustomer?%s" % params, "", headers)
   response = conn.getresponse()
   data = response.read()
   print(data)
   conn.close()
except Exception as e:
   print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
   # Basic Authorization Sample
   # 'Authorization': 'Basic %s' % base64.encodestring('{username}:{password}'),
   'Content-type': 'application/json',
}

params = urllib.parse.urlencode({
   # Specify your subscription key
   'subscription-key': '',
})

try:
   conn = http.client.HTTPSConnection('peoplevine.azure-api.net')
   conn.request("POST", "/customer/customer/registerCustomer?%s" % params, "", headers)
   response = conn.getresponse()
   data = response.read()
   print(data)
   conn.close()
except Exception as e:
   print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
@ECHO OFF

REM for Basic Authorization use: --user {username}:{password}
REM Specify values for path parameters (shown as {...}), your subscription key and values for query parameters
curl -v -X POST "https://peoplevine.azure-api.net/customer/customer/registerCustomer?subscription-key="^
 -H "Content-Type: application/json"