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 .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<LoginUserMembership xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/N3TAPI.Services.DTO">
<ApplicationId xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">00000000-0000-0000-0000-000000000000</ApplicationId>
<ApplicationLocationId xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">00000000-0000-0000-0000-000000000000</ApplicationLocationId>
<Comment xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">String</Comment>
<CreateDate xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">0001-01-01T00:00:00</CreateDate>
<Email xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">String</Email>
<FailedPasswordAnswerAttemptCount xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">0</FailedPasswordAnswerAttemptCount>
<FailedPasswordAnswerAttemptWindowStart xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">0001-01-01T00:00:00</FailedPasswordAnswerAttemptWindowStart>
<FailedPasswordAttemptCount xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">0</FailedPasswordAttemptCount>
<FailedPasswordAttemptWindowStart xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">0001-01-01T00:00:00</FailedPasswordAttemptWindowStart>
<IsApproved xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">false</IsApproved>
<IsDefault xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">false</IsDefault>
<IsEncrypted xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">false</IsEncrypted>
<IsLockedOut xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">false</IsLockedOut>
<LastLockoutDate xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">0001-01-01T00:00:00</LastLockoutDate>
<LastLoginDate xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">0001-01-01T00:00:00</LastLoginDate>
<LastPasswordChangedDate xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">0001-01-01T00:00:00</LastPasswordChangedDate>
<LoweredEmail xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">String</LoweredEmail>
<MembershipId xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">0</MembershipId>
<MobilePIN xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">String</MobilePIN>
<Password xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">String</Password>
<PasswordAnswer xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">String</PasswordAnswer>
<PasswordFormat xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">0</PasswordFormat>
<PasswordQuestion xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">String</PasswordQuestion>
<PasswordSale xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">String</PasswordSale>
<UpdatePassword xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">false</UpdatePassword>
<UserId xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">00000000-0000-0000-0000-000000000000</UserId>
<Username xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">String</Username>
</LoginUserMembership>