GET | /user/{userId}/memberships | Retrieve Memberships for a User. | |
---|---|---|---|
POST | /user/{userId}/memberships | Create 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. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
MembershipId | form | int | No | |
ApplicationId | form | Guid | No | |
ApplicationLocationId | form | Guid | No | |
UserId | form | Guid | No | |
Username | form | string | No | |
Password | form | string | No | |
PasswordFormat | form | int | No | |
PasswordSale | form | string | No | |
MobilePIN | form | string | No | |
form | string | No | ||
LoweredEmail | form | string | No | |
PasswordQuestion | form | string | No | |
PasswordAnswer | form | string | No | |
IsApproved | form | bool | No | |
IsLockedOut | form | bool | No | |
CreateDate | form | DateTime | No | |
LastLoginDate | form | DateTime | No | |
LastPasswordChangedDate | form | DateTime | No | |
LastLockoutDate | form | DateTime | No | |
FailedPasswordAttemptCount | form | int | No | |
FailedPasswordAttemptWindowStart | form | DateTime | No | |
FailedPasswordAnswerAttemptCount | form | int | No | |
FailedPasswordAnswerAttemptWindowStart | form | DateTime | No | |
Comment | form | string | No | |
IsEncrypted | form | bool | No | |
IsDefault | form | bool | No | |
UpdatePassword | form | bool | 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 /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
}