Appearance
getMembershipDetails ​
Returns the Membership-specific Identifier information for a single MI User given a valid userId and API Key
Request ​
http
GET /rest/company/membership/details/{userId}Headers ​
| Header | Required | Description |
|---|---|---|
x-nextinteract-company-api-key | Yes | Admin-specific API key UUID provided to company |
Parameters ​
userId - path parameter, number required. userId of user relating to membership details being requested. Assumes caller knows/has SAM userId.
Response ​
200 OK ​
json
{
"userId": 8,
"membershipId": "PSANZ123456",
"status": "SUBSCRIBED",
"statusDate": 1533509868501,
"customField1": null,
"customField2": null,
"customField3": null,
"customField4": null,
"customField5": null
}Errors ​
| Exception | Description |
|---|---|
WSInvalidParameterException | See Error Definitions |
WSRecordNotFoundException | See Error Definitions |
WSCompanyApiKeyNotActiveException | See Error Definitions |
WSCompanyNotActiveException | See Error Definitions |
WSUserNotFoundException | See Error Definitions |
WSUserNotActiveException | See Error Definitions |
WSConnectionStatusNotActiveException | See Error Definitions |
WSMembershipServiceException | See Error Definitions |