Net3 API Interface for Customer Portal

<back to all web services

LoginUserMembership

Login User Memberships Actions

Requires Authentication
The following routes are available for this service:
GET/user/{userId}/membershipsRetrieve Memberships for a User.
POST/user/{userId}/membershipsCreate Membership for a User.
GET/user/{userId}/memberships/{membershipId}Retrieve specific Membership for a User.
PUT/user/{userId}/memberships/{membershipId}Update specific Membership for a User.
DELETE/user/{userId}/memberships/{membershipId}Retrieve Memberships for a User.
TypeMembership Parameters:
NameParameterData TypeRequiredDescription
MembershipIdformintNo
ApplicationIdformGuidNo
ApplicationLocationIdformGuidNo
UserIdformGuidNo
UsernameformstringNo
PasswordformstringNo
PasswordFormatformintNo
PasswordSaleformstringNo
MobilePINformstringNo
EmailformstringNo
LoweredEmailformstringNo
PasswordQuestionformstringNo
PasswordAnswerformstringNo
IsApprovedformboolNo
IsLockedOutformboolNo
CreateDateformDateTimeNo
LastLoginDateformDateTimeNo
LastPasswordChangedDateformDateTimeNo
LastLockoutDateformDateTimeNo
FailedPasswordAttemptCountformintNo
FailedPasswordAttemptWindowStartformDateTimeNo
FailedPasswordAnswerAttemptCountformintNo
FailedPasswordAnswerAttemptWindowStartformDateTimeNo
CommentformstringNo
IsEncryptedformboolNo
IsDefaultformboolNo
UpdatePasswordformboolNo

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/{userId}/memberships HTTP/1.1 
Host: n3tapi.palmettovdc.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	membershipId: 0,
	applicationId: 00000000000000000000000000000000,
	applicationLocationId: 00000000000000000000000000000000,
	userId: 00000000000000000000000000000000,
	username: String,
	password: String,
	passwordFormat: 0,
	passwordSale: String,
	mobilePIN: String,
	email: String,
	loweredEmail: String,
	passwordQuestion: String,
	passwordAnswer: String,
	isApproved: False,
	isLockedOut: False,
	createDate: 0001-01-01,
	lastLoginDate: 0001-01-01,
	lastPasswordChangedDate: 0001-01-01,
	lastLockoutDate: 0001-01-01,
	failedPasswordAttemptCount: 0,
	failedPasswordAttemptWindowStart: 0001-01-01,
	failedPasswordAnswerAttemptCount: 0,
	failedPasswordAnswerAttemptWindowStart: 0001-01-01,
	comment: String,
	isEncrypted: False,
	isDefault: False,
	updatePassword: False
}