| All Verbs | /v2/client/proposals/sign |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Guid | query | string | No | |
| Password | query | string | No | |
| Accept | query | bool | No | |
| GoalId | query | int | No | |
| Browser | query | string | No | |
| IpAddress | query | string | No | |
| Name | query | string | No | |
| GeoLocation | query | SignGeoLocation | No | |
| RejectReason | query | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Ip | form | string | No | |
| Type | form | string | No | |
| ContinentCode | form | string | No | |
| ContinentName | form | string | No | |
| CountryCode | form | string | No | |
| CountryName | form | string | No | |
| RegionCode | form | string | No | |
| RegionName | form | string | No | |
| City | form | string | No | |
| Zip | form | long | No | |
| Latitude | form | double | No | |
| Longitude | form | double | No | |
| Location | form | Location | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| GeonameId | form | long | No | |
| Capital | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Result | form | SignatureDto | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Signed | form | DateTime | No | |
| IpAddress | form | string | No | |
| Browser | form | string | No | |
| EntityType | form | string | No | |
| EntityId | form | int | No | |
| Name | form | string | No | |
| RejectReason | form | string | No | |
| Accepted | form | bool | No | |
| GeoLocation | form | SignGeoLocation | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
}
}
}