View All Methods in this API

registerCompany

Version 1 This method allows you to register a company.

http://api.peoplevine.com/company.asmx/registerCompany

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 }, "company": {"company_no": 0, "company_name": "", "company_logo": "", "company_logo_byte": <base64Binary>, "company_icon": "", "company_icon_byte": <base64Binary>, "company_bio": "", "web_site": "", "company_email": "", "company_phone": "", "address": "", "address2": "", "city": "", "state": "", "zip_code": "", "country": "", "facebook_url": "", "google_url": "", "twitter_handle": "", "foregroundcolor": "", "backgroundcolor": "", "timezone_offset": 0, "timezone_id": "", "customer_no": 0, "subscription_no": 0, "parent_company_no": 0, "created_on": "1/1/1900 12:00 AM", "user_no": 0 } }
{"auth": {"api_username": "", "api_password": "", "api_key": "", "company_no": 0, "username": "", "password": "" }, "company": {"company_name": "", "company_email": "", "customer_no": 0, "subscription_no": 0, "parent_company_no": 0 } }

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.
returnObject wi_company
company_no double
company_name string
company_logo string You can refer to an external location
company_logo_byte base64Binary You can upload via a byte object
company_icon string You can refer to an external location
company_icon_byte base64Binary You can upload via a byte object
company_bio string
web_site string
company_email string
company_phone string
address string
address2 string
city string
state string
zip_code string
country string
facebook_url string
google_url string
twitter_handle string
foregroundcolor string This will be used in out of the box branding
backgroundcolor string This will be used in out of the box branding
timezone_offset double
timezone_id string
customer_no double This is the main company's billing contact to tie billing to.
subscription_no double This is the main company's subscription_no to tie billing to
parent_company_no double This is the main company's company_no
created_on dateTime
user_no double
{"responseCode": "", "message": "", "isError": false, "methodFailed": "", "extendedMessage": "", "reason": "", "responseTime": 0, "returnObject": {"company_no": 0, "company_name": "", "company_logo": "", "company_logo_byte": <base64Binary>, "company_icon": "", "company_icon_byte": <base64Binary>, "company_bio": "", "web_site": "", "company_email": "", "company_phone": "", "address": "", "address2": "", "city": "", "state": "", "zip_code": "", "country": "", "facebook_url": "", "google_url": "", "twitter_handle": "", "foregroundcolor": "", "backgroundcolor": "", "timezone_offset": 0, "timezone_id": "", "customer_no": 0, "subscription_no": 0, "created_on": "1/1/1900 12:00 AM", "user_no": 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 company_no = 0
    var company_name = ""
    var company_logo = ""
    var company_logo_byte = <base64Binary>
    var company_icon = ""
    var company_icon_byte = <base64Binary>
    var company_bio = ""
    var web_site = ""
    var company_email = ""
    var company_phone = ""
    var address = ""
    var address2 = ""
    var city = ""
    var state = ""
    var zip_code = ""
    var country = ""
    var facebook_url = ""
    var google_url = ""
    var twitter_handle = ""
    var foregroundcolor = ""
    var backgroundcolor = ""
    var timezone_offset = 0
    var timezone_id = ""
    var customer_no = 0
    var subscription_no = 0
    var parent_company_no = 0
    var created_on = "1/1/1900 12:00 AM"
    var user_no = 0

    let url = "http://api.peoplevine.com/company.asmx/registerCompany"
    
    let key = "company"
    let companyDict: Dictionary<String, AnyObject> = ["company_no": company_no, "company_name": company_name, "company_logo": company_logo, "company_logo_byte": company_logo_byte, "company_icon": company_icon, "company_icon_byte": company_icon_byte, "company_bio": company_bio, "web_site": web_site, "company_email": company_email, "company_phone": company_phone, "address": address, "address2": address2, "city": city, "state": state, "zip_code": zip_code, "country": country, "facebook_url": facebook_url, "google_url": google_url, "twitter_handle": twitter_handle, "foregroundcolor": foregroundcolor, "backgroundcolor": backgroundcolor, "timezone_offset": timezone_offset, "timezone_id": timezone_id, "customer_no": customer_no, "subscription_no": subscription_no, "parent_company_no": parent_company_no, "created_on": created_on, "user_no": user_no ]
    let finalDict = User.getAuthDict(dictToAdd: companyDict, 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 COMPANY {
    static var company_no = <double>
    static var company_name = <string>
    static var company_logo = <string>
    static var company_logo_byte = <base64Binary>
    static var company_icon = <string>
    static var company_icon_byte = <base64Binary>
    static var company_bio = <string>
    static var web_site = <string>
    static var company_email = <string>
    static var company_phone = <string>
    static var address = <string>
    static var address2 = <string>
    static var city = <string>
    static var state = <string>
    static var zip_code = <string>
    static var country = <string>
    static var facebook_url = <string>
    static var google_url = <string>
    static var twitter_handle = <string>
    static var foregroundcolor = <string>
    static var backgroundcolor = <string>
    static var timezone_offset = <double>
    static var timezone_id = <string>
    static var customer_no = <double>
    static var subscription_no = <double>
    static var parent_company_no = <double>
    static var created_on = <dateTime>
    static var user_no = <double>}
    
func registerCompanyRequest() {
    
    var registerCompanyObjects = [AnyObject]()
    let postsEndpoint: String = "http://api.peoplevine.com/company.asmx/registerCompany"

    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 ], "company": ["company_no": COMPANY.company_no, "company_name": COMPANY.company_name, "company_logo": COMPANY.company_logo, "company_logo_byte": COMPANY.company_logo_byte, "company_icon": COMPANY.company_icon, "company_icon_byte": COMPANY.company_icon_byte, "company_bio": COMPANY.company_bio, "web_site": COMPANY.web_site, "company_email": COMPANY.company_email, "company_phone": COMPANY.company_phone, "address": COMPANY.address, "address2": COMPANY.address2, "city": COMPANY.city, "state": COMPANY.state, "zip_code": COMPANY.zip_code, "country": COMPANY.country, "facebook_url": COMPANY.facebook_url, "google_url": COMPANY.google_url, "twitter_handle": COMPANY.twitter_handle, "foregroundcolor": COMPANY.foregroundcolor, "backgroundcolor": COMPANY.backgroundcolor, "timezone_offset": COMPANY.timezone_offset, "timezone_id": COMPANY.timezone_id, "customer_no": COMPANY.customer_no, "subscription_no": COMPANY.subscription_no, "parent_company_no": COMPANY.parent_company_no, "created_on": COMPANY.created_on, "user_no": COMPANY.user_no ] ]

    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 registerCompanyDict = NSJSONSerialization.JSONObjectWithData(encoString, options: .MutableContainers, error: nil) as? NSDictionary {
            //            if let returnObjectArray = registerCompanyDict["returnObject"] as? NSArray {
            //
            //              for registerCompanyObject in returnObjectArray {
            //                registerCompanyObjects.append(registerCompanyObject)
            //                if let item = registerCompanyObject["object_name"] as? NSDictionary {
            //                  let varItem = item["field_name"] as! String
            //                }
            //              }
            //
            //              println("\n\(registerCompanyObjects.count) Total")
            //            }
            //          }
        }
      }
    }
  }



            
<!DOCTYPE html>
<html>
<head>
<title>API Call - registerCompany</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, 
                },
            
            "company": {
                "company_no": 0, 
                "company_name": "", 
                "company_logo": "", 
                "company_logo_byte": <base64Binary>, 
                "company_icon": "", 
                "company_icon_byte": <base64Binary>, 
                "company_bio": "", 
                "web_site": "", 
                "company_email": "", 
                "company_phone": "", 
                "address": "", 
                "address2": "", 
                "city": "", 
                "state": "", 
                "zip_code": "", 
                "country": "", 
                "facebook_url": "", 
                "google_url": "", 
                "twitter_handle": "", 
                "foregroundcolor": "", 
                "backgroundcolor": "", 
                "timezone_offset": 0, 
                "timezone_id": "", 
                "customer_no": 0, 
                "subscription_no": 0, 
                "parent_company_no": 0, 
                "created_on": "1/1/1900 12:00 AM", 
                "user_no": 0, 
                },
            
      };
      
      $.ajax({
         url: 'http://api.peoplevine.com/company.asmx/registerCompany',
         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("http://api.peoplevine.com/company.asmx/registerCompany");
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> },company: {company_no: <double>, company_name: <string>, company_logo: <string>, company_logo_byte: <base64Binary>, company_icon: <string>, company_icon_byte: <base64Binary>, company_bio: <string>, web_site: <string>, company_email: <string>, company_phone: <string>, address: <string>, address2: <string>, city: <string>, state: <string>, zip_code: <string>, country: <string>, facebook_url: <string>, google_url: <string>, twitter_handle: <string>, foregroundcolor: <string>, backgroundcolor: <string>, timezone_offset: <double>, timezone_id: <string>, customer_no: <double>, subscription_no: <double>, parent_company_no: <double>, created_on: <dateTime>, user_no: <double> }}";

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("http://api.peoplevine.com/company.asmx/registerCompany")
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> },company: {company_no: <double>, company_name: <string>, company_logo: <string>, company_logo_byte: <base64Binary>, company_icon: <string>, company_icon_byte: <base64Binary>, company_bio: <string>, web_site: <string>, company_email: <string>, company_phone: <string>, address: <string>, address2: <string>, city: <string>, state: <string>, zip_code: <string>, country: <string>, facebook_url: <string>, google_url: <string>, twitter_handle: <string>, foregroundcolor: <string>, backgroundcolor: <string>, timezone_offset: <double>, timezone_id: <string>, customer_no: <double>, subscription_no: <double>, parent_company_no: <double>, created_on: <dateTime>, user_no: <double> }}"
        
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 *companyDic = [NSDictionary dictionaryWithObjectsAndKeys:
            <double>, @"company_no",
            <string>, @"company_name",
            <string>, @"company_logo",
            <base64Binary>, @"company_logo_byte",
            <string>, @"company_icon",
            <base64Binary>, @"company_icon_byte",
            <string>, @"company_bio",
            <string>, @"web_site",
            <string>, @"company_email",
            <string>, @"company_phone",
            <string>, @"address",
            <string>, @"address2",
            <string>, @"city",
            <string>, @"state",
            <string>, @"zip_code",
            <string>, @"country",
            <string>, @"facebook_url",
            <string>, @"google_url",
            <string>, @"twitter_handle",
            <string>, @"foregroundcolor",
            <string>, @"backgroundcolor",
            <double>, @"timezone_offset",
            <string>, @"timezone_id",
            <double>, @"customer_no",
            <double>, @"subscription_no",
            <double>, @"parent_company_no",
            <dateTime>, @"created_on",
            <double>, @"user_no", nil];
    
    NSDictionary *finalDic = [NSDictionary dictionaryWithObjectsAndKeys:
                authDic, @"auth",companyDic, @"company", nil];
 
    NSMutableDictionary* jsonString = nil;
    jsonString = [NSJSONSerialization JSONObjectWithData: findalDic options:NSJSONReadingMutableContainers];
    
    NSMutableData *bodyData = [NSMutableData dataWithData:[jsonString dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSString *urlString = @"http://api.peoplevine.com/company.asmx/registerCompany";
    
    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"