POST api/Memberships/Resign
When a member leaves the club, you need call this method with the date the member resigns and an optional message/reason. It is not possible to delete memberships because the duration of the membership is used in other parts of the system.
Request Information
URI Parameters
None.
Body Parameters
MembershipResignDtoName | Description | Type | Additional information |
---|---|---|---|
MembershipId |
ID of the membership (Guid) |
globally unique identifier |
Required |
ResignedDate |
The date the member resigned from the membership |
date |
Required |
ResignReason |
Optional field for information about why a membership is ending. |
string |
None. |
Request Formats
application/json, text/json
Sample:
{ "MembershipId": "6c144366-a603-4a0b-9ce2-1616ea34ac31", "ResignedDate": "2024-04-18T20:53:19.8466057+02:00", "ResignReason": "sample string 1" }
application/xml, text/xml
Sample:
<MembershipResignDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebApi.Models"> <MembershipId>6c144366-a603-4a0b-9ce2-1616ea34ac31</MembershipId> <ResignReason>sample string 1</ResignReason> <ResignedDate>2024-04-18T20:53:19.8466057+02:00</ResignedDate> </MembershipResignDto>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
MembershipDtoName | Description | Type | Additional information |
---|---|---|---|
MembershipId |
ID of the membership (Guid) |
globally unique identifier |
None. |
Name |
Name of the membership |
string |
None. |
MemberTypeId |
ID of the membership type (Guid) |
globally unique identifier |
None. |
SignupDate |
The date the member signed up to the membership |
date |
None. |
ResignedDate |
The date the member resigned from the membership |
date |
None. |
Response Formats
application/json, text/json
Sample:
{ "MembershipId": "0775edde-ae8d-4de5-92a1-8c457bfe59b2", "Name": "sample string 2", "MemberTypeId": "ff217bcc-4b44-4611-a337-4366c7fce688", "SignupDate": "2024-04-18T20:53:19.8778506+02:00", "ResignedDate": "2024-04-18T20:53:19.8778506+02:00" }
application/xml, text/xml
Sample:
<MembershipDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebApi.Models"> <MemberTypeId>ff217bcc-4b44-4611-a337-4366c7fce688</MemberTypeId> <MembershipId>0775edde-ae8d-4de5-92a1-8c457bfe59b2</MembershipId> <Name>sample string 2</Name> <ResignedDate>2024-04-18T20:53:19.8778506+02:00</ResignedDate> <SignupDate>2024-04-18T20:53:19.8778506+02:00</SignupDate> </MembershipDto>