...
| Code | Type | Text | Description |
1 | 200 | Success |
|
|
2 | 1018 | Error | Invalid club Id |
|
3 | 401 | Error | Unauthorized |
|
Response Example
[
...
| Code Block |
|---|
[ "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1bmlxdWVfbmFtZSI6IkhpdGVzaFBhcn QyIiwiQ2x1YklkIjoiMTk0MzAiLCJDbHViRGV0YWlsIjoiMTk0MzB-NzF- |
...
LTQzIiwibmJmIjoxNTY2OTc0OTA0LC JleHAiOjE1NjY5Nzg1MDQsImlhdCI6MTU2Njk3NDkwNCwiaXNzIjoic2VsZiIsImF1ZCI6ImZ1bi10cGkifQ._ |
...
Y XZwmdSMhmxldBew48Ii1BbZAXgGwXAfUPuEbV40c8" ] |
GET Sports
Overview
Method | API Endpoint | Description |
GET | /api/v{version}/sports | Allows Integration Partners to download all NIF sports. |
...
| Code | Type | Text | Description |
1 | 200 | Success |
|
|
Response Example
...
| Code Block |
|---|
...
{ "sportId": "32", |
...
"sportName": "Ski", |
...
"sportDescription": "demo sport description", |
...
"sports": |
...
[ { "sportId": 132, |
...
"sportName": "Alpint", |
...
"sportDescription": "demo sport description" |
...
}, { "sportId": 130, |
...
"sportName": "Langrenn", |
...
"sportDescription": "demo sport description" |
...
} ] }, { "sportId": "17", |
...
"sportName": "Friidrett", |
...
"sportDescription": "demo sport description", |
...
"sports": |
...
[ { "sportId": 220, |
...
"sportName": "Friidrett på bane", |
...
"sportDescription": "demo sport description" |
...
}, { "sportId": 434, |
...
"sportName": "Løp utenfor bane", |
...
"sportDescription": "demo sport description" |
...
}
]
} |
GET Countries
Overview
...
Response Format | JSON |
Requires Authentication | Yes |
GET Organization Structure
External Membership API (vanlige idrettslag)
Overview
...
Method
...
API Endpoint
...
Description
...
GET
...
/api/v{version}/organization/structure
...
Gets the organization structure (branches) of club along with its details.
Allidrett:
Allidrett is on a group level and it does not have or require branches. This API will return those groups without branches.
Allidrett groups do not have a SportID.
Resource Information
...
Response Format
...
JSON
...
Requires Authentication
...
Yes
...
Request Headers
| Name | Required | Description |
1 | ClubId | Yes | Club Id for which API is being requested |
2 | Authorization | Yes | This is the token to define access for an on-boarded club. |
3 | Ocp-Apim-Subscription-Key | Yes | API management’s subscription key. Each 3.party is provided with a separate and unique key. |
Response Codes
| Code | Type | Text | Description |
1 | 200 | Success |
|
|
Response Example
| Code Block |
|---|
{
"countryId": 1500159,
"countryName": "Peru",
"isoAlpha2": "PE",
"isoAlpha3": "PER"
},
{
"countryId": 1500125,
"countryName": "Monaco",
"isoAlpha2": "MC",
"isoAlpha3": "MON"
},
{
"countryId": 1500121,
"countryName": "Luxembourg",
"isoAlpha2": "LU",
"isoAlpha3": "LUX"
}
|
GET Organization Structure
External Membership API (vanlige idrettslag)
Overview
Method | API Endpoint | Description |
GET | /api/v{version}/organization/structure | Gets the organization structure (branches) of club along with its details. Allidrett: |
Resource Information
Response Format | JSON |
Requires Authentication | Yes |
Request Headers
| Name | Required | Description |
1 | ClubId | Yes | Club Id for which API is being requested. |
2 | Authorization | Yes | This will be the token defining access for the on-boarded club. |
3 | Ocp-Apim-Subscription-Key | Yes | API management’s subscription key. Each 3.party is provided a separate and unique key. |
Response Codes
| Code | Type | Text | Description |
1 | 200 | Success |
| Clubs, groups and branch(es) |
Response Example
| Code Block |
|---|
{
"clubId": "1111111",
"clubName": "Heming Idrettslaget",
"describingName": "Heming Idrettslaget",
"email": "office@mailinator.no",
"city": "Oslo",
"county": "Norway",
"longitude": "72.5714° E",
"latitude": "23.0225° N",
"groups": [
{
"groupId": "221333",
"groupName": "Heming, IL - Alpint",
"describingName": "Heming, IL - Alpint",
"sportId": "32",
"sportName": "Ski",
"branches": [
{
"describingName": "Heming, IL - Alpint",
"sportId ": "132",
"sportName": "Alpint",
"branchId": "221333",
"branchName": "Heming, IL - Alpint"
},
{
"branchId": "211424",
"branchName": "Heming, IL - Hopp",
"describingName": "Heming, IL - Hopp",
"sportId": "129",
"sportName": "Hopp"
}
]
}
]
} |
Company
Request Headers
| Name | Required | Description | Example |
Sports API (Bedriftsidrettslag)
Overview
Method | API Endpoint | Description |
GET | /api/v{version}/organization/structure | Gets the organization structure (branches) of Corporate Sports Club’s along with its details. |
...