GET api/v1/memberships/report
Get the monthly report for a given Association
Request Information
URI Parameters
None.
Body Parameters
MemberReportBindingModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Authentication | AuthenticationModel |
Required |
|
| Request | MemberReportRequestModel |
Required |
Request Formats
application/json, text/json
Sample:
{
"Authentication": {
"Id": "170200123 - sample only, user your ID",
"Key": "467512342123 - sample only, user your Key"
},
"Request": {
"AssociationName": "VES",
"Month": "1 - valid values: 1 - 12",
"Year": "2018 - any valid year"
}
}
application/xml, text/xml
Sample:
<MemberReportBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api.Models">
<Authentication>
<Id>170200123 - sample only, user your ID</Id>
<Key>467512342123 - sample only, user your Key</Key>
</Authentication>
<Request>
<AssociationName>VES</AssociationName>
<Month>1 - valid values: 1 - 12</Month>
<Year>2018 - any valid year</Year>
</Request>
</MemberReportBindingModel>
Response Information
Resource Description
OutgoingMembershipModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Message | MessageModel |
None. |
|
| Response | IMembershipResponse |
None. |
Response Formats
application/json, text/json
Sample:
{
"Message": {
"Code": "sample string 1",
"Description": "sample string 2"
},
"Response": null
}
application/xml, text/xml
Sample:
<OutgoingMembershipModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api.Models">
<Message>
<Code>sample string 1</Code>
<Description>sample string 2</Description>
</Message>
<Response i:nil="true" />
</OutgoingMembershipModel>