Requires any of the roles: | admin, oauthadmin | Requires the permission: | CanAdminMembers |
GET | /Ams/{ClientID}/Membership/ | Return. the data for a single membership. | With cache is GET. |
---|---|---|---|
GET | /Ams/{ClientID}/Membership/{Id} | Return the data for a single membership. | With cache is GET. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | path | int | No | |
ExpirationDate | query | string | 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 |
---|---|---|---|---|
Membership | form | 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Ams/{ClientID}/Membership/ HTTP/1.1 Host: ws.yourmembership.com Accept: application/json
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"Membership":{"Id":0,"Code":"String","Name":"String","DuesAmount":0,"ProRatedDues":false,"ProRateFactor":0,"AllowMultipleOpenInvoices":false},"Id":0,"ExpirationDate":"String","UsingRedis":true,"AppInitTime":"2025-01-15T07:19:47.5165087-05:00","ServerID":"WS-6-56-398","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:10:16.3461518-05:00","Device":"Desktop"}