PortfolioLinkApi

<back to all web services

SessionInfo

Requires Authentication
The following routes are available for this service:
All Verbs/my-session
SessionInfoResponse Parameters:
NameParameterData TypeRequiredDescription
MetaformDictionary<string, string>No
CreatedformDateTimeNo
PartnerIdformintNo
IdformstringNo
ReferrerUrlformstringNo
UserAuthIdformstringNo
UserAuthNameformstringNo
UserNameformstringNo
DisplayNameformstringNo
FirstNameformstringNo
LastNameformstringNo
EmailformstringNo
CreatedAtformDateTimeNo
LastModifiedformDateTimeNo
RolesformList<string>No
PermissionsformList<string>No
UserPartnersformList<UserPartners>No
IsAuthenticatedformboolNo
AuthProviderformstringNo
ProfileUrlformstringNo
GithubProfileUrlformstringNo
TwitterProfileUrlformstringNo
AccessTokenformstringNo
AvatarUrlformstringNo
SignatureformstringNo
ResponseStatusformResponseStatusNo
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 /my-session 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

{
	meta: 
	{
		String: String
	},
	created: 0001-01-01,
	partnerId: 0,
	id: String,
	referrerUrl: String,
	userAuthId: String,
	userAuthName: String,
	userName: String,
	displayName: String,
	firstName: String,
	lastName: String,
	email: String,
	createdAt: 0001-01-01,
	lastModified: 0001-01-01,
	roles: 
	[
		String
	],
	permissions: 
	[
		String
	],
	userPartners: 
	[
		{
			id: 0,
			userId: 0,
			email: String,
			partnerId: 0,
			isSelected: False,
			partnerName: String
		}
	],
	isAuthenticated: False,
	authProvider: String,
	profileUrl: String,
	githubProfileUrl: String,
	twitterProfileUrl: String,
	accessToken: String,
	avatarUrl: String,
	signature: String,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}