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)
{"auth": {"api_username": "", "api_password": "", "api_key": "", "company_no": 0, "username": "", "password": "", "timezone_offset": 0, "auth_type": "", "system_name": "", "system_company_no": 0 }, "cf": {"customer_no": 0, "session_id": "", "product_no": 0, "cart_flag": "", "order_no": 0, "product_type": "", "sortby": "", "returnTotal": 0, "company_no": 0 }, "parameters": {"purchaseTotal": 0, "shipping_carrier": "", "shipping_method": "", "weight_pounds": 0, "isStandardContainer": false, "weight_ounces": 0, "dimensions_width": 0, "dimensions_length": 0, "dimensions_height": 0, "zip_from": "", "zip_to": "", "country_to": "", "contentsValue": 0, "company_no": 0, "state_from": "", "state_to": "", "city_from": "", "city_to": "", "country_from": "", "address_from": "", "address_to": "" } }
{"auth": {"api_username": "", "api_password": "", "api_key": "", "company_no": 0, "username": "", "password": "" }, "cf": {"customer_no": 0, "session_id": "", "product_no": 0, "cart_flag": "", "order_no": 0, "product_type": "", "sortby": "", "returnTotal": 0, "company_no": 0 }, "parameters": {"purchaseTotal": 0, "shipping_carrier": "", "shipping_method": "", "weight_pounds": 0, "isStandardContainer": false, "weight_ounces": 0, "dimensions_width": 0, "dimensions_length": 0, "dimensions_height": 0, "zip_from": "", "zip_to": "", "country_to": "", "contentsValue": 0, "company_no": 0, "state_from": "", "state_to": "", "city_from": "", "city_to": "", "country_from": "", "address_from": "", "address_to": "" } }
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 customer_no = 0
var session_id = ""
var product_no = 0
var cart_flag = ""
var order_no = 0
var product_type = ""
var sortby = ""
var returnTotal = 0
var company_no = 0
var purchaseTotal = 0
var shipping_carrier = ""
var shipping_method = ""
var weight_pounds = 0
var isStandardContainer = false
var weight_ounces = 0
var dimensions_width = 0
var dimensions_length = 0
var dimensions_height = 0
var zip_from = ""
var zip_to = ""
var country_to = ""
var contentsValue = 0
var company_no = 0
var state_from = ""
var state_to = ""
var city_from = ""
var city_to = ""
var country_from = ""
var address_from = ""
var address_to = ""
let url = "https://api.peoplevine.com/commerce.asmx/calculateShippingCost"
let key = "cf"
let cfDict: Dictionary<String, AnyObject> = ["customer_no": customer_no, "session_id": session_id, "product_no": product_no, "cart_flag": cart_flag, "order_no": order_no, "product_type": product_type, "sortby": sortby, "returnTotal": returnTotal, "company_no": company_no ],
let finalDict = User.getAuthDict(dictToAdd: cfDict, dictKey: key)
let key = "parameters"
let parametersDict: Dictionary<String, AnyObject> = ["purchaseTotal": purchaseTotal, "shipping_carrier": shipping_carrier, "shipping_method": shipping_method, "weight_pounds": weight_pounds, "isStandardContainer": isStandardContainer, "weight_ounces": weight_ounces, "dimensions_width": dimensions_width, "dimensions_length": dimensions_length, "dimensions_height": dimensions_height, "zip_from": zip_from, "zip_to": zip_to, "country_to": country_to, "contentsValue": contentsValue, "company_no": company_no, "state_from": state_from, "state_to": state_to, "city_from": city_from, "city_to": city_to, "country_from": country_from, "address_from": address_from, "address_to": address_to ]
let finalDict = User.getAuthDict(dictToAdd: parametersDict, 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 CF {
static var customer_no = <double>
static var session_id = <string>
static var product_no = <double>
static var cart_flag = <string>
static var order_no = <double>
static var product_type = <string>
static var sortby = <string>
static var returnTotal = <double>
static var company_no = <double>}
struct PARAMETERS {
static var purchaseTotal = <double>
static var shipping_carrier = <string>
static var shipping_method = <string>
static var weight_pounds = <double>
static var isStandardContainer = <boolean>
static var weight_ounces = <double>
static var dimensions_width = <double>
static var dimensions_length = <double>
static var dimensions_height = <double>
static var zip_from = <string>
static var zip_to = <string>
static var country_to = <string>
static var contentsValue = <double>
static var company_no = <double>
static var state_from = <string>
static var state_to = <string>
static var city_from = <string>
static var city_to = <string>
static var country_from = <string>
static var address_from = <string>
static var address_to = <string>}
func calculateShippingCostRequest() {
var calculateShippingCostObjects = [AnyObject]()
let postsEndpoint: String = "https://api.peoplevine.com/commerce.asmx/calculateShippingCost"
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 ], "cf": ["customer_no": CF.customer_no, "session_id": CF.session_id, "product_no": CF.product_no, "cart_flag": CF.cart_flag, "order_no": CF.order_no, "product_type": CF.product_type, "sortby": CF.sortby, "returnTotal": CF.returnTotal, "company_no": CF.company_no ], "parameters": ["purchaseTotal": PARAMETERS.purchaseTotal, "shipping_carrier": PARAMETERS.shipping_carrier, "shipping_method": PARAMETERS.shipping_method, "weight_pounds": PARAMETERS.weight_pounds, "isStandardContainer": PARAMETERS.isStandardContainer, "weight_ounces": PARAMETERS.weight_ounces, "dimensions_width": PARAMETERS.dimensions_width, "dimensions_length": PARAMETERS.dimensions_length, "dimensions_height": PARAMETERS.dimensions_height, "zip_from": PARAMETERS.zip_from, "zip_to": PARAMETERS.zip_to, "country_to": PARAMETERS.country_to, "contentsValue": PARAMETERS.contentsValue, "company_no": PARAMETERS.company_no, "state_from": PARAMETERS.state_from, "state_to": PARAMETERS.state_to, "city_from": PARAMETERS.city_from, "city_to": PARAMETERS.city_to, "country_from": PARAMETERS.country_from, "address_from": PARAMETERS.address_from, "address_to": PARAMETERS.address_to ] ]
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 calculateShippingCostDict = NSJSONSerialization.JSONObjectWithData(encoString, options: .MutableContainers, error: nil) as? NSDictionary {
// if let returnObjectArray = calculateShippingCostDict["returnObject"] as? NSArray {
//
// for calculateShippingCostObject in returnObjectArray {
// calculateShippingCostObjects.append(calculateShippingCostObject)
// if let item = calculateShippingCostObject["object_name"] as? NSDictionary {
// let varItem = item["field_name"] as! String
// }
// }
//
// println("\n\(calculateShippingCostObjects.count) Total")
// }
// }
}
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>API Call - calculateShippingCost</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,
},
"cf": {
"customer_no": 0,
"session_id": "",
"product_no": 0,
"cart_flag": "",
"order_no": 0,
"product_type": "",
"sortby": "",
"returnTotal": 0,
"company_no": 0,
},
"parameters": {
"purchaseTotal": 0,
"shipping_carrier": "",
"shipping_method": "",
"weight_pounds": 0,
"isStandardContainer": false,
"weight_ounces": 0,
"dimensions_width": 0,
"dimensions_length": 0,
"dimensions_height": 0,
"zip_from": "",
"zip_to": "",
"country_to": "",
"contentsValue": 0,
"company_no": 0,
"state_from": "",
"state_to": "",
"city_from": "",
"city_to": "",
"country_from": "",
"address_from": "",
"address_to": "",
},
};
$.ajax({
url: 'https://api.peoplevine.com/commerce.asmx/calculateShippingCost',
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/commerce.asmx/calculateShippingCost");
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> },cf: {customer_no: <double>, session_id: <string>, product_no: <double>, cart_flag: <string>, order_no: <double>, product_type: <string>, sortby: <string>, returnTotal: <double>, company_no: <double> },parameters: {purchaseTotal: <double>, shipping_carrier: <string>, shipping_method: <string>, weight_pounds: <double>, isStandardContainer: <boolean>, weight_ounces: <double>, dimensions_width: <double>, dimensions_length: <double>, dimensions_height: <double>, zip_from: <string>, zip_to: <string>, country_to: <string>, contentsValue: <double>, company_no: <double>, state_from: <string>, state_to: <string>, city_from: <string>, city_to: <string>, country_from: <string>, address_from: <string>, address_to: <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/commerce.asmx/calculateShippingCost")
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> },cf: {customer_no: <double>, session_id: <string>, product_no: <double>, cart_flag: <string>, order_no: <double>, product_type: <string>, sortby: <string>, returnTotal: <double>, company_no: <double> },parameters: {purchaseTotal: <double>, shipping_carrier: <string>, shipping_method: <string>, weight_pounds: <double>, isStandardContainer: <boolean>, weight_ounces: <double>, dimensions_width: <double>, dimensions_length: <double>, dimensions_height: <double>, zip_from: <string>, zip_to: <string>, country_to: <string>, contentsValue: <double>, company_no: <double>, state_from: <string>, state_to: <string>, city_from: <string>, city_to: <string>, country_from: <string>, address_from: <string>, address_to: <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 *cfDic = [NSDictionary dictionaryWithObjectsAndKeys:
<double>, @"customer_no",
<string>, @"session_id",
<double>, @"product_no",
<string>, @"cart_flag",
<double>, @"order_no",
<string>, @"product_type",
<string>, @"sortby",
<double>, @"returnTotal",
<double>, @"company_no", nil];
NSDictionary *parametersDic = [NSDictionary dictionaryWithObjectsAndKeys:
<double>, @"purchaseTotal",
<string>, @"shipping_carrier",
<string>, @"shipping_method",
<double>, @"weight_pounds",
<boolean>, @"isStandardContainer",
<double>, @"weight_ounces",
<double>, @"dimensions_width",
<double>, @"dimensions_length",
<double>, @"dimensions_height",
<string>, @"zip_from",
<string>, @"zip_to",
<string>, @"country_to",
<double>, @"contentsValue",
<double>, @"company_no",
<string>, @"state_from",
<string>, @"state_to",
<string>, @"city_from",
<string>, @"city_to",
<string>, @"country_from",
<string>, @"address_from",
<string>, @"address_to", nil];
NSDictionary *finalDic = [NSDictionary dictionaryWithObjectsAndKeys:
authDic, @"auth",cfDic, @"cf",parametersDic, @"parameters", nil];
NSMutableDictionary* jsonString = nil;
jsonString = [NSJSONSerialization JSONObjectWithData: findalDic options:NSJSONReadingMutableContainers];
NSMutableData *bodyData = [NSMutableData dataWithData:[jsonString dataUsingEncoding:NSUTF8StringEncoding]];
NSString *urlString = @"https://api.peoplevine.com/commerce.asmx/calculateShippingCost";
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"