...
| 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 is provided | "1980-07-05" |
8 | PostCode | Optional Max Length 50
| Required if PersonId is not provided Ignored if PersionId is provided | "879534" |
9 | Required Min Length 8 Max Length 100
| Either email or mobile is required Ignored if PersionId is provided | ||
10 | MobilePhone | Required Min Length 8 Max Length 12
| Either Email or Mobile is required Ignored if PersionId 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 is provided.
| +47 , +91 |
12 | GenderId | Optional | Required if PersonId is not provided. Ignored if PersionId is provided. Possible Value 1 - Mann (male) | 2 |
14 | CountryId | Optional (when PersonId is supplied/Membership is being added for a Norwegian citizen) | Required if PersonId is not provided, Ignored if PersionId is provided.
| 1500152 |
15 | NationalityId | Required | Nationality of person is required. (Pass the countryId from getCounties-API) | 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 from getSports API) |
|
29 | StartDate | Mandatory | StartDate for branch level Membership Possible Value
|
|
30 | EndDate | Optional | Possible Value Must be greater than today’s date. | OBSOLETE? |
...
| Code Block |
|---|
{
"startDate": "20192023-0803-2701",
"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": "helgeola.carter@nicdunk@mailintator.com",
"mobilePhone": "8556974512345678",
"genderId": 21,
"countryId": 1500152,
"nationalityId": 1500152,
"addressLine1": "Blålyngveien 89",
"addressLine2": "",
"city": "Oslo",
"privatePhone": "7855398723456789",
"workPhone": "7855397734567890",
"isSecretAddress": true,
"isSecretWorkPhone": true,
"isSecretMobilePhone": false,
"isSecretEmail": true,
"countryCode": "+47",
"isSecretPrivatePhone": truefalse
},
"sports": [
{
"branchId": 827527,
"sportId": 220,
"startDate": "20192023-0803-2714",
"endDate": "2019-09-26"
},
{
"branchId": 819760,
"sportId": 207,
"startDate": "20192023-0803-2701",
"endDate": "20192023-09-26"
}
]
}
|
POST Membership Response Example
| Code Block | ||
|---|---|---|
| ||
{
"personId": 8756934 null,
"updatedPersonId": null,
"membershipId": 0,
"clubId": 19428512430,
"clubName": "Gjermundsen Auto B.I.L."Testklubb IR",
"startDate": "20192023-08-2703-01T00:00:00",
"traceId": "7AC07206-471E-4015-9ED7-E6DB55ED7201",
"sports"sports”: [
{
],
"branchIdgroups": 819760,
[],
"sportIdperson": 207null,
"branchNameresponseMessage": "BergMembership IL",request is accepted at Club Level. It "activeMembershipId": 0
},
{
"branchId": 827527,
"sportId": 220is pending for two phase verification."
sentToEmail: "ola.dunk@mailinator.com",
"branchName": "Berg IL",
"activeMembershipId": 0
}
],
"responseMessage": "Membership request is accepted at Club Level.
It is pending for two phase verification.sentToPhone: "12345678"
}
|
| Note |
|---|
NOTE: If response contains personId and no membershipId, NEVER use this personId until the two phase verification is done by the end user, and the information is provided on the 3. party´s subscription queue. |
...