| Requires any of the roles: | admin, oauthadmin | Requires any of the permissions: | /admin/control/, /admin/events/ |
| GET | /Ams/{ClientID}/MemberTypes | Returns the member types for this client - with cache. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ID | query | int | No | |
| SortBy | query | SortByEnum | No | Allowable Values
|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UsingRedis | form | bool | No | |
| AppInitTime | form | DateTime | No | |
| ServerID | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ClientID | form | int | No | |
| ResponseStatus | form | ResponseStatus | No | |
| BypassCache | form | bool | No | |
| DateCached | form | DateTime | No | |
| Device | form | Device | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MemberTypes | form | List<MemberType> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ID | form | int | No | |
| TypeCode | form | string | No | |
| Name | form | string | No | |
| IsDefault | form | bool | No | |
| Visibility | form | int | No | |
| PresetType | form | string | No | |
| SortOrder | form | double | 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.
GET /Ams/{ClientID}/MemberTypes HTTP/1.1
Host: ws.yourmembership.com
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
MemberTypes:
[
{
ID: 0,
TypeCode: String,
Name: String,
IsDefault: False,
Visibility: 0,
PresetType: String,
SortOrder: 0
}
],
ID: 0,
SortBy: Default,
UsingRedis: True,
AppInitTime: 2024-05-02T23:24:29.3036719-04:00,
ServerID: WS-4-69-031,
ClientID: 0,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
BypassCache: False,
DateCached: 2024-05-03T01:37:51.9013892-04:00,
Device: Desktop
}