EMS - API dokumentasjon - POST Membership (n/a)
Introduksjon
Metoden beskriver hvordan man melder inn en person i klubb eller gren/gruppe.
Metoden beskriver innmelding i idrettslag og bedriftsidrettslag.
Parametere
Merk at dette er i tillegg til de påkrevde parameterne for alle metoder. Se mer her: EMS - API dokumentasjon
Headers | Eksempel | kommentar |
---|---|---|
|
|
|
|
|
|
Querystring | Eksempel | Kommentar |
---|---|---|
|
|
|
|
|
|
Dataobjekter
Navn | Påkrevd | Kommentar | Eksempel |
---|---|---|---|
IsClubLevel | Nei | Settes til True når det er klubbmedlemskap uten gren, og false når det er grenmedlemskap. Ved false er grenmedlemskapsdetaljer påkrevd. |
|
StartDate | Nei |
|
|
PersonID | Nei, men JA om man besitter PersonId. | Hvis du besitter personId, så kan personobjektets personinformasjon droppes. |
|
FirstName | Nei, hvis man har PersonId, Ja hvis ikke. |
|
|
LastName | Nei, hvis man har PersonId, Ja hvis ikke. |
|
|
BirthDate | Nei, hvis man har PersonId, Ja hvis ikke. | yyyy-mm-dd | 2010-10-15 |
PostCode | Nei, hvis man har PersonId, Ja hvis ikke. |
|
|
Ja | Må være riktig formatert |
| |
MobilePhone | Ja | Må være riktig formatert |
|
CountryCode | Ja | Landskode for telefonnummer | +47 |
GenderId | Nei, hvis man har PersonId, Ja hvis ikke. | 1 - Mann |
|
CountryId | Nei, hvis man har PersonId, Ja hvis ikke. | 1500152 for Norge. For andre land, hent ut landskoder fra Country metoden. |
|
NationalityId | Nei, hvis man har PersonId, Ja hvis ikke. | 1500152 for Norge. For andre land, hent ut landskoder fra Country metoden. |
|
AddressLine1 | Nei |
|
|
AddressLIne2 | Nei |
|
|
City | Nei, hvis man har PersonId, Ja hvis ikke. |
|
|
PrivatePhone | Nei |
|
|
WorkPhone | Nei |
|
|
IsSecretAddress | Nei | Hvis personen vil default være skjult i idrettens systemer. Personen kan stille på dette i Minidrett | true/false |
IsSecretPrivatePhone | Nei | Hvis personen vil default være skjult i idrettens systemer. Personen kan stille på dette i Minidrett | true/false |
IsSecretWorkPhone | Nei | Hvis personen vil default være skjult i idrettens systemer. Personen kan stille på dette i Minidrett | true/false |
IsSecretMobilePhone | Nei | Hvis personen vil default være skjult i idrettens systemer. Personen kan stille på dette i Minidrett | true/false |
IsSecretEmail | Nei | Hvis personen vil default være skjult i idrettens systemer. Personen kan stille på dette i Minidrett | true/false |
For grenmedlemskap i Idrettslag:
Navn | Påkrevd | Kommentar | Eksempel |
---|---|---|---|
BranchId | Ja | (OrgID på grenen) |
|
SportId | Ja | SportId finner man ved å bruke sport metoden | 130: Langrenn |
StartDate | Ja | yyyy-mm-dd |
|
EndDate | Nei | Må være større enn startdate. |
|
For gruppemedlemskap i bedriftsidrett og allidrett:
Navn | Påkrevd | Kommentar | Eksempel |
---|---|---|---|
Groupid | Ja | (OrgID på gruppen) |
|
StartDate | Ja | yyyy-mm-dd |
|
EndDate | Nei | Må være større enn startdate. |
|
Eksempler
JSON Request idrettslag
{
"startDate": "2019-08-27",
"isClubLevel": true,
"person":
{
"personId": null,
"firstName": "Helge",
"lastName": "Carter",
"birthDate": "1980-07-05",
"postCode": "0010",
"email": "helge.carter@domene.com",
"mobilePhone": "85569745",
"genderId": 2,
"countryId": 1500152,
"nationalityId": 1500152,
"addressLine1": "Blålyngveien 89",
"addressLine2": "",
"city": "Oslo",
"privatePhone": "78553987",
"workPhone": "78553977",
"isSecretAddress": true,
"isSecretWorkPhone": true,
"isSecretMobilePhone": false,
"isSecretEmail": true,
"countryCode": "+47",
"isSecretPrivatePhone": true
},
"sports":[
{
"branchId": 827527,
"sportId": 220,
"startDate": "2019-08-27",
"endDate": "2019-09-26"
},
{
"branchId": 819760,
"sportId": 207,
"startDate": "2019-08-27",
"endDate": "2019-09-26"
}]
}
JSON Request bedriftsidrettslag og allidrett
{
"startDate": "2019-08-27",
"isClubLevel": true,
"person":
{
"personId": 8756934,
"firstName": "Helge",
"lastName": "Carter",
"birthDate": "1980-07-05",
"postCode": "0010",
"email": "helge.carter@nic.com",
"mobilePhone": "85569745",
"genderId": 2,
"countryId": 1500152,
"nationalityId": 1500152,
"addressLine1": "Blålyngveien 89",
"addressLine2": "",
"city": "Oslo",
"privatePhone": "78553987",
"workPhone": "78553977",
"isSecretAddress": true,
"isSecretWorkPhone": true,
"isSecretMobilePhone": false,
"isSecretEmail": true,
"countryCode": "+47",
"isSecretPrivatePhone": true
},
"groups":[
{
"groupid": 827527,
"startDate": "2019-08-27",
"endDate": "2019-09-26"
}]
}
JSON response idrettslag
{
"personId": 8756934,
"membershipId": 0,
"clubId": 19428,
"clubName": "Idrettslaget IL",
"startDate": "2019-08-27",
"traceId": "7AC07206-471E-4015-9ED7-E6DB55ED7201",
"sports”: [
{
"branchId": 819760,
"sportId": 207,
"branchName": "Grenens Navn",
"activeMembershipId": 0
},
{
"branchId": 827527,
"sportId": 220,
"branchName": "Grenens Navn",
"activeMembershipId": 0
}
],
"responseMessage": "Membership request is accepted at Club Level. It is pending for two phase verification."
}
JSON Response bedriftsidrettslag og allidrett
Response koder
Kode | Beskrivelse |
|
---|---|---|
|
|
|
|
|
|
Endpoints
URL | Miljø | Kommentar |
---|---|---|
https://api-dst.nif.no/api/v1/membership | DST |
|
https://api-dst.nif.no/api/v1/membership | PROD |
|