| Requires any of the roles: | admin, oauthadmin | Requires the permission: | CanAdminMembers |
| GET | /Ams/{ClientID}/Memberships/ | Return a list of memberships for a client. | With cache is GET. |
|---|---|---|---|
| GET | /Ams/{ClientID}/Memberships/{MemberTypeId} | Return a list of memberships for a client. | With cache is GET. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MemberTypeId | path | int | No | |
| ExpirationDate | query | DateTime | No |
| 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 |
|---|---|---|---|---|
| membershipList | form | List<Membership> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| Code | form | string | No | |
| Name | form | string | No | |
| DuesAmount | form | double | No | |
| ProRatedDues | form | bool | No | |
| ProRateFactor | form | double | No | |
| AllowMultipleOpenInvoices | form | bool | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Ams/{ClientID}/Memberships/ HTTP/1.1
Host: ws.yourmembership.com
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"membershipList":[{"Id":0,"Code":"String","Name":"String","DuesAmount":0,"ProRatedDues":false,"ProRateFactor":0,"AllowMultipleOpenInvoices":false}],"MemberTypeId":0,"ExpirationDate":"0001-01-01T00:00:00.0000000","UsingRedis":true,"AppInitTime":"2025-01-15T08:15:38.3987731-05:00","ServerID":"WS-4-190-907","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":"2025-01-15T09:06:47.2746844-05:00","Device":"Desktop"}