Compose API - Write your API documentation in minutes

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	Double	Returns item_no

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

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


    let url = "https://api.peoplevine.com/feedback.asmx/voteNow"
    
    let key = "allowFrequency"
    let allowFrequencyDict: Dictionary<String, AnyObject> = [],
    let finalDict = User.getAuthDict(dictToAdd: allowFrequencyDict, dictKey: key)
    
    let key = "api_key"
    let api_keyDict: Dictionary<String, AnyObject> = [],
    let finalDict = User.getAuthDict(dictToAdd: api_keyDict, dictKey: key)
    
    let key = "api_password"
    let api_passwordDict: Dictionary<String, AnyObject> = [],
    let finalDict = User.getAuthDict(dictToAdd: api_passwordDict, dictKey: key)
    
    let key = "api_username"
    let api_usernameDict: Dictionary<String, AnyObject> = [],
    let finalDict = User.getAuthDict(dictToAdd: api_usernameDict, dictKey: key)
    
    let key = "company_no"
    let company_noDict: Dictionary<String, AnyObject> = [],
    let finalDict = User.getAuthDict(dictToAdd: company_noDict, dictKey: key)
    
    let key = "customer_no"
    let customer_noDict: Dictionary<String, AnyObject> = [],
    let finalDict = User.getAuthDict(dictToAdd: customer_noDict, dictKey: key)
    
    let key = "device_info"
    let device_infoDict: Dictionary<String, AnyObject> = [],
    let finalDict = User.getAuthDict(dictToAdd: device_infoDict, dictKey: key)
    
    let key = "ip_address"
    let ip_addressDict: Dictionary<String, AnyObject> = [],
    let finalDict = User.getAuthDict(dictToAdd: ip_addressDict, dictKey: key)
    
    let key = "password"
    let passwordDict: Dictionary<String, AnyObject> = [],
    let finalDict = User.getAuthDict(dictToAdd: passwordDict, dictKey: key)
    
    let key = "reference_type"
    let reference_typeDict: Dictionary<String, AnyObject> = [],
    let finalDict = User.getAuthDict(dictToAdd: reference_typeDict, dictKey: key)
    
    let key = "reference_value"
    let reference_valueDict: Dictionary<String, AnyObject> = [],
    let finalDict = User.getAuthDict(dictToAdd: reference_valueDict, dictKey: key)
    
    let key = "session_id"
    let session_idDict: Dictionary<String, AnyObject> = [],
    let finalDict = User.getAuthDict(dictToAdd: session_idDict, dictKey: key)
    
    let key = "username"
    let usernameDict: Dictionary<String, AnyObject> = [],
    let finalDict = User.getAuthDict(dictToAdd: usernameDict, dictKey: key)
    
    let key = "vote_comment"
    let vote_commentDict: Dictionary<String, AnyObject> = [],
    let finalDict = User.getAuthDict(dictToAdd: vote_commentDict, dictKey: key)
    
    let key = "vote_status"
    let vote_statusDict: Dictionary<String, AnyObject> = [],
    let finalDict = User.getAuthDict(dictToAdd: vote_statusDict, dictKey: key)
    
    let key = "vote_type"
    let vote_typeDict: Dictionary<String, AnyObject> = [],
    let finalDict = User.getAuthDict(dictToAdd: vote_typeDict, dictKey: key)
    
    let key = "vote_value"
    let vote_valueDict: Dictionary<String, AnyObject> = []
    let finalDict = User.getAuthDict(dictToAdd: vote_valueDict, 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 ALLOWFREQUENCY {}
    
struct API_KEY {}
    
struct API_PASSWORD {}
    
struct API_USERNAME {}
    
struct COMPANY_NO {}
    
struct CUSTOMER_NO {}
    
struct DEVICE_INFO {}
    
struct IP_ADDRESS {}
    
struct PASSWORD {}
    
struct REFERENCE_TYPE {}
    
struct REFERENCE_VALUE {}
    
struct SESSION_ID {}
    
struct USERNAME {}
    
struct VOTE_COMMENT {}
    
struct VOTE_STATUS {}
    
struct VOTE_TYPE {}
    
struct VOTE_VALUE {}
    
func voteNowRequest() {
    
    var voteNowObjects = [AnyObject]()
    let postsEndpoint: String = "https://api.peoplevine.com/feedback.asmx/voteNow"

    let authAndFieldsDict = ["allowFrequency": [], "api_key": [], "api_password": [], "api_username": [], "company_no": [], "customer_no": [], "device_info": [], "ip_address": [], "password": [], "reference_type": [], "reference_value": [], "session_id": [], "username": [], "vote_comment": [], "vote_status": [], "vote_type": [], "vote_value": [] ]

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

<!DOCTYPE html>
<html>
<head>
<title>API Call - voteNow</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 = {
         
            "allowFrequency": {
                },
            
            "api_key": {
                },
            
            "api_password": {
                },
            
            "api_username": {
                },
            
            "company_no": {
                },
            
            "customer_no": {
                },
            
            "device_info": {
                },
            
            "ip_address": {
                },
            
            "password": {
                },
            
            "reference_type": {
                },
            
            "reference_value": {
                },
            
            "session_id": {
                },
            
            "username": {
                },
            
            "vote_comment": {
                },
            
            "vote_status": {
                },
            
            "vote_type": {
                },
            
            "vote_value": {
                },
            
      };
      
      $.ajax({
         url: 'https://api.peoplevine.com/feedback.asmx/voteNow',
         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/feedback.asmx/voteNow");
req.Method = "POST";
req.ContentType = "application/json; charset=utf-8";

string dataValue = "{allowFrequency: {},api_key: {},api_password: {},api_username: {},company_no: {},customer_no: {},device_info: {},ip_address: {},password: {},reference_type: {},reference_value: {},session_id: {},username: {},vote_comment: {},vote_status: {},vote_type: {},vote_value: {}}";

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/feedback.asmx/voteNow")
req.Method = "POST"
req.ContentType = "application/json; charset=utf-8"
        
Dim dataValue As String = "{allowFrequency: {},api_key: {},api_password: {},api_username: {},company_no: {},customer_no: {},device_info: {},ip_address: {},password: {},reference_type: {},reference_value: {},session_id: {},username: {},vote_comment: {},vote_status: {},vote_type: {},vote_value: {}}"
        
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 *allowFrequencyDic = [NSDictionary dictionaryWithObjectsAndKeys: nil];
    
    NSDictionary *api_keyDic = [NSDictionary dictionaryWithObjectsAndKeys: nil];
    
    NSDictionary *api_passwordDic = [NSDictionary dictionaryWithObjectsAndKeys: nil];
    
    NSDictionary *api_usernameDic = [NSDictionary dictionaryWithObjectsAndKeys: nil];
    
    NSDictionary *company_noDic = [NSDictionary dictionaryWithObjectsAndKeys: nil];
    
    NSDictionary *customer_noDic = [NSDictionary dictionaryWithObjectsAndKeys: nil];
    
    NSDictionary *device_infoDic = [NSDictionary dictionaryWithObjectsAndKeys: nil];
    
    NSDictionary *ip_addressDic = [NSDictionary dictionaryWithObjectsAndKeys: nil];
    
    NSDictionary *passwordDic = [NSDictionary dictionaryWithObjectsAndKeys: nil];
    
    NSDictionary *reference_typeDic = [NSDictionary dictionaryWithObjectsAndKeys: nil];
    
    NSDictionary *reference_valueDic = [NSDictionary dictionaryWithObjectsAndKeys: nil];
    
    NSDictionary *session_idDic = [NSDictionary dictionaryWithObjectsAndKeys: nil];
    
    NSDictionary *usernameDic = [NSDictionary dictionaryWithObjectsAndKeys: nil];
    
    NSDictionary *vote_commentDic = [NSDictionary dictionaryWithObjectsAndKeys: nil];
    
    NSDictionary *vote_statusDic = [NSDictionary dictionaryWithObjectsAndKeys: nil];
    
    NSDictionary *vote_typeDic = [NSDictionary dictionaryWithObjectsAndKeys: nil];
    
    NSDictionary *vote_valueDic = [NSDictionary dictionaryWithObjectsAndKeys: nil];
    
    NSDictionary *finalDic = [NSDictionary dictionaryWithObjectsAndKeys:
                allowFrequencyDic, @"allowFrequency",api_keyDic, @"api_key",api_passwordDic, @"api_password",api_usernameDic, @"api_username",company_noDic, @"company_no",customer_noDic, @"customer_no",device_infoDic, @"device_info",ip_addressDic, @"ip_address",passwordDic, @"password",reference_typeDic, @"reference_type",reference_valueDic, @"reference_value",session_idDic, @"session_id",usernameDic, @"username",vote_commentDic, @"vote_comment",vote_statusDic, @"vote_status",vote_typeDic, @"vote_type",vote_valueDic, @"vote_value", nil];
 
    NSMutableDictionary* jsonString = nil;
    jsonString = [NSJSONSerialization JSONObjectWithData: findalDic options:NSJSONReadingMutableContainers];
    
    NSMutableData *bodyData = [NSMutableData dataWithData:[jsonString dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSString *urlString = @"https://api.peoplevine.com/feedback.asmx/voteNow";
    
    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"

voteNow

INPUT

OUTPUT

Sample Code