POST Membership (AddMembership)

Overview

Describing how to add a person as a member to a sports club and/or branch. (Idrettslag og/eller idrettsgren).

Applies to regular sports clubs (type 5), including group “Allidrett”, and corporate sports clubs (type 15).

Endpoints

Current API version is 1 (example URL: /api/v1/membership)

URL	Environment	Comment
https://api-dst.nif.no/api/v1/membership	DST (Test)
https://api-dst.nif.no/api/v1/membership	PROD

Method

API Endpoint

Description

POST

/api/v{version}/membership

Allows adding a membership for Norwegian or foreign persons using POST Membership.

Membership represents the connection of a person with a club and/or its branch for a specific sport.

If a person´s nationality is Norwegian (nationalityId: 1500152), membership request would be considered as Norwegian “Norwegian person request, otherwise request”, and the person must enter his/hers social security number. Otherwise the request would be considered as a foreign “foreign person requestrequest”.

The API adds branch level membership data. It will also add club level membership.

If clubId is passed in the request the API adds club level membership. If a branchId is passed, the request adds branch level membership.

Allidrett:
For allidrett, a groupId has to be passed. The accepted groups for allidrett can be fetched using the GetOrgStructure API. When allidrett groupId is passed, the request will add group level membership for allidrett.

If the Person already exists in the third party membership solution, the PersonId should be sent in the AddMembership-request.

When the membership request contains PersonId then all the information is fetched from NIF by using PersonId.

If PersonId is not passed in the request, the person is searched for, based on first name, last name, date of birth, gender, postal code and nationality.

If no result in this search, a new person will attempt to be created. If the data is imprecise or wrong, and the person most likely already exists, a failure in user verification will arise when end user tries to validate with SSN.

If the PersonId is sent and the response is “invalid person id”, the third party is not synchronized correctly. Work around is to send exact person information, according to entry in The National Population Register (Folkeregisteret).

Club level membership requests are subject to a two-phase verification active for 24 hours. The verification link is sent to the user via email and SMS. This must be passed for request to be fulfilled. After user verification an OTP code is sent by SMS and must be entered to the two-phase temporary site. Once completed request is passed on.

If a person is already validated in NIFs database, no OTP is required, and the person will not be able to change any personal information in the verification form. All personal information is kept updated by the person itself in Min idrett, by logging in with Idrettens ID.

As soon as two-phase verification is completed successfully, person club and branch level membership are added.

This API will respond with traceId along with other needed parameters. This traceId will be used to trace the request response with messages received in enterprise service bus queue.

After two-phase verification, person and membership records in queue has traceId. In case the person is already validated there is no traceId in the message in the queue or the response.

If Membership at Club or Branch level system will respond with existing MembershipId/ActiveMembershipId.

Entities to get affected by this API:

Tp_Person
Tp_Membership
Tp_ActiveMembership

...

	Name	Required	Description	Example
1	IsClubLevel	Optional	True in case of Club level membership request, false in case of only branch level membership.	true/false
2	StartDate	Optional	StartDate for membership is required if ClubId is not provided, the system will ignore this field when ClubId is provided. Possible Value Must be of today’s date year. For example, if today’s date is 19-Sep-2019. Then start date must be in between 1-Jan-2019 to 31-Dec-2019.	"2019-06-07"
3	Person	Mandatory
4	PersonId	Optional	If PersonId is already present at 3.party´s database, and person is validated	1234567
5	FirstName	Optional Max Length 50	Required if PersonId is not provided. Ignored it if PersionId is provided.	"Ola"
6	LastName	Optional Max Length 50	Required if PersonId is not provided. Ignored if PersonId is provided.	"Dunk"
7	BirthDate	Optional	Required if PersonId is not provided. Ignored if PersionId PersonId is provided	"1980-07-05"
8	PostCode	Optional Max Length 50	Required if PersonId is not provided Ignored Ignored if PersionId PersonId is provided	"879534"
9	Email	Required Min Length 8 Max Length 100	Either email or mobile Email is required Ignored if PersionId PersonId is provided	email@email.com
10	MobilePhone	Required Min Min Length 8 Max Length 12	Either Email or Mobile MobilePhone is required Ignored Ignored if PersionId PersonId is provided	"90909090"
11	CountryCode	Optional Min Length 2 Max Length 6	CountryCode is required in the case MobilePhone is provided, and if PersonId is not provided. Ignored if PersionId PersonId is provided.	+47 , +91
12	GenderId	Optional	Required if PersonId is not provided. Ignored if PersionId PersonId is provided. Possible Value 1 - Mann (male) 2 - Kvinne (female) 5 - Ukjent (unknown)	2
14	CountryId	Optional (when PersonId is supplied/Membership is being added for a Norwegian citizenbut default value if NationalityId is norwegian)	Required if PersonId is not provided, Ignored if PersionId PersonId is provided. If CountryId is null, user must select from User Verification-application. Unless NationalityId (15) is set to 1500152, then default value will be Norway (1500152).	1500152
15	NationalityId	Required	Nationality of person is required. (Pass the countryId from getCounties-APIGetCountries)	1500152
16	AddressLIne1	Optional Max Length 50	First line of address	"Addressline 1”
17	AddressLIne2	Optional Max Length 50	Second line of address	"Addressline 2"
18	City	Optional Max Length 50	City of residence	"Oslo"
19	PrivatePhone	Optional Min Length 8 Max Length 18	Private phone number	"78965872"
20	WorkPhone	Optional Min Length 8 Max Length 18	Work phone number	"78965872"
21	IsSecretAddress	Optional	If the person has configured to hide their address from viewership on the UI, this flag will be set to true. When set to true, it is the responsibility of the 3.party to hide this information from viewership on their UI.	true/false
22	IsSecretPrivatePhone	Optional	Similar to aforementioned scenario, if the person’s private phone is marked as secret, the 3.party must also hide it from their UI.	true/false
23	IsSecretWorkPhone	Optional	Similar to aforementioned scenario, if the person’s work phone is marked as secret, the 3. party must also hide it from their UI.	true/false
24	IsSecretMobilePhone	Optional	Similar to aforementioned scenario, if the person’s mobile phone is marked as secret, the 3.party must also hide it from their UI.	true/false
25	IsSecretEmail	Optional	Similar to aforementioned scenario, if the person’s email is marked as secret, the 3.party must also hide it from their UI.	true/false
26	Sports	Optional	Branch level Membership	[]
27	BranchId	Mandatory		1238
28	SportId	Mandatory	(Pass the sport id SportId from getSports GetSports API) -endpoint	Eg: 66
29	StartDate	Mandatory	StartDate for branch level Membership Possible Value Must be of today’s date year. For example, if today’s date is 19-Sep-2019. Then start date must be in between 1-Jan-2019 to 31-Dec-2019 Must be greater than Club level membership start date. Must be of Club level membership’s start date year. For example, if Club level membership’s start date is 19-Sep-2019. Then start date must be in between 1-Jan-2019 to 31-Dec-2019.
30	EndDate	Optional	Possible Value Must be greater than today’s date.	OBSOLETE?

...

POST Membership Request Example

Code Block

language	json

{
  "startDate": "2023-03-01",
  "isClubLevel": true,
  "person": {
    "personId": 8756934, -- NB: If personId is provided, all person properties ignored.
    "firstName": "Ola",
    "lastName": "Dunk",
    "birthDate": "1980-07-05",
    "postCode": "0010",
    "email": "ola.dunk@mailintator.com",
    "mobilePhone": "12345678",
    "genderId": 1,
    "countryId": 1500152,
    "nationalityId": 1500152,
    "addressLine1": "Blålyngveien 89",
    "addressLine2": "",
    "city": "Oslo",
    "privatePhone": "23456789",
    "workPhone": "34567890",
    "isSecretAddress": true,
    "isSecretWorkPhone": true,
    "isSecretMobilePhone": false,
    "isSecretEmail": true,
    "countryCode": "+47",
    "isSecretPrivatePhone": false
  },
  "sports": [
    {
      "branchId": 827527,
      "sportId": 220,
      "startDate": "2023-03-14",
      "endDate": ""
    },
    {
      "branchId": 819760,
      "sportId": 207,
      "startDate": "2023-03-01",
      "endDate": "2023-09-26"
    }
  ]
}

...

Versions Compared

Old Version 10

New Version Current

Key

POST Membership (AddMembership)

Overview

Endpoints

POST Membership Request Example

Page Comparison

Versions Compared

Old Version 10

New Version Current

Key

POST Membership (AddMembership)

Overview

Endpoints

POST Membership Request Example