PortfolioLinkApi

<back to all web services

GetUsers

Requires Authentication
The following routes are available for this service:
All Verbs/users
GetUsersResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformList<CustomUserAuth>No
CustomUserAuth Parameters:
NameParameterData TypeRequiredDescription
PartnerIdformintNo
DefaultProfileUrlformstringNo
SignatureformstringNo
SignatureUrlformstringNo
IpAddressformstringNo
RefSourceformstringNo
RefUrnformstringNo
BannedformDateTime?No
BannedByformstringNo
NotesformstringNo
DisableEmailsformDateTime?No
CreatedByformstringNo
UserAuth Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
UserNameformstringNo
EmailformstringNo
PrimaryEmailformstringNo
PhoneNumberformstringNo
FirstNameformstringNo
LastNameformstringNo
DisplayNameformstringNo
CompanyformstringNo
BirthDateformDateTime?No
BirthDateRawformstringNo
AddressformstringNo
Address2formstringNo
CityformstringNo
StateformstringNo
CountryformstringNo
CultureformstringNo
FullNameformstringNo
GenderformstringNo
LanguageformstringNo
MailAddressformstringNo
NicknameformstringNo
PostalCodeformstringNo
TimeZoneformstringNo
SaltformstringNo
PasswordHashformstringNo
DigestHa1HashformstringNo
RolesformList<string>No
PermissionsformList<string>No
CreatedDateformDateTimeNo
ModifiedDateformDateTimeNo
InvalidLoginAttemptsformintNo
LastLoginAttemptformDateTime?No
LockedDateformDateTime?No
RecoveryTokenformstringNo
RefIdformint?No
RefIdStrformstringNo
MetaformDictionary<string, string>No

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

HTTP + CSV

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

POST /users HTTP/1.1 
Host: api.portfoliolink.co.za 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

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

{"result":[{"partnerId":0,"defaultProfileUrl":"String","signature":"String","signatureUrl":"String","ipAddress":"String","refSource":"String","refUrn":"String","banned":"0001-01-01T00:00:00.0000000","bannedBy":"String","notes":"String","disableEmails":"0001-01-01T00:00:00.0000000","createdBy":"String","id":0,"userName":"String","email":"String","primaryEmail":"String","phoneNumber":"String","firstName":"String","lastName":"String","displayName":"String","company":"String","birthDate":"0001-01-01T00:00:00.0000000","birthDateRaw":"String","address":"String","address2":"String","city":"String","state":"String","country":"String","culture":"String","fullName":"String","gender":"String","language":"String","mailAddress":"String","nickname":"String","postalCode":"String","timeZone":"String","salt":"String","passwordHash":"String","digestHa1Hash":"String","roles":["String"],"permissions":["String"],"createdDate":"0001-01-01T00:00:00.0000000","modifiedDate":"0001-01-01T00:00:00.0000000","invalidLoginAttempts":0,"lastLoginAttempt":"0001-01-01T00:00:00.0000000","lockedDate":"0001-01-01T00:00:00.0000000","recoveryToken":"String","refId":0,"refIdStr":"String","meta":{"String":"String"}}]}