MOT - Metodebeskrivelse - Members
Introduksjon
Metoden gir deg en utlisting av en eller flere/alle medlemmer innenfor en eller flere spesifikke grener som integrasjonspartneren har tilgang på
Metoden har pagesizes og lister ut 100 av gangen per response. Ved flere enn 100 medlemmer må du endre pagesize.
Sortering av data i response:
Listen sorterer etter siste registrerte medlemskap først.
Respekt for personverninnstillinger i Min idrett.
Responsen har respekt for personverninnstillingene som personen selv administrerer i Min idrett. Hvis data mangler, skylles det at en eller flere felter for å holde informasjon skjult er satt til True.
URL
Domene | Metode | Miljø |
---|---|---|
https://api-dst.nif.no | sportsread/api/member | test/qa |
https://api.nif.no | sportsread/api/member | produksjon |
Headers
Header | Innhold | Kommentar | Krav |
---|---|---|---|
Orgid | 12345 | NIFs orgid | Ja |
SportsID | 123,123 | Id(er) for hvilken idrett du kan spørre på. Kommaseparert | Ja |
OrgTypeID | 5 eller 15 | For idrettslag eller bedriftsidrettslag | Ja |
Authorization | token for klubb | Den unike token for denne org | Ja |
Ocp-Apim-Subscription-Key | token for abonnement | Integrasjonspartnerens unike tilgangsnøkkel | Ja |
Parametere
Parameter | Innhold | Kommentar | Krav |
---|---|---|---|
PageNumber | 1 ? | Hvilken side du ønsker | Ja |
PersonIds | 12345,12345 | Enkeltpersoner, eller flere | Nei |
BuypassIds | 12345,12345 | Enkeltpersoner, eller flere med buypassid | Nei |
startDate | yyyy-mm-dd (eks: 2021-10-01) | Medlemmer etter den angitte datoen | Nei |
Eksempel på response idrettslag
NB! dataene i dette eksempelet er tatt fra et reelt tilfelle, men er anonymisert, og alle id’er er manipulert.
{
"totalRecords": 333,
"pageSize": 100,
"currentPage": 1,
"data": [
{
"personId": 1234567,
"genderId": 1,
"birthDate": "1931-09-21T00:00:00",
"lastName": "Etternavn",
"firstName": "Fornavn",
"nationalityId": 1500152,
"addressLine1": "Gateadressen 75",
"addressLine2": "",
"postCode": "1555",
"city": "Son",
"postCodeId": 12345,
"country": "Norge",
"countryId": 1500152,
"email": "epostadresse@domene.no",
"privatePhone": "12345678",
"workPhone": "12345678",
"mobilePhone": "12345678",
"registrationPhone": "12345678",
"registrationPhoneCountryCode": "+47",
"isSecretAddress": false,
"isSecretPrivatePhone": false,
"isSecretWorkPhone": false,
"isSecretMobilePhone": false,
"isSecretEmail": false,
"groupMemberships": null,
"grenMemberships": [
{
"startDate": "2017-03-14T00:00:00",
"endDate": null,
"orgId": 563529,
"isPassive": false,
"parentOrgId": 64921,
"membershipId": 37846721,
"sportId": 230
}
"mergedPersonIds": null,
"buypassId": 12345678
]
},
...
...
}
Eksempel på response ved bedriftsidrettslag:
{
"totalRecords": 10,
"pageSize": 100,
"currentPage": 1,
"data": [
{
"personId": 9635685,
"genderId": 1,
"birthDate": "2018-09-09T00:00:00",
"lastName": "Testperson",
"firstName": "Testbarn",
"nationalityId": 1500052,
"addressLine1": "Testveien",
"addressLine2": null,
"postCode": "0001",
"city": "OSLO",
"postCodeId": 215326,
"country": "Norge",
"countryId": 1500152,
"email": "cs@nif.no",
"privatePhone": null,
"workPhone": null,
"isPersonValidated": false,
"mobilePhone": null,
"isSecretAddress": false,
"isSecretPrivatePhone": false,
"isSecretWorkPhone": false,
"isSecretMobilePhone": false,
"isSecretEmail": false,
"groupMemberships": [
{
"startDate": "2021-09-21T00:00:00",
"endDate": null,
"orgId": 907733,
"isPassive": false,
"parentOrgId": 889079,
"membershipId": 38388548,
"sportId": 207
}
],
"grenMemberships": null,
"mergedPersonIds": null,
"buypassId": null
},
{
...
...
}
]
}