Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Method

API Endpoint

Description

DELETE

/api/v{version}/membership

Cancels an existing membership at club level as well as from branch level (sports). If branchId is passed in the request then the API cancels branch level membership, otherwise it cancels the Club level membership.

 

Allidrett:

Allidrett memberships (group level) can be cancelled using this API.

Pass the allidrett groupID groupId to cancel the allidrett group membership.

Today’s date will be passed set as end date EndDate for canceled memberships.

...

 

Name

Required

Description

1

ClubId

Yes

Club Id ClubId for which API is being requested

2

Authorization

Yes

This will be the token to define access for on-boarded club.

3

Ocp-Apim-Subscription-Key

Yes

API management’s subscription key. There will be separate key for each 3.party.

...

 

Name

Required

Description

Example

1

PersonId

Mandatory

Person IdPersonId

5347891

2

BranchId

Optional

If Branch Id BranchId is passed in the request then the API cancels the branch level membership, otherwise it cancels the Club level membership.

1238

3

IsClubLevel

Optional

If true, the system deletes club level membership, and Branch Id BranchId should not be passed.

 

True

 

4

GroupId

Optional

If group Id groupId is passed in the request then the API cancels the group level membership, otherwise it cancels the Club level membership.
This is relevant for allidrett

1238

...

Code Block
{
  "personId": 5347891,
  "endDate": "2017-06-20",
  "groupId": 1238
} 

 

 Response Response Example

Code Block
{
    "message": "Club level membership cancellation request accepted for 9289406 with 16235.",
    "updatedPersonId": 9289406
}

...