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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<ClientSignProposalsV2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PortfolioLinkApi.ServiceModel">
  <Accept>false</Accept>
  <Browser>String</Browser>
  <GeoLocation xmlns:d2p1="http://schemas.datacontract.org/2004/07/PortfolioLinkApi.ServiceModel.Types">
    <d2p1:City>String</d2p1:City>
    <d2p1:ContinentCode>String</d2p1:ContinentCode>
    <d2p1:ContinentName>String</d2p1:ContinentName>
    <d2p1:CountryCode>String</d2p1:CountryCode>
    <d2p1:CountryName>String</d2p1:CountryName>
    <d2p1:Ip>String</d2p1:Ip>
    <d2p1:Latitude>0</d2p1:Latitude>
    <d2p1:Location>
      <d2p1:Capital>String</d2p1:Capital>
      <d2p1:GeonameId>0</d2p1:GeonameId>
    </d2p1:Location>
    <d2p1:Longitude>0</d2p1:Longitude>
    <d2p1:RegionCode>String</d2p1:RegionCode>
    <d2p1:RegionName>String</d2p1:RegionName>
    <d2p1:Type>String</d2p1:Type>
    <d2p1:Zip>0</d2p1:Zip>
  </GeoLocation>
  <GoalId>0</GoalId>
  <Guid>String</Guid>
  <IpAddress>String</IpAddress>
  <Name>String</Name>
  <Password>String</Password>
  <RejectReason>String</RejectReason>
</ClientSignProposalsV2>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SignProposalsV2Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PortfolioLinkApi.ServiceModel">
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/PortfolioLinkApi.ServiceModel.Types">
    <d2p1:Accepted>false</d2p1:Accepted>
    <d2p1:Browser>String</d2p1:Browser>
    <d2p1:EntityId>0</d2p1:EntityId>
    <d2p1:EntityType>String</d2p1:EntityType>
    <d2p1:GeoLocation>
      <d2p1:City>String</d2p1:City>
      <d2p1:ContinentCode>String</d2p1:ContinentCode>
      <d2p1:ContinentName>String</d2p1:ContinentName>
      <d2p1:CountryCode>String</d2p1:CountryCode>
      <d2p1:CountryName>String</d2p1:CountryName>
      <d2p1:Ip>String</d2p1:Ip>
      <d2p1:Latitude>0</d2p1:Latitude>
      <d2p1:Location>
        <d2p1:Capital>String</d2p1:Capital>
        <d2p1:GeonameId>0</d2p1:GeonameId>
      </d2p1:Location>
      <d2p1:Longitude>0</d2p1:Longitude>
      <d2p1:RegionCode>String</d2p1:RegionCode>
      <d2p1:RegionName>String</d2p1:RegionName>
      <d2p1:Type>String</d2p1:Type>
      <d2p1:Zip>0</d2p1:Zip>
    </d2p1:GeoLocation>
    <d2p1:IpAddress>String</d2p1:IpAddress>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:RejectReason>String</d2p1:RejectReason>
    <d2p1:Signed>0001-01-01T00:00:00</d2p1:Signed>
  </Result>
</SignProposalsV2Response>