ORG - AllClubs
Introduksjon
Metoden lister ut alle idrettslag i Norge som er aktive.
Metoden er til bruk for et synkroniseringsendepunkt.
Datalast og synkroniseringsbehov
Datamengden fra API’et er stort når du ikke bruker noen parametere og er da ca 150 mb. Det anbefales å benytte api’et på natten og som en automatisert synkronisering, ikke hyppigere enn hver 7 dag.. Overdreven bruk kan resultere i at tilgangen fjernes.
Mye data? - Hent uten logo
Legg til følgene querystringparameter: logo=false og logo innholdet fjernes fra responsen. Dette gir merkbart økt ytelse.
eks: {{dataurl}}/api/v1/org/allClubs?logo=false
"orgLogoBase64": ""
vil være blank.
Idrettslag under spesifikt orgledd (f.eks særforbund)
Metoden har støtte for å liste idrettslag knyttet til en spesifik orgtype. Du må oppgi orgid til det spesifikke overliggende orgledd.
Eksempel: OrgId=381 (Norges skiforbund)
Støttede orgtyper:
OrgTypeId | Orgtype navn |
---|---|
2 | Særforbund |
3 | Idrettskrets |
4 | Særkrets |
8 | Idrettsråd |
48 | Region (særforbund) |
For å finne orgledd knyttet til orgtypene kan du bruke: ORG - Organisation/Orgtype/{orgtypeid}
Eksempler
JSON Request paramters
Optional :
OrgId=381 (OrgId for spesifikt overliggende orgledd)
or
ReferenceID= (ReferenceID for spesifikt overliggende orgledd)
JSON Response
[
{
"orgId": 563529,
"referenceId": "saoifjd23424fh2uf",
"orgName": "string",
"abbreviation": "string",
"describingName": "string",
"orgTypeId": 5,
"organisationNumber":"123456789"
"email": "leder@soonck.no",
"homepage": "string",
"mobilePhone": "99123180",
"addressLine1": "Sponkroken 22",
"addressLine2": "",
"city": "SON",
"country": "Norge",
"countryId":"123455678"
"postCode": "1555",
"longitude": "string",
"latitude": "string",
"orgLogoBase64": "string",
"members":250
},
{
"orgId": 563529,
"referenceId": "saoifjd23424fh2uf",
"orgName": "string",
"abbreviation": "string",
"describingName": "string",
"orgTypeId": 5,
"organisationNumber":"123456789"
"email": "leder@soonck.no",
"homepage": "string",
"mobilePhone": "99123180",
"addressLine1": "Sponkroken 22",
"addressLine2": "",
"city": "SON",
"country": "Norge",
"countryId":"123455678"
"postCode": "1555",
"longitude": "string",
"latitude": "string",
"orgLogoBase64": "string",
"members":250
},
{
...
...
...
}
]
Endepunktlinker
BaseUrl | Metode | Miljø | Scopes | Client claims (optional) | Parametere |
---|---|---|---|---|---|
/api/v1/org/allclubs | DST | data_org_read |
| orgid, referenceid for krets | |
/api/v1/org/allclubs | PROD | data_org_read |
| orgid, referenceid for krets |