Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

...

 

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

...

Company Sports API

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.

Resource Information

Response Format

JSON

Requires Authentication

Yes

 

Request Headers

 

Name

Required

Description

Example

1

ClubId

Yes

Club Id for which API is being requested. Pass Corporate Sport club’s ID here to get the org structure for Corporate Sport club.

 

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

Integration Partner

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": 16235,

...


    "clubName": "PetrOl B.I.L.",

...


    "describingName": "PetrOl B.I.L.",

...


    "email": "

...

franziska.

...

blystad@npd.

...

no",

...


    "city": "STAVANGER",

...


    "county": "Norge",

...


    "longitude": null,

...


    "latitude": null,

...


    "groups":

...

 [
        {
            "groupId": 766441,

...


            "groupName": "PetrOl B.I.L.",

...


            "describingName": "PetrOl B.I.L. - Curling",

...


            "sportId": 204,

...


            "sportName": "Curling",

...


            "branches": []

...


        }
]
}


POST Membership

External Membership API

...