PortfolioLinkApi

<back to all web services

ClientSignProposalsV2

The following routes are available for this service:
All Verbs/v2/client/proposals/sign
ClientSignProposalsV2 Parameters:
NameParameterData TypeRequiredDescription
GuidquerystringNo
PasswordquerystringNo
AcceptqueryboolNo
GoalIdqueryintNo
BrowserquerystringNo
IpAddressquerystringNo
NamequerystringNo
GeoLocationquerySignGeoLocationNo
RejectReasonquerystringNo
SignGeoLocation Parameters:
NameParameterData TypeRequiredDescription
IpformstringNo
TypeformstringNo
ContinentCodeformstringNo
ContinentNameformstringNo
CountryCodeformstringNo
CountryNameformstringNo
RegionCodeformstringNo
RegionNameformstringNo
CityformstringNo
ZipformlongNo
LatitudeformdoubleNo
LongitudeformdoubleNo
LocationformLocationNo
Location Parameters:
NameParameterData TypeRequiredDescription
GeonameIdformlongNo
CapitalformstringNo
SignProposalsV2Response Parameters:
NameParameterData TypeRequiredDescription
ResultformSignatureDtoNo
SignatureDto Parameters:
NameParameterData TypeRequiredDescription
SignedformDateTimeNo
IpAddressformstringNo
BrowserformstringNo
EntityTypeformstringNo
EntityIdformintNo
NameformstringNo
RejectReasonformstringNo
AcceptedformboolNo
GeoLocationformSignGeoLocationNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v2/client/proposals/sign HTTP/1.1 
Host: api.portfoliolink.co.za 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	guid: String,
	password: String,
	accept: False,
	goalId: 0,
	browser: String,
	ipAddress: String,
	name: String,
	geoLocation: 
	{
		ip: String,
		type: String,
		continentCode: String,
		continentName: String,
		countryCode: String,
		countryName: String,
		regionCode: String,
		regionName: String,
		city: String,
		zip: 0,
		latitude: 0,
		longitude: 0,
		location: 
		{
			geonameId: 0,
			capital: String
		}
	},
	rejectReason: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	{
		signed: 0001-01-01,
		ipAddress: String,
		browser: String,
		entityType: String,
		entityId: 0,
		name: String,
		rejectReason: String,
		accepted: False,
		geoLocation: 
		{
			ip: String,
			type: String,
			continentCode: String,
			continentName: String,
			countryCode: String,
			countryName: String,
			regionCode: String,
			regionName: String,
			city: String,
			zip: 0,
			latitude: 0,
			longitude: 0,
			location: 
			{
				geonameId: 0,
				capital: String
			}
		}
	}
}