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 }, "category": {"assign_type": "", "auth_method": "", "assign_no": 0, "graphic_main": "", "timezone_offset": 0, "api_username": "", "graphic_thumb": "", "reference_type": "", "api_password": "", "meta_title": "", "reference_no": 0, "api_key": "", "meta_keywords": "", "notes_no": 0, "auth_type": "", "meta_description": "", "note_type": "", "category_flag": "", "note_status": "", "username": "", "display_to": "", "followup_date_start": "1/1/1900 12:00 AM", "password": "", "followup_date_end": "1/1/1900 12:00 AM", "order_no": 0, "company_no": 0, "system_name": "", "category_no": 0, "system_company_no": 0, "category_name": "", "sortby": "", "category_description": "", "totalResults": 0, "user_no": 0, "created_on": "1/1/1900 12:00 AM", "category_above": 0, "component_no": 0, "component_name": "" } }
{"auth": {"api_username": "", "api_password": "", "api_key": "", "company_no": 0, "username": "", "password": "" }, "category": {"assign_type": "", "auth_method": "", "assign_no": 0, "graphic_main": "", "timezone_offset": 0, "api_username": "", "graphic_thumb": "", "reference_type": "", "api_password": "", "meta_title": "", "reference_no": 0, "api_key": "", "meta_keywords": "", "notes_no": 0, "auth_type": "", "meta_description": "", "note_type": "", "category_flag": "", "note_status": "", "username": "", "display_to": "", "followup_date_start": "1/1/1900 12:00 AM", "password": "", "followup_date_end": "1/1/1900 12:00 AM", "order_no": 0, "company_no": 0, "system_name": "", "category_no": 0, "system_company_no": 0, "category_name": "", "sortby": "", "category_description": "", "totalResults": 0, "user_no": 0, "created_on": "1/1/1900 12:00 AM", "category_above": 0, "component_no": 0, "component_name": "" } }
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 assign_type = ""
var auth_method = ""
var assign_no = 0
var graphic_main = ""
var timezone_offset = 0
var api_username = ""
var graphic_thumb = ""
var reference_type = ""
var api_password = ""
var meta_title = ""
var reference_no = 0
var api_key = ""
var meta_keywords = ""
var notes_no = 0
var auth_type = ""
var meta_description = ""
var note_type = ""
var category_flag = ""
var note_status = ""
var username = ""
var display_to = ""
var followup_date_start = "1/1/1900 12:00 AM"
var password = ""
var followup_date_end = "1/1/1900 12:00 AM"
var order_no = 0
var company_no = 0
var system_name = ""
var category_no = 0
var system_company_no = 0
var category_name = ""
var sortby = ""
var category_description = ""
var totalResults = 0
var user_no = 0
var created_on = "1/1/1900 12:00 AM"
var category_above = 0
var component_no = 0
var component_name = ""
let url = "https://api.peoplevine.com/general.asmx/updateCategory"
let key = "category"
let categoryDict: Dictionary<String, AnyObject> = ["assign_type": assign_type, "auth_method": auth_method, "assign_no": assign_no, "graphic_main": graphic_main, "timezone_offset": timezone_offset, "api_username": api_username, "graphic_thumb": graphic_thumb, "reference_type": reference_type, "api_password": api_password, "meta_title": meta_title, "reference_no": reference_no, "api_key": api_key, "meta_keywords": meta_keywords, "notes_no": notes_no, "auth_type": auth_type, "meta_description": meta_description, "note_type": note_type, "category_flag": category_flag, "note_status": note_status, "username": username, "display_to": display_to, "followup_date_start": followup_date_start, "password": password, "followup_date_end": followup_date_end, "order_no": order_no, "company_no": company_no, "system_name": system_name, "category_no": category_no, "system_company_no": system_company_no, "category_name": category_name, "sortby": sortby, "category_description": category_description, "totalResults": totalResults, "user_no": user_no, "created_on": created_on, "category_above": category_above, "component_no": component_no, "component_name": component_name ]
let finalDict = User.getAuthDict(dictToAdd: categoryDict, 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 CATEGORY {
static var assign_type = <string>
static var auth_method = <string>
static var assign_no = <double>
static var graphic_main = <string>
static var timezone_offset = <double>
static var api_username = <string>
static var graphic_thumb = <string>
static var reference_type = <string>
static var api_password = <string>
static var meta_title = <string>
static var reference_no = <double>
static var api_key = <string>
static var meta_keywords = <string>
static var notes_no = <double>
static var auth_type = <string>
static var meta_description = <string>
static var note_type = <string>
static var category_flag = <string>
static var note_status = <string>
static var username = <string>
static var display_to = <string>
static var followup_date_start = <dateTime>
static var password = <string>
static var followup_date_end = <dateTime>
static var order_no = <double>
static var company_no = <double>
static var system_name = <string>
static var category_no = <double>
static var system_company_no = <double>
static var category_name = <string>
static var sortby = <string>
static var category_description = <string>
static var totalResults = <double>
static var user_no = <double>
static var created_on = <dateTime>
static var category_above = <double>
static var component_no = <double>
static var component_name = <string>}
func updateCategoryRequest() {
var updateCategoryObjects = [AnyObject]()
let postsEndpoint: String = "https://api.peoplevine.com/general.asmx/updateCategory"
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 ], "category": ["assign_type": CATEGORY.assign_type, "auth_method": CATEGORY.auth_method, "assign_no": CATEGORY.assign_no, "graphic_main": CATEGORY.graphic_main, "timezone_offset": CATEGORY.timezone_offset, "api_username": CATEGORY.api_username, "graphic_thumb": CATEGORY.graphic_thumb, "reference_type": CATEGORY.reference_type, "api_password": CATEGORY.api_password, "meta_title": CATEGORY.meta_title, "reference_no": CATEGORY.reference_no, "api_key": CATEGORY.api_key, "meta_keywords": CATEGORY.meta_keywords, "notes_no": CATEGORY.notes_no, "auth_type": CATEGORY.auth_type, "meta_description": CATEGORY.meta_description, "note_type": CATEGORY.note_type, "category_flag": CATEGORY.category_flag, "note_status": CATEGORY.note_status, "username": CATEGORY.username, "display_to": CATEGORY.display_to, "followup_date_start": CATEGORY.followup_date_start, "password": CATEGORY.password, "followup_date_end": CATEGORY.followup_date_end, "order_no": CATEGORY.order_no, "company_no": CATEGORY.company_no, "system_name": CATEGORY.system_name, "category_no": CATEGORY.category_no, "system_company_no": CATEGORY.system_company_no, "category_name": CATEGORY.category_name, "sortby": CATEGORY.sortby, "category_description": CATEGORY.category_description, "totalResults": CATEGORY.totalResults, "user_no": CATEGORY.user_no, "created_on": CATEGORY.created_on, "category_above": CATEGORY.category_above, "component_no": CATEGORY.component_no, "component_name": CATEGORY.component_name ] ]
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 updateCategoryDict = NSJSONSerialization.JSONObjectWithData(encoString, options: .MutableContainers, error: nil) as? NSDictionary {
// if let returnObjectArray = updateCategoryDict["returnObject"] as? NSArray {
//
// for updateCategoryObject in returnObjectArray {
// updateCategoryObjects.append(updateCategoryObject)
// if let item = updateCategoryObject["object_name"] as? NSDictionary {
// let varItem = item["field_name"] as! String
// }
// }
//
// println("\n\(updateCategoryObjects.count) Total")
// }
// }
}
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>API Call - updateCategory</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,
},
"category": {
"assign_type": "",
"auth_method": "",
"assign_no": 0,
"graphic_main": "",
"timezone_offset": 0,
"api_username": "",
"graphic_thumb": "",
"reference_type": "",
"api_password": "",
"meta_title": "",
"reference_no": 0,
"api_key": "",
"meta_keywords": "",
"notes_no": 0,
"auth_type": "",
"meta_description": "",
"note_type": "",
"category_flag": "",
"note_status": "",
"username": "",
"display_to": "",
"followup_date_start": "1/1/1900 12:00 AM",
"password": "",
"followup_date_end": "1/1/1900 12:00 AM",
"order_no": 0,
"company_no": 0,
"system_name": "",
"category_no": 0,
"system_company_no": 0,
"category_name": "",
"sortby": "",
"category_description": "",
"totalResults": 0,
"user_no": 0,
"created_on": "1/1/1900 12:00 AM",
"category_above": 0,
"component_no": 0,
"component_name": "",
},
};
$.ajax({
url: 'https://api.peoplevine.com/general.asmx/updateCategory',
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/general.asmx/updateCategory");
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> },category: {assign_type: <string>, auth_method: <string>, assign_no: <double>, graphic_main: <string>, timezone_offset: <double>, api_username: <string>, graphic_thumb: <string>, reference_type: <string>, api_password: <string>, meta_title: <string>, reference_no: <double>, api_key: <string>, meta_keywords: <string>, notes_no: <double>, auth_type: <string>, meta_description: <string>, note_type: <string>, category_flag: <string>, note_status: <string>, username: <string>, display_to: <string>, followup_date_start: <dateTime>, password: <string>, followup_date_end: <dateTime>, order_no: <double>, company_no: <double>, system_name: <string>, category_no: <double>, system_company_no: <double>, category_name: <string>, sortby: <string>, category_description: <string>, totalResults: <double>, user_no: <double>, created_on: <dateTime>, category_above: <double>, component_no: <double>, component_name: <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/general.asmx/updateCategory")
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> },category: {assign_type: <string>, auth_method: <string>, assign_no: <double>, graphic_main: <string>, timezone_offset: <double>, api_username: <string>, graphic_thumb: <string>, reference_type: <string>, api_password: <string>, meta_title: <string>, reference_no: <double>, api_key: <string>, meta_keywords: <string>, notes_no: <double>, auth_type: <string>, meta_description: <string>, note_type: <string>, category_flag: <string>, note_status: <string>, username: <string>, display_to: <string>, followup_date_start: <dateTime>, password: <string>, followup_date_end: <dateTime>, order_no: <double>, company_no: <double>, system_name: <string>, category_no: <double>, system_company_no: <double>, category_name: <string>, sortby: <string>, category_description: <string>, totalResults: <double>, user_no: <double>, created_on: <dateTime>, category_above: <double>, component_no: <double>, component_name: <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 *categoryDic = [NSDictionary dictionaryWithObjectsAndKeys:
<string>, @"assign_type",
<string>, @"auth_method",
<double>, @"assign_no",
<string>, @"graphic_main",
<double>, @"timezone_offset",
<string>, @"api_username",
<string>, @"graphic_thumb",
<string>, @"reference_type",
<string>, @"api_password",
<string>, @"meta_title",
<double>, @"reference_no",
<string>, @"api_key",
<string>, @"meta_keywords",
<double>, @"notes_no",
<string>, @"auth_type",
<string>, @"meta_description",
<string>, @"note_type",
<string>, @"category_flag",
<string>, @"note_status",
<string>, @"username",
<string>, @"display_to",
<dateTime>, @"followup_date_start",
<string>, @"password",
<dateTime>, @"followup_date_end",
<double>, @"order_no",
<double>, @"company_no",
<string>, @"system_name",
<double>, @"category_no",
<double>, @"system_company_no",
<string>, @"category_name",
<string>, @"sortby",
<string>, @"category_description",
<double>, @"totalResults",
<double>, @"user_no",
<dateTime>, @"created_on",
<double>, @"category_above",
<double>, @"component_no",
<string>, @"component_name", nil];
NSDictionary *finalDic = [NSDictionary dictionaryWithObjectsAndKeys:
authDic, @"auth",categoryDic, @"category", nil];
NSMutableDictionary* jsonString = nil;
jsonString = [NSJSONSerialization JSONObjectWithData: findalDic options:NSJSONReadingMutableContainers];
NSMutableData *bodyData = [NSMutableData dataWithData:[jsonString dataUsingEncoding:NSUTF8StringEncoding]];
NSString *urlString = @"https://api.peoplevine.com/general.asmx/updateCategory";
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"