Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

Introduction

This document covers the API definitions developed by Norges idrettsforbund og olympiske og paralympiske komité (NIF). NIF API products consists of a set of RESTful services.

This document is written for developers, programmers and the solution providers of third-party membership solutions (3. party/ 3. parties), who seek to sync data with NIF. NIFs requirements must be met to achieve a contract to provide service through NIF APIs to NIF organizations, prior to engaging in a delivery contract with given clubs.

This document also includes how to connect to the APIs and how to read from NIFs Enterprise Service Bus (ESB) hosted on Microsoft Azure cloud.

Change History

No

Changes

Date

1

Remove membership payment and active membership payment entity messages from section Entities Posted to Queue

Remove payment entity JSON schema for membership payment and active membership payment in section Entities JSON schema

6. February 2020

2

In POST Membership, SSN would not be mandatory.

In POST Membership, NationalityID would be used to decide is membership request for Norwegian or Foreign member.

List of Membership Status IDs updated with descriptions.

ToOrgtype JSON added

11. March 2020

3

Added description of how to generate developerUserID

Updated simplified flow for the membership

Updated person merge with all messages related to person merge

22. May 2020

4

Updated person merge message sequence as per new implementation

23. June 2020

5

Specify MembershipRequest-guidelines for 3.party

Remove SSN in MembershipRequest

14. October 2020

6

Added sections for Corporate Sports APIs

11. December 2020

7

Added support for Allidrett

5. March 2021

8

Extended response in PaymentDetails

1. April 2022

Preparations

For any 3. party to connect to and consume NIF APIs, the request must go through the following stages:

  1. Identification

  2. Authentication

  3. Authorization

Identification

A 3.party must be registered with NIF to be correctly identified. When registered, the main contact person at the 3.party receives an invitation email to the NIF API developer portal.

By clicking the link in the email, the 3.party can setup their user and login credentials on the NIF API developer portal. These credentials must not be shared with any non-registered entity.

DST (test environment): https://api-portal-dst.nif.no/

PROD (production environment): https://api-portal.nif.no/

Authentication

When logging into the NIF API developer portal, one may view a list of available NIF API products.

The 3.party can find its API Primary key in the portal. This key will be used for authentication when requesting APIs.

Authorization

The 3.party needs an access token to be authorized, in order to request and manage club data. Club data is highly sensitive and secured. Only 3.parties authorized by the clubs through legal contracts can access respective club data.  

This access token must be fetched by the 3.party by invoking the GET Token API (Gets the bearer token to access APIs for specific club) in the NIF API developer portal. To get the access token of a club, the 3.party needs to provide clubID and API-version and developerUserId.

clubId: is given to you by NIF
version: 1
developerUserId: firstname-lastname-domain-xx
Ocp-Apim-Subscription-Key: auto completed

If the developer email id is donald.duck@idrettsforbundet.no then the developerUserID for this developer will be donald-duck-idrettsforbundet-no.

The GET Token API is restricted to the portal and cannot be accessed and/or invoked from outside (e.g. directly through code or web API tools).

The GET Token API is restricted to the portal and cannot be accessed and/or invoked from outside (e.g. directly through code or web API tools).

NOTE: Along with the API key the access token is highly confidential and must not be shared with unauthorized entities in any way. Both the API key and access token are mandatory parameters in request header of all APIs

Enterprise Service Bus Queue (ESBQ)

In addition to the NIF API developer portal, the 3.party will also receive a connection string to NIF’s ESB Queue in a separate email. Please read further for more details on using the ESB Queues to listen and consume messages.

 

Communication

There will be two modes of communication between NIF and the 3.parties

  • NIF API (REST API)

  • Microsoft Azure Service Bus Queue 

NIF API (REST API)

The REST API uses HTTP requests to GET, PUT, POST and DELETE data. 

Using this communication, the 3.party can fetch initial lookup data and provide data changes to NIF through HTTPS communication.

Required parameters to be set as header in NIF API requests are:

Ocp-Apim-Subscription-Key

This key defines access rights granted to the 3.party. This key is a mandatory parameter in API request header to invoke NIF APIs to identify and authenticate the 3.party.

Authorization

To authorize an API request, the 3.party must provide the authorization token in API request header. This authorization token is unique to a club for a 3.party. These keys will define data access granted to the 3.party for accessing and managing data on behalf of the club.

Service Bus Queue

The 3.party will receive data updates from NIF via a dedicated Azure Service Bus Queue.

NIF will publish relevant changes to the 3.party´s scope to the Azure Service Bus Queue. A message with changed object and delta changes is provided. The 3. party subscribes to the Azure Service Bus Queue to consume posted messages.

Note: Each 3.party will have a dedicated instance of Service Bus Queue. All messages concerning clubs who has an engagement with the given 3.party will be published on the party´s dedicated queue. The messages will be in FIFO (In technical terms it is a Session Enabled Queue).

Once a message is read from the Service Bus Queue, it will be removed from the queue. NIF does not keep a history of messages sent to the 3.party´s queue. The 3.party must maintain the message history if they need to refer to it later, after reading it from the queue.

Messages in the Queue will follow the below mentioned schema:

Message Properties

Property

Type

Value

ObjectId

int

Id of the entity

EntityName

string

Name of the entity.

ChangeType

Change type enumeration

1 - Added        

2 - Modified     

3 - Deleted       

9 - Informational


Note:

  1. Messages with change types ‘Added’ or ‘Modified’ have delta object schema and data.

  2. Informational messages will always have a full object schema and data.

Message Body

The message body contains the JSON message defined in Queue Message Structure.

Service Bus Queue Guidelines

  • Service Bus Queue session is enabled, so the listener must be configured with the option for session.

  • Due to the nature of sessions, all messages will be received in FIFO manner.

  • The listener can be configured in different modes.

o    ReceiveAndDelete: In this mode the message is removed from queue once received.

o    Peek: In this mode the messages is not removed from the queue until the receiver mark that Message as “Complete”.

  • Once the message is removed from the queue it cannot be recovered or replayed.

  • The informational messages (ChangeType = 9) will be received before the main change.

Enumerations

Membership Status

Name

Value

Comment

Active

2

Membership is active

Cancelled

4

If membership is cancelled by user or enddate has reached

Queue Message Structure

Entities posted to Queue

No

Entities

Publish Message to Queue

 

1

TpMembership

When a person is created and then membership is assigned via POST Membership API

When a club chooses to switch 3.party, NIF allows an overlapping period between going live on new solution and shutting down integration on old solution. This grace period is 30 days. During this period if any membership is registered on either of the solutions, then the other 3.party will receive this message in their queue.

2

TpActiveMembership

Similar to the aforementioned scenario, if active membership is registered in either of the 3.parties solutions during the overlapping period, the other solution will receive this message in their queue.

3

TpPerson

When a person is created through POST Membership API

Additionally, similar to the aforementioned scenario, if person is registered in either of the Integration Partner solutions during the overlapping period, the other solution will receive this message in their queue.

4

TpPersonContactInformation

When person contact information is updated.

5

ToOrg

When an organization is created or updated.

6

ToOrgTerminationReason

When an organization is terminated

7

ToOrgType

When there are any changes in org type master/lookup table.

8

ToSport

When any sport is created or updated.

9

TpMembershipPeriod

When club membership Period is updated

10

Tp_PaymentType

When payment is type is added or updated

11

Tp_PaymentStatus

When payment status is updated

Message Body Schema

Entities Relationships

The API endpoints allow 3.parties to perform operations on a club’s behalf. The only prerequisites to use an API endpoint is a valid subscription key and an authorization key. The APIs utilize JSON data format for responses (and in some cases, for requests).

Successful request example

HTTP/1.1 200 OK

Content-Type: application/json
{
}

Failed request example

HTTP/1.1 400 Bad Request

Content-Type: application/json
{
    "message": "Invalid personId",
    "error code": "1002"
}

General Response Codes

HTTP Success Codes

Code

Text

Description

200

The request has succeeded

The meaning of success depends on the HTTP method:

GET: The resource has been fetched and is transmitted in the message body.

PUT or POST: The resource describing the result of the action is transmitted in the message body.

HTTP Error Codes

Code

Text

Description

400

Bad Request

This response means the server did not understand the request due to invalid syntax.

401

Unauthorized

Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.

404

Not Found

The server cannot find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist.

500

Internal Server Error

The server has encountered a situation it does not know how to handle.

502

Bad Gateway

This error response means the server, while working as a gateway to get the response needed to handle the request, received an invalid response.

Commonly used Data types

     Type

Description

Format

Integer

Whole positive or negative numbers

 

Date

Date

yyyy-mm-dd

DateTime

Date and time information

yyyy-mm-dd hh:mm:ss

Decimal

Floating point values

000.00

String

Free text

 

Boolean

True/false values

true / false

Using APIs

GET Token

 Overview

Method

API Endpoint

Description

GET

api/v{version}/auth/token/{clubId}

Allows 3.partiesr to get authorization token to be used for subsequent API requests. This API must be called from the Developer portal of Azure API Management. The representative must login with username and password.

 

Resource Information

Response Format

JSON

Requires Authentication

No

 

 Response Codes

 

Code

Type

Text

Description

1

200

Success

 

 

2

1018

Error

Invalid club Id

 

3

401

Error

Unauthorized

 

 

Response Example

[

“token” : “eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1bmlxdWVfbmFtZSI6IkhpdGVzaFBhcnQyIiwiQ2x1YklkIjoiMTk0MzAiLCJDbHViRGV0YWlsIjoiMTk0MzB-NzF-LTQzIiwibmJmIjoxNTY2OTc0OTA0LCJleHAiOjE1NjY5Nzg1MDQsImlhdCI6MTU2Njk3NDkwNCwiaXNzIjoic2VsZiIsImF1ZCI6ImZ1bi10cGkifQ._YXZwmdSMhmxldBew48Ii1BbZAXgGwXAfUPuEbV40c8”

]


GET Sports

 Overview

Method

API Endpoint

Description

GET

/api/v{version}/sports

Allows Integration Partners to download all NIF sports.

 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.

 

2

Authorization

Yes

This will be the token defining access for an 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

 

 

 

Response Example

[
  {
    "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                      

Method

API Endpoint

Description

GET

/api/v{version}/countries

Fetches all countries available from NIF.

Resource Information

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

Company 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.

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 is provided a separate and unique key.

 

Response Codes

 

Code

Type

Text

Description

1

200

Success

 

Clubs, groups and branch(es)

 

Response Example

{

    "clubId": 16235,
    "clubName": "PetrOl B.I.L.",
    "describingName": "PetrOl B.I.L.",
    "email": "jalla.test@mailinator.com",
    "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

Overview

Method

API Endpoint

Description

POST

/api/v{version}/membership

Allows adding a membership for Norwegian or foreign persons using POST Membership.

Membership represents the connection of a person with a club and/or its branch for a specific sport.

If a person´s nationality is Norwegian, membership request would be considered as Norwegian person request, otherwise request would be considered as a foreign person request. 

The API adds branch level membership data. It will also add club level membership. 

If clubId is passed in the request the API adds club level membership. If a branchId is passed, the request adds branch level membership.

Allidrett:
For allidrett, a groupId has to be passed. The accepted groups for allidrett can be fetched using the GetOrgStructure API. When allidrett groupId is passed, the request will add group level membership for allidrett.

If the Person already exists in the third party membership solution, the PersonId should be sent in the AddMembership-request.

When the membership request contains PersonId then all the information is fetched from NIF by using PersonId.

If PersonId is not passed in the request, the person is searched for, based on first name, last name, date of birth, gender, postal code and nationality.

If no result in this search, a new person will attempt to be created. If the data is imprecise or wrong, and the person most likely already exists, a failure in user verification will arise when end user tries to validate with SSN.

If the PersonId is sent and the response is “invalid person id”, the third party is not synchronized correctly. Work around is to send exact person information, according to entry in The National Population Register (Folkeregisteret).

Club level membership requests are subject to a two-phase verification active for 24 hours. The verification link is sent to the user via email and SMS. This must be passed for request to be fulfilled. After user verification an OTP code is sent by SMS and must be entered to the two-phase temporary site. Once completed request is passed on.

 If a person is already validated in NIFs database, no OTP is required, and the person will not be able to change any personal information in the verification form. All personal information is kept updated by the person itself in Min idrett, by logging in with Idrettens ID.

As soon as two-phase verification is completed successfully, person club and branch level membership are added.

This API will respond with traceId along with other needed parameters. This traceId will be used to trace the request response with messages received in enterprise service bus queue.

After two-phase verification, person and membership records in queue has traceId. In case the person is already validated there is no traceId in the message in the queue or the response.

If Membership at Club or Branch level system will respond with existing MembershipId/ActiveMembershipId.

Entities to get affected by this API:

Tp_Person
Tp_Membership
Tp_ActiveMembership

Resource Information

Response Format

JSON

Requires Authentication

Yes

Request Headers

 

Name

Required

Description

1

ClubId

Yes

ClubId for which API is being requested.

2

Authorization

Yes

This is the token to define access for on-boarded club.

3

Ocp-Apim-Subscription-Key

Yes

API management’s subscription key. There will be separate key for each 3.party.

Request Parameters

 

Name

Required

Description

Example

1

IsClubLevel

Optional

True in case of Club level membership request, false in case of only branch level membership.

true/false

2

StartDate

Optional

StartDate for membership is required if ClubId is not provided, the system will ignore this field when ClubId is provided. 

Possible Value

Must be of today’s date year. For example, if today’s date is 19-Sep-2019. Then start date must be in between 1-Jan-2019 to 31-Dec-2019.

 

"2019-06-07"

3

Person

Mandatory

 

 

4

PersonId

Optional

If PersonId is already present at 3.party´s database, and person is validated

1234567

5

FirstName

Optional

 

Max Length 50

Required if PersonId is not provided. Ignored it if PersionId is provided.

"Ola"

6

LastName

Optional

Max Length 50

 

Required if PersonId is not provided.

Ignored if PersonId is provided.

"Dunk"

7

BirthDate

Optional

Required if PersonId is not provided.

Ignored if PersionId is provided

"1980-07-05"

8

PostCode

Optional

Max Length 50

 

Required if PersonId is not provided

 Ignored if PersionId is provided

"879534"

9

Email

Required

Min Length 8

Max Length 100

 

Either email or mobile is required

Ignored if PersionId is provided

email@email.com

10

MobilePhone

Required

 Min Length 8

Max Length 12

 

Either Email or Mobile is required

 Ignored if PersionId is provided

"90909090"

11

CountryCode

Optional

 

Min Length 2

Max Length 6

CountryCode is required in the case MobilePhone is provided, and if PersonId is not provided.

 Ignored if PersionId is provided.

 

+47 , +91

12

GenderId

Optional

Required if PersonId is not provided.

Ignored if PersionId is provided.

Possible Value

1 - Mann (male)
2 - Kvinne (female)
5 - Ukjent (unknown)

2

14

CountryId

Optional (when PersonId is supplied/Membership is being added for a Norwegian citizen)

Required if PersonId is not provided, Ignored if PersionId is provided.

 

1500152

15

NationalityId

Required

Nationality of person is required. (Pass the countryId from getCounties-API)

1500152

16

AddressLIne1

Optional

Max Length 50 

First line of address

"Addressline 1”

17

AddressLIne2

Optional

Max Length 50 

Second line of address

"Addressline 2"

18

City

Optional 

Max Length 50

City of residence

"Oslo"

19

PrivatePhone

Optional

Min Length 8

Max Length 18 

Private phone number

"78965872"

20

WorkPhone

Optional

Min Length 8

Max Length 18 

Work phone number

"78965872"

21

IsSecretAddress

Optional

If the person has configured to hide their address from viewership on the UI, this flag will be set to true.

When set to true, it is the responsibility of the 3.party to hide this information from viewership on their UI.

true/false

22

IsSecretPrivatePhone

Optional

Similar to aforementioned scenario, if the person’s private phone is marked as secret, the 3.party must also hide it from their UI.

true/false

23

IsSecretWorkPhone

Optional

Similar to aforementioned scenario, if the person’s work phone is marked as secret, the 3. party must also hide it from their UI.

true/false

24

IsSecretMobilePhone

Optional

Similar to aforementioned scenario, if the person’s mobile phone is marked as secret, the 3.party must also hide it from their UI.

true/false

25

IsSecretEmail

Optional

Similar to aforementioned scenario, if the person’s email is marked as secret, the 3.party must also hide it from their UI.

true/false

26

Sports

Optional

Branch level Membership

[]

27

BranchId

Mandatory

 

1238

28

SportId

Mandatory

(Pass the sport id from getSports API)

 

29

StartDate

Mandatory

StartDate for branch level Membership 

Possible Value

  1. Must be of today’s date year. For example, if today’s date is 19-Sep-2019. Then start date must be in between 1-Jan-2019 to 31-Dec-2019

  2. Must be greater than Club level membership start date.

  3. Must be of Club level membership’s start date year. For example, if Club level membership’s start date is 19-Sep-2019. Then start date must be in between 1-Jan-2019 to 31-Dec-2019.

 

30

EndDate

Optional

Possible Value

Must be greater than today’s date. 

OBSOLETE?

 

Two-phase verification link and One Time Password (OTP) matrix

 

Cases

Send two-phase link

OTP SMS Code

Note

1

Add Club level membership with new person (Norwegian)

Yes

Yes

 

2

Add Club level membership with new person (Foregin)

Yes

No

 

3

Add Club level membership with validated existing person

Yes

No

 

4

Add Club level membership with unvalidated existing person (Norwegian)

Yes

Yes

 

5

Add Club level membership with unvalidated existing person (Non-Norwegian)

Yes

No

 

6

Add Club level and Branch level membership with new person (Norwegian)

Yes

Yes

 

7

Add Club level and Branch level membership with new person (Non-Norwegian)

Yes

No

 

8

Add Club level and Branch level membership with validated existing person

Yes

No

 

9

Add Club level and Branch level membership with unvalidated existing person (Norwegian)

Yes

Yes

 

10

Add Club level and Branch level membership with unvalidated existing person (Non-Norwegian)

Yes

No

 

11

Add Branch level membership unvalidated existing person

No

No

 

12

Add Branch level membership with validated existing person

No

No

 

13

Add Branch level membership without club level membership with new Person

No

No

Branch level membership cannot be added without club level membership. Hence two-phase verification would not be initiated.

14

Add Branch level membership without club level membership for validated existing person

No

No

Branch level membership cannot be added without club level membership. Hence two-phase verification would not be initiated.

15

Add Branch level membership without club level membership for unvalidated existing person (Norwegian)

No

No

Branch level membership cannot be added without club level membership. Hence two-phase verification would not be initiated.

16

Add Branch level membership without club level membership for unvalidated existing person (Non-Norwegian)

No

No

Branch level membership cannot be added without club level membership. Hence two-phase verification would not be initiated.

 

 Simplified add member flow

 

Response codes

 

Code

Text

Description

1

200

 Success

 

2

1001

Either PersonId or a combination of (FirstName, LastName, BirthDate, PostCode, NationalityId) must be supplied. 

 

3

1002

Invalid Person Id

 

4

1006

Invalid Branch Id 

 

5

1007

Start date cannot be past/future year date. 

 

6

1010

Either Email or MobilePhone and CountryCode must be supplied. 

 

7

1013

Branch level membership information missing. 

 

8

1018

Invalid club Id. 

 

9

1034

Person not found.

 

10

1036

Start date is required.

 

11

1038

Branch start date must be grater then membership start date.

 

12

1039

Invalid request parameters.

 

13

1042

Group level membership for Club is not allowed.

 

14

3001

Membership not found for specific period from date.

 

 

Membership Request Example

{
  "startDate": "2019-08-27",
  "isClubLevel": true,
  "person": {
    "personId": 8756934, -- NB: If personId is provided, all person properties ignored.
    "firstName": "Ola",
    "lastName": "Dunk",
    "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
  },
  "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"
    }
  ]
}

Membership Response Example

{
  "personId": 8756934,
  "membershipId": 0,
  "clubId": 19428,
  "clubName": "Gjermundsen Auto B.I.L.",
  "startDate": "2019-08-27",
  "traceId": "7AC07206-471E-4015-9ED7-E6DB55ED7201",
  "sports”: [
    {
      "branchId": 819760,
      "sportId": 207,
      "branchName": "Berg IL",
      "activeMembershipId": 0
    },
    {
      "branchId": 827527,
      "sportId": 220,
      "branchName": "Berg IL",
      "activeMembershipId": 0
    }

  ],
  "responseMessage": "Membership request is accepted at Club Level. 
  It is pending for two phase verification."
}

NOTE: If response contains personId and no membershipId, NEVER use this personId until the two phase verification is done by the end user, and the information is provided on the 3. party´s subscription queue.

Allidrett request example

{
  "startDate": "2019-08-27",
  "isClubLevel": true,
  "person": {
    "personId": "",
    "firstName": "Dolly",
    "lastName": "Duck",
    "birthDate": "1980-07-05",
    "postCode": "0010",
    "email": "dd@mailinator.com",
    "mobilePhone": "85569745",
    "genderId": 2,
    "countryId": 1500152,
    "nationalityId": 1500152,
    "addressLine1": "Blålyngveien 8",
    "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"
    }
  ],
  "groups": [
    {
      "sportId": 0,
      "groupId": 544901,
      "startDate": "2019-08-27",
      "endDate": "2019-09-26"
    }
  ]
}

Allidrett response example

{
  "personId": 8756934,
  "membershipId": 0,
  "clubId": 19428,
  "clubName": "Gjermundsen Auto B.I.L.",
  "startDate": "2019-08-27",
  "traceId": "7AC07206-471E-4015-9ED7-E6DB55ED7201",
  "sports": [],
  "groups": [],
  "person": null,
  "responseMessage": "Membership request is accepted at Club Level. 
  It is pending for two phase verification."
}

Endpoints

Annet


Table of Content

7.5.2         Corporate Sports API 39

7.6        POST Payment detail 49

7.6.1         External Membership API 49

7.6.2         Corporate Sports API 52

7.7        GET Membership Payment Details  56

7.7.1         External Membership API 56

7.7.2         Corporate Sports API 57

7.8        Delete Membership  60

7.8.1         External Membership API 60

7.8.2         Corporate Sports API 62

9       Entities JSON Schema  78

9.1        TpMembership  78

9.2        TpActiveMembership  81

9.3        ToOrgType  83

9.4        TpPerson  85

9.5        TpPersonContactInformation  89

9.6        ToOrg  91

9.7        ToOrgTerminationReason  101

9.8        ToSport 103

9.9        TpActiveMembershipStatus  105

9.11     TpMembershipPeriod  106

9.12     TpMembershipStatus  108

9.13     TpPaymentStatus  109

9.13 TpPaymentType  109

 

  • No labels