PortfolioLinkApi

<back to all web services

GetUserSignature

Requires Authentication
The following routes are available for this service:
All Verbs/user/signature
GetUserInfoResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
UserNameformstringNo
EmailformstringNo
CreatedformDateTimeNo
SignatureformstringNo
AvatarUrlformstringNo
UserActivityformUserActivityNo
UserPartnersformList<UserPartners>No
PartnerIdformintNo
ResponseStatusformResponseStatusNo
UserActivity Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
UserNameformstringNo
CreatedformDateTimeNo
ModifiedformDateTimeNo
UserPartners Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
UserIdformintNo
EmailformstringNo
PartnerIdformintNo
IsSelectedformboolNo
PartnerNameformstringNo

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 /user/signature HTTP/1.1 
Host: api.portfoliolink.co.za 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	id: 0,
	userName: String,
	email: String,
	created: 0001-01-01,
	signature: String,
	avatarUrl: String,
	userActivity: 
	{
		id: 0,
		userName: String,
		created: 0001-01-01,
		modified: 0001-01-01
	},
	userPartners: 
	[
		{
			id: 0,
			userId: 0,
			email: String,
			partnerId: 0,
			isSelected: False,
			partnerName: String
		}
	],
	partnerId: 0,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}