NAV Navigation
HTTP

INTRODUCTION

Welcome to the Frontend API project documentation, which was created by eFitness. We hope that this will allow you to conveniently use our application and the examples will be meaningful and understandable. If you have any questions or concerns, please contact with us.

Getting started

What can you find

The functions created in this API contain functionalities operating from the member's perspective. That's why you can find here things like add membership, but not creating a membership definition or getting news, but not adding a new one. A list of methods can be found in the table of contents of this documentation.

Generic method building

One of the assumptions was to build the application on a generic basis, which means that many functionalities are similar to each other. The methods therefore contain the following

common properties

Name Type Description
accept-language header Sets the language in which data and error messages are returned (currently not supported)
client-request-id header Request id assigned by the client, specifying this value allows to obtain this value in the response header.
member-token header Token used to authorize a club member for methods requiring its context
api-access-token header Token required to gain access to the method
clubId path Club identifier used for methods requiring its context
limit query Limits to the indicated number of first elements See more
offset query Skip indicated number of first elements See more
sortBy query Sorts elements by the indicated property(ies). Eg. name:asc,from:desc See more

common validators

Type Description
Tokens validator Verifies if tokens are correct and valid See more
Request not null validator In the case that request data is required, an error will be returned if it is not provided
Collection request validator Verifies that the limit and offset are non-negative numbers and that sortBy points to existing fields that can be used for sorting and are in the correct format See more
Values validator If a given property is of enumerated type, then there is a validation whether the given value is in the range

Authentication

API access authorization

Access to api is possible after generating the api-access-token. You need to contact our customer support department for your login, password to be able to obtain it. When you have it just POST to action /api/token/api-access.

--- Request ---
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ \ 
   "login": "username", \ 
   "password": "pass123" \ 
 } \ 
 ' 'https://api-frontend2.efitness.com.pl/api/token/api-access'

--- Response ---
{
  "apiAccessToken": "JHV2ZTg62UeQGRqL0rl72Q==",
  "name": "username",
  "issued": "2019-10-04T09:33:10",
  "expires": "2020-10-03T09:33:10",
  "expiresIn": 31536000
}

API access token diagram

Member Authentication

To be authorized as a member you need to have Member Credentials (Login and Password) and Club Identifier. You will get member data when the Member registers in the club, club identifier will provide our customer support (check POST /api/members). When you have it just simply POST to /api/clubs/{clubId}/token/member, where clubId is club id received and in header - currently obtained api-access-token. It will return member authorization token and also refresh token.

--- Request ---
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'api-access-token: JHV2ZTg62UeQGRqL0rl72Q==' -d '{ \ 
   "login": "userLogin", \ 
   "password": "pass123" \ 
 }' 'https://api-frontend2.efitness.com.pl/api/clubs/43/token/member'

--- Response ---
{
  "accessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1laWQiOiIyODQzMTUiLCJzdWIiOiIyODQzMTUgICAgICIsImp0aSI6IjZhZDI5ZmRjLTk2MWUtNGQ5OS1iZDA1LTE1NDAxYjI0MjQ0MCIsImlhdCI6MTU4MjczMDY3NiwiaWQiOiIyODQzMTUiLCJuYmYiOjE1ODI3MzA2NzUsImV4cCI6MTU4MjczNzg3NSwiaXNzIjoiYXBpRnJvbnRlbmQiLCJhdWQiOiJodHRwczovL2FwaS1mcm9udGVuZDIuZWZpdG5lc3MuY29tLnBsIn0.X1UZVzqh4F1sea_htkBYfMFWB9wi4qI4QRRxOsVJNl0bkoUHDk5xZDSkMY9WPtQau27esYvEiG76CUMOEk4sutcQ0A_sLfzVcBznD8ZG8aXYJTuF-A2ZeskcMQE66BKGQyNsJjARjUkE4Th8U-zrnZFBvGq1rZQ4P-3RKtOtSQyjON4jzMb7VLAZDw4YXKerTxy17m9OyypKqYMQ-lER4vyUO1_zHKkH7btizM3jxppOrQe0bFJmw8-b4wqogeIXlIL85fcMBWhQJ2jeNuQLOxPZHtt5kuk5hNS8uHKxHVErryFz9EVcty52_co8Gl6Nu2PU05mcK4r3ig8LGeE1cA",
  "tokenType": "Bearer",
  "refreshToken": "Q6VV23F1wJMbjOkp1RnRINu6E8SWJx_En5l6za0J3uA",
  "name": "284315     ",
  "id": "284315",
  "issued": "2020-02-26T15:24:35",
  "expires": "2020-02-26T17:24:35",
  "expiresIn": 1582737876
}

Member token diagram

Refresh Token

When you obtain the member token (and also refresh token) it will be valid for 2 hours until it expires. Then you should use the obtained refresh token to generate new valid member token. The refresh token is valid for 5 days from the moment that it was generated. Simply POST to action /api/clubs/{clubId}/token/member/refresh with member refresh token. Make sure to save newly created token in place of older one as that one will become invalid.

--- Request ---
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'member-token: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1laWQiOiIyODQzMTUiLCJzdWIiOiIyODQzMTUgICAgICIsImp0aSI6IjZhZDI5ZmRjLTk2MWUtNGQ5OS1iZDA1LTE1NDAxYjI0MjQ0MCIsImlhdCI6MTU4MjczMDY3NiwiaWQiOiIyODQzMTUiLCJuYmYiOjE1ODI3MzA2NzUsImV4cCI6MTU4MjczNzg3NSwiaXNzIjoiYXBpRnJvbnRlbmQiLCJhdWQiOiJodHRwczovL2FwaS1mcm9udGVuZDIuZWZpdG5lc3MuY29tLnBsIn0.X1UZVzqh4F1sea_htkBYfMFWB9wi4qI4QRRxOsVJNl0bkoUHDk5xZDSkMY9WPtQau27esYvEiG76CUMOEk4sutcQ0A_sLfzVcBznD8ZG8aXYJTuF-A2ZeskcMQE66BKGQyNsJjARjUkE4Th8U-zrnZFBvGq1rZQ4P-3RKtOtSQyjON4jzMb7VLAZDw4YXKerTxy17m9OyypKqYMQ-lER4vyUO1_zHKkH7btizM3jxppOrQe0bFJmw8-b4wqogeIXlIL85fcMBWhQJ2jeNuQLOxPZHtt5kuk5hNS8uHKxHVErryFz9EVcty52_co8Gl6Nu2PU05mcK4r3ig8LGeE1cA' --header 'api-access-token: JHV2ZTg62UeQGRqL0rl72Q==' -d '{ \ 
   "refreshToken": "Q6VV23F1wJMbjOkp1RnRINu6E8SWJx_En5l6za0J3uA" \ 
 }' 'https://api-frontend2.efitness.com.pl/api/clubs/43/token/member/refresh'

--- Response ---
{
  "accessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1laWQiOiIyODQzMTUiLCJzdWIiOiIyODQzMTUgICAgICIsImp0aSI6IjdjMDIxNDZhLWIwNmEtNGQ2Zi1iOWViLTMxNWE5NzBiOTkxMyIsImlhdCI6MTU4MjczMjQ5NiwiaWQiOiIyODQzMTUiLCJuYmYiOjE1ODI3MzI0OTYsImV4cCI6MTU4MjczOTY5NiwiaXNzIjoiYXBpRnJvbnRlbmQiLCJhdWQiOiJodHRwczovL2FwaS1mcm9udGVuZDIuZWZpdG5lc3MuY29tLnBsIn0.iVj_CO_DBmJRw0--X2O2boidE7JnPhWoI5aNn2WhNYtK92xOpkjVDI3mcv--cMg5i-oNIsOItVIt20nYw4BlnVt6Whf6dVr28u2WdzDM7U-_wrIQFcqxS5gvt3fjaLxsjybSj6Am5pp3fzwIZ8qJg8mvUkyNNWcwUHapZCqEskwscrGps1Y22EqDPPzMabBpHdaY6CaXGPJ0fuq2uB6bG5klFnVtLCpy3veWUlERU6oIaetkl-9VHH_Jv_6kgFAST3HxiSduFn1m_KxsAOunMIKe2C1Lf1OeGlYOZyHkeuTlIznSqx-PyYCpuGJIBtkw0l36gUSzQJaONhWDGvf4lg",
  "tokenType": "Bearer",
  "refreshToken": "SnuEIo25L51tjGZ6esGUtFutISC2Bh6TC5igeQp6egQ",
  "name": "userLogin",
  "id": "123456",
  "issued": "2020-02-26T15:54:56",
  "expires": "2020-02-26T17:54:56",
  "expiresIn": 1582739696
}

Member token diagram

Token usage chart

This flowchart shows the example logic path that should be used to determine whether token should be created/refreshed. It assumes that the active member token is saved in cache, and should be adapted to specific use cases in API consumer applications.

Token flow chart

Examples

Create Member

Summary

This example demonstrates how to create a club member.

Workflow

--- Step 1 ---
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ \ 
   "login": "username", \ 
   "password": "pass123" \ 
 } \ 
 ' 'https://api-frontend2.efitness.com.pl/api/token/api-access'

--- Step 2 ---
curl -X GET --header 'Accept: application/json' --header 'api-access-token: JHV2ZTg62UeQGRqL0rl72Q==' 'https://api-frontend2.efitness.com.pl/api/clubs/43/members/consent-definitions'

--- Step 3 ---
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'api-access-token: JHV2ZTg62UeQGRqL0rl72Q==' -d '{ \ 
   "firstName": "default", \ 
   "lastName": "default", \ 
   "personalIdentityNumber": "default", \ 
   "email": null, \ 
   "confirmationEmail": null, \ 
   "street": null, \ 
   "streetAdditionalInfo": null, \ 
   "flatNumber": null, \ 
   "postalCode": null, \ 
   "city": null, \ 
   "county": null, \ 
   "carRegistrationNumber": null, \ 
   "landlinePhoneNumber": null, \ 
   "cellPhone": null, \ 
   "countryPhoneCode": null, \ 
   "identityDocumentType": null, \ 
   "identityDocumentNumber": null, \ 
   "gender": null, \ 
   "birthday": null, \ 
   "bankName": null, \ 
   "iban": null, \ 
   "bic": null, \ 
   "isForeign": false, \ 
   "memberSource": null, \ 
   "countryOfResidence": null, \ 
   "selectedConsentIds": null, \ 
   "companyInvoiceData": null \ 
 }' 'https://api-frontend2.efitness.com.pl/api/clubs/43/members'

Create Membership

Summary

This example demonstrates how to create membership.

Workflow

--- Step 1 ---
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ \ 
   "login": "username", \ 
   "password": "pass123" \ 
 } \ 
 ' 'https://api-frontend2.efitness.com.pl/api/token/api-access'

--- Step 2 ---
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'api-access-token: JHV2ZTg62UeQGRqL0rl72Q==' -d '{ \ 
   "login": "userLogin", \ 
   "password": "pass123" \ 
 }' 'https://api-frontend2.efitness.com.pl/api/clubs/43/token/member'

--- Step 3 ---
curl -X GET --header 'Accept: application/json' --header 'api-access-token: JHV2ZTg62UeQGRqL0rl72Q==' 'https://api-frontend2.efitness.com.pl/api/clubs/43/membership-definitions'

--- Step 4 ---
curl -X GET --header 'Accept: application/json' --header 'api-access-token: JHV2ZTg62UeQGRqL0rl72Q==' 'https://api-frontend2.efitness.com.pl/api/clubs/43/membership-definitions/222/consent-definitions'

--- Step 5 ---
curl -X GET --header 'Accept: application/json' --header 'api-access-token: JHV2ZTg62UeQGRqL0rl72Q==' 'https://api-frontend2.efitness.com.pl/api/clubs/43/membership-definitions/222/service-definitions'

--- Step 6 ---
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'member-token: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1laWQiOiIyODQzMTUiLCJzdWIiOiIyODQzMTUgICAgICIsImp0aSI6IjZhZDI5ZmRjLTk2MWUtNGQ5OS1iZDA1LTE1NDAxYjI0MjQ0MCIsImlhdCI6MTU4MjczMDY3NiwiaWQiOiIyODQzMTUiLCJuYmYiOjE1ODI3MzA2NzUsImV4cCI6MTU4MjczNzg3NSwiaXNzIjoiYXBpRnJvbnRlbmQiLCJhdWQiOiJodHRwczovL2FwaS1mcm9udGVuZDIuZWZpdG5lc3MuY29tLnBsIn0.X1UZVzqh4F1sea_htkBYfMFWB9wi4qI4QRRxOsVJNl0bkoUHDk5xZDSkMY9WPtQau27esYvEiG76CUMOEk4sutcQ0A_sLfzVcBznD8ZG8aXYJTuF-A2ZeskcMQE66BKGQyNsJjARjUkE4Th8U-zrnZFBvGq1rZQ4P-3RKtOtSQyjON4jzMb7VLAZDw4YXKerTxy17m9OyypKqYMQ-lER4vyUO1_zHKkH7btizM3jxppOrQe0bFJmw8-b4wqogeIXlIL85fcMBWhQJ2jeNuQLOxPZHtt5kuk5hNS8uHKxHVErryFz9EVcty52_co8Gl6Nu2PU05mcK4r3ig8LGeE1cA' --header 'api-access-token: JHV2ZTg62UeQGRqL0rl72Q==' -d '{ \ 
   "membershipDefinitionId": 222, \ 
   "agreementFrom": "2019-07-12T10:34:53.107Z", \ 
   "discountCoupon": "xyz", \ 
   "selectedConsentIds": [ \ 
     1 \ 
   ], \ 
   "selectedServiceIds": [ \ 
     2 \ 
   ] \ 
 }' 'https://api-frontend2.efitness.com.pl/api/clubs/43/members/memberships'

Change Password

Summary

This example demonstrates how to change password.

Workflow

--- Step 1 ---
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ \ 
   "login": "username", \ 
   "password": "pass123" \ 
 } \ 
 ' 'https://api-frontend2.efitness.com.pl/api/token/api-access'

--- Step 2 ---
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'api-access-token: JHV2ZTg62UeQGRqL0rl72Q==' -d '{ \ 
   "login": "userLogin", \ 
   "password": "pass123" \ 
 }' 'https://api-frontend2.efitness.com.pl/api/clubs/43/token/member'

--- Step 3 ---
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'member-token: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1laWQiOiIyODQzMTUiLCJzdWIiOiIyODQzMTUgICAgICIsImp0aSI6IjZhZDI5ZmRjLTk2MWUtNGQ5OS1iZDA1LTE1NDAxYjI0MjQ0MCIsImlhdCI6MTU4MjczMDY3NiwiaWQiOiIyODQzMTUiLCJuYmYiOjE1ODI3MzA2NzUsImV4cCI6MTU4MjczNzg3NSwiaXNzIjoiYXBpRnJvbnRlbmQiLCJhdWQiOiJodHRwczovL2FwaS1mcm9udGVuZDIuZWZpdG5lc3MuY29tLnBsIn0.X1UZVzqh4F1sea_htkBYfMFWB9wi4qI4QRRxOsVJNl0bkoUHDk5xZDSkMY9WPtQau27esYvEiG76CUMOEk4sutcQ0A_sLfzVcBznD8ZG8aXYJTuF-A2ZeskcMQE66BKGQyNsJjARjUkE4Th8U-zrnZFBvGq1rZQ4P-3RKtOtSQyjON4jzMb7VLAZDw4YXKerTxy17m9OyypKqYMQ-lER4vyUO1_zHKkH7btizM3jxppOrQe0bFJmw8-b4wqogeIXlIL85fcMBWhQJ2jeNuQLOxPZHtt5kuk5hNS8uHKxHVErryFz9EVcty52_co8Gl6Nu2PU05mcK4r3ig8LGeE1cA' --header 'api-access-token: JHV2ZTg62UeQGRqL0rl72Q==' -d '{ \ 
   "oldPassword": "pass123", \ 
   "newPassword": "pass456", \ 
   "newConfirmPassword": "pass456" \ 
 }' 'http://api-frontend-2.dev.efitness.pl/api/clubs/43/members/password-change'

Reset Password

Summary

This example demonstrates how to reset password.

Requirements

You can reset member password in two-factor way. It means sending an url to a member with site url where he can enter a new password. The development of such a site is on your side. Method POST /api/clubs/{clubId}/members/password-reset generates token and send an email with a link to a member.

Confirmation of the operation is sent to POST /api/clubs/{clubId}/members/password-reset-confirm (with token). It is necessary to create an endpoint responsible for handling the confirmation. You have to provide url to this endpoint by entering it each time you send email change request (parameter resetPasswordUrl), otherwise, an e-mail will be sent with the address to the test service on our side. Token to url will be attached as follows: {resetPasswordUrl}?token={token}.

Workflow

--- Step 1 ---
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ \ 
   "login": "username", \ 
   "password": "pass123" \ 
 } \ 
 ' 'https://api-frontend2.efitness.com.pl/api/token/api-access'

--- Step 2 ---
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'api-access-token: JHV2ZTg62UeQGRqL0rl72Q==' -d '{ \ 
   "email": "userLogin%40efitness.com", \ 
   "resetPasswordUrl": "https://efitness.com/ResetPasswordConfirm" \ 
 }' 'http://api-frontend-2.dev.efitness.pl/api/clubs/43/members/password-reset'

--- Step 5 ---
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'api-access-token: JHV2ZTg62UeQGRqL0rl72Q==' -d '{ \ 
   "resetPasswordToken": "2a13c408-d39f-467c-b219-e2e90d36e645", \ 
   "newPassword": "pass456" \ 
 }' 'http://api-frontend-2.dev.efitness.pl/api/clubs/43/members/password-reset-confirm'

Change Email

Summary

This example demonstrates how to change email.

Requirements

You can update member email in two-factor way, which means sending an url with token, the clicking of which will cause send confirmation request. Method POST /api/clubs/{clubId}/members/email generates token and returns it in response. The method can also send an email with a link to a member, but this option is deactivated by default. For enable it, please contact with us.

Confirmation of the operation is sent to POST /api/clubs/{clubId}/members/email-confirm (with token). It is necessary to create an endpoint responsible for handling the confirmation. You have to provide url to this endpoint by entering it each time you send email change request (parameter confirmationUrl), otherwise, an e-mail will be sent with the address to the test service on our side. Token to url will be attached as follows: {confirmUrl}?token={token}.

Workflow

--- Step 1 ---
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ \ 
   "login": "username", \ 
   "password": "pass123" \ 
 } \ 
 ' 'https://api-frontend2.efitness.com.pl/api/token/api-access'

--- Step 2 ---
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'api-access-token: JHV2ZTg62UeQGRqL0rl72Q==' -d '{ \ 
   "login": "userLogin", \ 
   "password": "pass123" \ 
 }' 'https://api-frontend2.efitness.com.pl/api/clubs/43/token/member'

--- Step 3 ---
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'member-token: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1laWQiOiIyODQzMTUiLCJzdWIiOiIyODQzMTUgICAgICIsImp0aSI6IjZhZDI5ZmRjLTk2MWUtNGQ5OS1iZDA1LTE1NDAxYjI0MjQ0MCIsImlhdCI6MTU4MjczMDY3NiwiaWQiOiIyODQzMTUiLCJuYmYiOjE1ODI3MzA2NzUsImV4cCI6MTU4MjczNzg3NSwiaXNzIjoiYXBpRnJvbnRlbmQiLCJhdWQiOiJodHRwczovL2FwaS1mcm9udGVuZDIuZWZpdG5lc3MuY29tLnBsIn0.X1UZVzqh4F1sea_htkBYfMFWB9wi4qI4QRRxOsVJNl0bkoUHDk5xZDSkMY9WPtQau27esYvEiG76CUMOEk4sutcQ0A_sLfzVcBznD8ZG8aXYJTuF-A2ZeskcMQE66BKGQyNsJjARjUkE4Th8U-zrnZFBvGq1rZQ4P-3RKtOtSQyjON4jzMb7VLAZDw4YXKerTxy17m9OyypKqYMQ-lER4vyUO1_zHKkH7btizM3jxppOrQe0bFJmw8-b4wqogeIXlIL85fcMBWhQJ2jeNuQLOxPZHtt5kuk5hNS8uHKxHVErryFz9EVcty52_co8Gl6Nu2PU05mcK4r3ig8LGeE1cA' --header 'api-access-token: JHV2ZTg62UeQGRqL0rl72Q==' -d '{ \ 
   "newEmail": "newEmail%40Efitness.com", \ 
   "confirmationUrl": "https://efitness.com/EmailConfirm" \ 
 }' 'http://api-frontend-2.dev.efitness.pl/api/clubs/43/members/email'

--- Step 5 ---
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'api-access-token: JHV2ZTg62UeQGRqL0rl72Q==' -d '{ \ 
   "token": "2a13c408-d39f-467c-b219-e2e90d36e645" \ 
 }' 'http://api-frontend-2.dev.efitness.pl/api/clubs/43/members/email-confirm'

Create Member from Prospect

Summary

This example demonstrates how to create member from prospect.

Workflow

--- Step 1 ---
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ \ 
   "login": "username", \ 
   "password": "pass123" \ 
 } \ 
 ' 'https://api-frontend2.efitness.com.pl/api/token/api-access'

--- Step 2 ---
curl -X GET --header 'Accept: application/json' --header 'api-access-token: JHV2ZTg62UeQGRqL0rl72Q==' 'https://api-frontend2.efitness.com.pl/api/clubs/43/member-sources'

--- Step 3 ---
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'api-access-token: JHV2ZTg62UeQGRqL0rl72Q==' -d '{ \ 
   "firstName": "default", \ 
   "lastName": "default", \ 
   "email": null, \ 
   "gender": null, \ 
   "countryPhoneCode": null, \ 
   "cellPhone": null, \ 
   "street": null, \ 
   "flatNumber": null, \ 
   "postalCode": null, \ 
   "city": null, \ 
   "memberSource": null, \ 
   "status": null, \ 
   "remarks": null, \ 
   "birthday": null, \ 
 }' 'https://api-frontend2.efitness.com.pl/api/clubs/43/prospect-members/'

Add freeze

Summary

This example demonstrates how to freeze membership.

Workflow

--- Step 1 ---
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ \ 
   "login": "username", \ 
   "password": "pass123" \ 
 } \ 
 ' 'https://api-frontend2.efitness.com.pl/api/token/api-access'

--- Step 2 ---
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'api-access-token: JHV2ZTg62UeQGRqL0rl72Q==' -d '{ \ 
   "login": "userLogin", \ 
   "password": "pass123" \ 
 }' 'https://api-frontend2.efitness.com.pl/api/clubs/43/token/member'

Freeze installments

Execute request on POST https://{baseUrl}/api/clubs/{clubId}/members/memberships/{id}/freeze-installments

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'member-token: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1laWQiOiIyODQzMTUiLCJzdWIiOiIyODQzMTUgICAgICIsImp0aSI6IjZhZDI5ZmRjLTk2MWUtNGQ5OS1iZDA1LTE1NDAxYjI0MjQ0MCIsImlhdCI6MTU4MjczMDY3NiwiaWQiOiIyODQzMTUiLCJuYmYiOjE1ODI3MzA2NzUsImV4cCI6MTU4MjczNzg3NSwiaXNzIjoiYXBpRnJvbnRlbmQiLCJhdWQiOiJodHRwczovL2FwaS1mcm9udGVuZDIuZWZpdG5lc3MuY29tLnBsIn0.X1UZVzqh4F1sea_htkBYfMFWB9wi4qI4QRRxOsVJNl0bkoUHDk5xZDSkMY9WPtQau27esYvEiG76CUMOEk4sutcQ0A_sLfzVcBznD8ZG8aXYJTuF-A2ZeskcMQE66BKGQyNsJjARjUkE4Th8U-zrnZFBvGq1rZQ4P-3RKtOtSQyjON4jzMb7VLAZDw4YXKerTxy17m9OyypKqYMQ-lER4vyUO1_zHKkH7btizM3jxppOrQe0bFJmw8-b4wqogeIXlIL85fcMBWhQJ2jeNuQLOxPZHtt5kuk5hNS8uHKxHVErryFz9EVcty52_co8Gl6Nu2PU05mcK4r3ig8LGeE1cA' --header 'api-access-token: JHV2ZTg62UeQGRqL0rl72Q==' -d '{ \ 
   "freezeReasonId": 1, \ 
   "freezeInstallmentsIds": [1]] \ 
 }' 'http://api-frontend-2.dev.efitness.pl/api/clubs/43/members/memberships/1/freeze-installments'

Standard freeze

Execute request on POST https://{baseUrl}/api/clubs/{clubId}/members/memberships/{id}/freeze

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'member-token: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1laWQiOiIyODQzMTUiLCJzdWIiOiIyODQzMTUgICAgICIsImp0aSI6IjZhZDI5ZmRjLTk2MWUtNGQ5OS1iZDA1LTE1NDAxYjI0MjQ0MCIsImlhdCI6MTU4MjczMDY3NiwiaWQiOiIyODQzMTUiLCJuYmYiOjE1ODI3MzA2NzUsImV4cCI6MTU4MjczNzg3NSwiaXNzIjoiYXBpRnJvbnRlbmQiLCJhdWQiOiJodHRwczovL2FwaS1mcm9udGVuZDIuZWZpdG5lc3MuY29tLnBsIn0.X1UZVzqh4F1sea_htkBYfMFWB9wi4qI4QRRxOsVJNl0bkoUHDk5xZDSkMY9WPtQau27esYvEiG76CUMOEk4sutcQ0A_sLfzVcBznD8ZG8aXYJTuF-A2ZeskcMQE66BKGQyNsJjARjUkE4Th8U-zrnZFBvGq1rZQ4P-3RKtOtSQyjON4jzMb7VLAZDw4YXKerTxy17m9OyypKqYMQ-lER4vyUO1_zHKkH7btizM3jxppOrQe0bFJmw8-b4wqogeIXlIL85fcMBWhQJ2jeNuQLOxPZHtt5kuk5hNS8uHKxHVErryFz9EVcty52_co8Gl6Nu2PU05mcK4r3ig8LGeE1cA' --header 'api-access-token: JHV2ZTg62UeQGRqL0rl72Q==' -d '{ \ 
   "freezeType" : 0, \
   "duration" : 1, \
   "freezeStartDate" : "2022-01-01", \
   "freezeReasonId": 1, \ 
 }' 'http://api-frontend-2.dev.efitness.pl/api/clubs/43/members/memberships/1/freeze'

Remove freeze

Summary

This example demonstrates how to defreeze membership.

Workflow

--- Step 1 ---
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ \ 
   "login": "username", \ 
   "password": "pass123" \ 
 } \ 
 ' 'https://api-frontend2.efitness.com.pl/api/token/api-access'

--- Step 2 ---
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'api-access-token: JHV2ZTg62UeQGRqL0rl72Q==' -d '{ \ 
   "login": "userLogin", \ 
   "password": "pass123" \ 
 }' 'https://api-frontend2.efitness.com.pl/api/clubs/43/token/member'

Standard defreeze

curl -X DELETE --header 'Accept: application/json' --header 'member-token: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1laWQiOiIyODQzMTUiLCJzdWIiOiIyODQzMTUgICAgICIsImp0aSI6IjZhZDI5ZmRjLTk2MWUtNGQ5OS1iZDA1LTE1NDAxYjI0MjQ0MCIsImlhdCI6MTU4MjczMDY3NiwiaWQiOiIyODQzMTUiLCJuYmYiOjE1ODI3MzA2NzUsImV4cCI6MTU4MjczNzg3NSwiaXNzIjoiYXBpRnJvbnRlbmQiLCJhdWQiOiJodHRwczovL2FwaS1mcm9udGVuZDIuZWZpdG5lc3MuY29tLnBsIn0.X1UZVzqh4F1sea_htkBYfMFWB9wi4qI4QRRxOsVJNl0bkoUHDk5xZDSkMY9WPtQau27esYvEiG76CUMOEk4sutcQ0A_sLfzVcBznD8ZG8aXYJTuF-A2ZeskcMQE66BKGQyNsJjARjUkE4Th8U-zrnZFBvGq1rZQ4P-3RKtOtSQyjON4jzMb7VLAZDw4YXKerTxy17m9OyypKqYMQ-lER4vyUO1_zHKkH7btizM3jxppOrQe0bFJmw8-b4wqogeIXlIL85fcMBWhQJ2jeNuQLOxPZHtt5kuk5hNS8uHKxHVErryFz9EVcty52_co8Gl6Nu2PU05mcK4r3ig8LGeE1cA' --header 'api-access-token: JHV2ZTg62UeQGRqL0rl72Q==' 'https://api-frontend2.dev.efitness.pl/api/clubs/43/members/memberships/1/freeze'

Installment defreeze

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'member-token: bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1laWQiOiIyODQzMTUiLCJzdWIiOiIyODQzMTUgICAgICIsImp0aSI6IjZhZDI5ZmRjLTk2MWUtNGQ5OS1iZDA1LTE1NDAxYjI0MjQ0MCIsImlhdCI6MTU4MjczMDY3NiwiaWQiOiIyODQzMTUiLCJuYmYiOjE1ODI3MzA2NzUsImV4cCI6MTU4MjczNzg3NSwiaXNzIjoiYXBpRnJvbnRlbmQiLCJhdWQiOiJodHRwczovL2FwaS1mcm9udGVuZDIuZWZpdG5lc3MuY29tLnBsIn0.X1UZVzqh4F1sea_htkBYfMFWB9wi4qI4QRRxOsVJNl0bkoUHDk5xZDSkMY9WPtQau27esYvEiG76CUMOEk4sutcQ0A_sLfzVcBznD8ZG8aXYJTuF-A2ZeskcMQE66BKGQyNsJjARjUkE4Th8U-zrnZFBvGq1rZQ4P-3RKtOtSQyjON4jzMb7VLAZDw4YXKerTxy17m9OyypKqYMQ-lER4vyUO1_zHKkH7btizM3jxppOrQe0bFJmw8-b4wqogeIXlIL85fcMBWhQJ2jeNuQLOxPZHtt5kuk5hNS8uHKxHVErryFz9EVcty52_co8Gl6Nu2PU05mcK4r3ig8LGeE1cA' --header 'api-access-token: JHV2ZTg62UeQGRqL0rl72Q==' -d '{ \  
   "defreezeInstallmentsIds": [1]] \ 
 }' 'http://api-frontend-2.dev.efitness.pl/api/clubs/43/members/memberships/1/defreeze-installments'

HTTP Status Codes

Error Code Meaning
400 Bad Request -- Your request is invalid.
401 Unauthorized -- Your API key is wrong.
403 Forbidden -- The requested resource is hidden for administrators only.
404 Not Found -- The specified resource could not be found.
422 Unprocessable Entity -- syntax of the request entity is correct, but it was unable to process the contained instructions
429 Too Many Requests -- You're requesting too many resources! Slow down!
500 Internal Server Error -- We had a problem with our server. Try again later.
503 Service Unavailable -- We're temporarily offline for maintenance. Please try again later.

Internal Error Codes

Common

Error Code Meaning
1.0 Unexpected error
1.1 The request's model is empty or contains incorrect elements
1.2 'offset' argument contains characters that are not a number or number <= 0
1.3 'limit' argument contains characters that are not a number or number <= 0
1.4 'sortBy' argument has an incorrect format which does not meet 'key1:asc,key2:desc,key3:asc' format
1.5 A user with the user token provided could not have been found
1.6 sortBy' parameter does not exist in the model's response
1.7 sortBy' parameter contains duplicated parameters
1.8 At least one of the provided 'sortBy' parameters cannot be used for sorting
1.9 The difference between the date ranges exceeded the specified range
1.10 The value exceeds the available range
1.11 The user has not been found
1.12 The resource has not been found
1.13 Date range is invalid
1.14 Invalid data
1.15 A member with provided ID could not have been found
1.16 External service exception occured
1.17 Invalid data
1.18 Club settings invalid
1.19 The resource already exist
1.20 The field is required

Auth

Error Code Meaning
2.0 Unexpected error
2.1 Invalid login or password
2.2 Login not defined
2.3 Password not defined
2.4 The specified password is not a valid password literal
2.5 The 'header' provided contains invalid login source
2.6 member-token' is invalid
2.7 api-access-token' is invalid
2.8 refresh-token' is invalid
2.9 Club associated with the IDs provided could not have been found
2.10 A member associated with provided ID could not have been found
2.11 The 'header' provided does not consist a member's token
2.12 The 'header' provided does not consist a club's token
2.13 user-token' is invalid
2.14 The user associated with the ID provided was not found
2.15 The request's header does not consist a 'user-token'
2.16 Unauthorized access, required permissions missing
2.17 Facebook token invalid
2.18 Facebook token is empty
2.19 Could not connect to API Facebook
2.20 Google token invalid
2.21 Google token is empty
2.22 Could not connect to API Google
2.23 Apple token is empty
2.24 Could not connect to API Apple
2.25 Apple token invalid

MembershipDefinition

Error Code Meaning
3.0 Unexpected error
3.1 A membership definition with provided ID could not have been found

Member

Error Code Meaning
4.0 Unexpected error
4.1 A member with provided ID could not have been found
4.2 A club with provided ID could not have been found
4.3 The field is required
4.4 Invalid data
4.5 Invalid format
4.6 Field not unique
4.7 Provided e-mail addresses are different
4.8 Update member error
4.9 Data cannot be edited
4.10 E-mail address cannot be confirmed
4.11 Authorization token couldn't have been found
4.12 Contact data couldn't have been modified
4.13 IBAN number is invalid
4.14 BIC number corresponding to the IBAN number provided is invalid
4.15 IBAN's API authorization error
4.16 Bank name corresponding to the IBAN number provided is invalid
4.17 E-mail domain is invalid
4.18 User application ID not found
4.19 The card has already been assigned
4.20 The user already has a temporary card assigned
4.21 The user does not have a temporary card assigned
4.22 A member consent with the ID provided could not have been found
4.23 Invalid token provided
4.24 Invalid password
4.25 Mobile application with given name does not exist
4.26 Member has already registered PUSH details for this mobile application
4.27 Already checked
4.28 Cannot uncheck required consent
4.29 The e-mail address cannot be updated before confirming the previous one
4.30 There is more than one member linked with this card number!
4.31 Member consents are not editable from Member Zone
4.32 Required external system is currently unavailable
4.33 User does not exist in access control

Membership

Error Code Meaning
5.0 Unexpected error
5.1 A membership with provided ID could not have been found
5.2 A membership definition with provided ID could not have been found
5.3 The request's model is empty or contains incorrect elements
5.4 The membership is not active
5.5 Membership is no longer available
5.6 This member has already used his Free Pass
5.7 Please select the required consents
5.8 This membership is for people of a certain age range
5.9 The membership cannot start sooner than today
5.10 Membership cannot start later than the membership definition starting date
5.11 Membership cannot start earlier than the membership definition ending date
5.12 The membership is not pending
5.13 The club is unable to add pending memberships
5.14 The membership has already been paid
5.15 The membership cannot be cancelled because it is subject to dunning procedure
5.16 Unable to cancel membership because membership has been paid
5.17 The membership cannot be cancelled, because it has already been cancelled
5.18 The membership cannot be cancelled, because it has been already renunciated
5.19 The membership cannot be cancelled, because it has been suspended indefinetely
5.21 The membership has not been signed
5.22 The field is required
5.23 OK System validation error
5.24 The user does not have sufficient permissions to perform this operation
5.25 Legal guardian does not exist
5.26 Your discount coupon is invalid or has already been used
5.27 Both values cannot be provided at the same time
5.28 The resource has not been found
5.29 Membership has no automatic renewal option available
5.30 Membership definition not from chain
5.31 The membership has already been renunciated
5.32 A member with provided ID could not have been found
5.33 Discount code cannot be used
5.35 Discount code has not been found
5.36 Given code has expired
5.37 Given code has already been used
5.38 Given code is not available for this membership
5.39 Given code isn't available yet
5.40 Given code isn't available in current club
5.41 The cession cannot be performed because the contract is frozen
5.42 The cession cannot be performed because the contract is suspended
5.43 Promotion not found
5.44 Promotion cannot be added to membership
5.45 The promotion associated with the promo code provided is not yet available
5.46 The club member can only accept the membership in the 'pending' status
5.47 The membership should be accepted by employee due to of club settings
5.48 Due to the club settings, the membership may be accepted after paying for the current installment

OuterSystems

Error Code Meaning
6.0 The resource has not been found
6.1 The value exceeds the available range
6.2 External service exception occured
6.3 Club settings invalid
6.4 The maximum time to cancel has been exceeded

Renunciate

Error Code Meaning
7.0 Success (not possible to get)
7.1 Membership renunciation is not available
7.2 Membership not found
7.3 Invalid reason
7.4 Invalid date
7.5 Membership has already been renunciated
7.6 Invalid member
7.7 Membership not renunciated
7.8 Another membership exists in the same time
7.9 Failed to renunciate membership
7.10 Credit card charging was not possible
7.11 Definite time membership has no renunciation before end parameters
7.12 Required installments not passed
7.13 Invalid payment form
7.14 Started transaction already exist, wait for it to end before charging the card again
7.15 Membership with arrear installment
7.16 Cancel renunciate error
7.17 The field is required
7.18 The membership's renewal cancellation has already been issued
7.19 The membership's renewal cancellation has not been issued
7.20 The membership's renewal cancellation is not permitted
7.21 The membership's renewal is not permitted
7.22 Membership is frozen
7.23 Can't renunciate membership with single installment
7.24 Membership renunciation not available in member zone
7.25 Can't renunciate membership that's not paid for

CreditCard

Error Code Meaning
9.0 Error occured during provider's initialization process of payment
9.1 Error occured during creation of payment order
9.2 Invalid payment gateway's operator
9.3 No installments or fees to be paid
9.4 The credit card provided already exists in the system
9.5 The payment could not have been processed right now
9.6 The credit card could not have been found
9.7 Invalid configuration
9.8 Started transaction already exist, wait for it to end before charging the card again
9.9 The credit card cannot be charged, please contact the bank for more information.
9.10 Only one type of transaction can be performed at the same time, for example membership payment, wallet top-up, classes fees
9.11 The transaction must be made using one of the available types, for example membership payment, wallet top-up, classes fee
9.12 Wallet top-up value is invalid
9.13 Wallet service is not available
9.14 A class reservation with provided ID could not have been found
9.15 The class cannot be paid for, the PayAsYouGo service might be disabled or its value has not been defined
9.16 The class has already been paid for
9.17 The field is required
9.18 Invalid data

ClassReservation

Error Code Meaning
10.0 Classes with provided IDs have not been found
10.1 Registration general error
10.2 Member is already registered for the class
10.3 Return member position on waiting list
10.4 Signing up for classes has been blocked because of an individual block
10.5 It's not possible to book this class type earlier than certain number of minutes before the start of classes
10.6 Internet reservations are not available
10.7 In-club class registration not possible
10.8 This membership does not allow to book this class
10.9 These classes require having a dedicated membership
10.10 The class has already ended
10.11 Registration for past class is not allowed
10.12 No free places left
10.13 No free spots left but can sign up for the waiting list
10.14 It's not possible to book this class type earlier than a certain number of hours before the start of classes
10.15 Discount code has not been found
10.16 Discount code cannot be used, because the club has an option "IS_PAY_AS_YOU_GO_ON" disabled
10.17 Discount code cannot be used
10.18 Discount code's number of uses has been used up
10.19 Discount code has expired
10.20 Choose specific class, please
10.21 Subservice with identification number provided is not available
10.22 Class booking possible after debt is cleared
10.23 Booking of group classes is not possible if the membership is frozen
10.24 Registration for the course is not possible
10.25 Member is already registered for the class
10.26 The registration can not be completed because at the same time exists another classes
10.27 No active membership on the profile
10.28 Number of allowable reservations exceeded
10.29 Membership definition does not allow for registration on this day
10.30 Membership definition does not allow for registration on this period/those periods
10.31 Registration unsuccessful (member has used the class already)
10.32 It's not possible to book this class type earlier than hour before the start of classes
10.33 It's not possible to book this class type earlier than one hour before the start of classes
10.34 It's not possible to book this class type earlier than certain number of hours before the start of classes
10.35 It's not possible to book this class type earlier than certain number of hours before the start of classes
10.36 For this class member can register only on the class day
10.37 It's not possible to book this class type earlier than certain number of hours before the start of classes
10.38 It's not possible to book this class type earlier than certain number of hours before the start of classes
10.39 Registering a prospect member for classes that require a deposit is not possible
10.40 The classes require a deposit and status of member's wallet is too low to make this reservation
10.41 Not enough free time to register
10.42 There are no free places for this class
10.43 Preliminary class registration but confirmation requires payment - pay if you haven't already
10.44 The discount code can only be used by a logged-in user
10.45 Error occured during the attempt of adding a new member, class registration failed
10.46 The option to book classes has been blocked by the Club
10.47 Classes has already substitute as service

Prospect

Error Code Meaning
11.0 The field is required
11.1 Invalid data
11.2 Invalid format
11.3 Field is not unique
11.4 E-mail domain is invalid
11.5 Recommending person does not exist
11.6 The resource has not been found
11.7 Prospect has no status
11.8 The current status cannot be changed
11.9 Status is not intended for a prospect

Document

Error Code Meaning
12.0 Member with provided ID does not exist in this club
12.1 The document with provided ID has not been found
12.2 Information about the file has been found, but the file could not have been found in the data warehouse
12.3 An unidentified error occurred, please check the configuration
12.4 The field is required
12.5 Invalid data
12.6 Extension missing in the 'fileName' field

ChangePassword

Error Code Meaning
14.1 Fill all the required fields
14.2 Passwords must be the same
14.3 The new password is too long
14.4 Incorrect old password
14.5 The new password is not valid
14.6 Password change authorization token could not have been found
14.7 The token has expired
14.8 Member assigned to the token could not have been found
14.9 User with the given e-mail address could not be found
14.10 Invalid data
14.11 The given e-mail address is assigned to multiple members

Freeze

Error Code Meaning
15.1 Try again later
15.2 Before you can freeze membership, first you must settle the outstanding payments
15.3 Freeze duration exceeds allowed maximum
15.4 Freeze starting date must not be contained within the current installment's range
15.5 Freeze starting date must exceed the agreement's starting date
15.6 Freeze starting date must not be in the past
15.7 Amount of possible freezes or the maximum freezing period has been used, or the membership is ending soon
15.8 An error occurred while modifing the membership
15.9 The freezing cannot be cancelled, because it has already been paid for
15.10 The installment has already been paid for
15.11 The last installment has been paid for
15.12 Freezed membership cannot be restored
15.13 Current installment not found
15.14 A membership with provided ID could not have been found
15.15 The field is required
15.16 Invalid data
15.17 Number of days provided is invalid, the value is to be at least 1
15.18 The membership is currently frozen
15.19 The membership already has future freezing installments paid
15.20 The membership is indefinite
15.21 The membership cannot be frozen, because it ends before the date provided
15.22 Invalid selected installments
15.23 The membership has been frozen automatically, to unfreeze, please settle your arrears
15.24 Unable to cancel freezing, because future installments are already paid
15.25 Unable to cancel the current installment’s freezing because frozen future installments are present
15.26 The number of possible freezes has been exceeded or the membership is ending soon
15.27 There was a problem with the last installment
15.28 Membership type not supported
15.29 The membership's renewal cancellation has already been issued
15.30 Only one billing period can be selected at the same time
15.31 Changes cannot be implemented, because the last billing period must not remain frozen
15.32 Frozen installments exist in the renewed membership
15.33 Freezing cannot be implemented, because of overlapping memberships
15.34 Membership is already frozen in selected timespan
15.35 The membership does not have any installments which can be freezing discounted
15.36 Installment in selected time span is already frozen
15.37 Freeze already started
15.38 The membership cannot be frozen, because it ends before the date provided
15.39 Freezed membership cannot be restored
15.40 New freezing end date is before freeze start
15.41 Freezes are disabled in member zone
15.42 Freezing of the membership cannot be revoked, because funds have already been withdrawn

MembershipService

Error Code Meaning
16.0 Credit / debit card has not been registered
16.1 Credit / debit card could not be charged with the service fee
16.2 This service has already been added to the membership
16.3 Choose the service form the service's list
16.4 A membership with provided ID could not have been found
16.5 Select at least one service
16.6 A service with provided ID is unavailable with this membership
16.7 The membership does not have a service with the ID provided
16.8 The service has been deleted
16.9 The service cannot be deleted
16.10 No services
16.11 Credit card not valid, it might be an unauthorized or marked by the bank as lost, restricted or stolen
16.12 Started transaction already exist, wait for it to end before charging the card again

RemoveClassReservation

Error Code Meaning
17.0 Cannot unregister the member from this class, because the member is not registered for it
17.1 Reservation cancellation is not allowed for this type of classes
17.2 Reservation cancellation is not allowed in this club
17.3 The class can not be deleted, because it was settled
17.4 The option of class resignation has been blocked by the Club
17.5 The class can not be deleted, because it has already started
17.6 Available time for class resignation has expired
17.7 The class can not be deleted, because it was payed or payment is in progress

MembershipShift

Error Code Meaning
19.0 Error
19.1 A membership with provided ID could not have been found
19.2 Membership suspended
19.3 Settings do not allow for shifting memberships
19.4 Membership is currently frozen
19.5 Another membership exists in the same time
19.6 Invalid data

Payment

Error Code Meaning
21.0 Required payment
21.1 The transaction must be made using one of the available types, for example membership payment, wallet top-up, classes fee
21.2 The resource has not been found
21.3 Invalid data
21.4 The class cannot be paid for, the PayAsYouGo service might be disabled or its value has not been defined
21.5 The class has already been paid for
21.6 Wallet service is not available
21.7 Error occured during provider's initialization process of payment
21.8 Transaction for provided member not exist
21.9 Payment form with provided id not exist
21.10 Transaction cannot be set as paid
21.11 Incorrect payment provider, please contact customer support
21.12 Transaction cannot be set as unpaid
21.13 Gift is already paid for

CrmTask

Error Code Meaning
22.0 A member with provided ID could not have been found
22.1 The field is required
22.2 Invalid data
22.3 Crm has been disabled
22.4 User has no add blocking note permission
22.5 The method has not been implemented
22.6 Task has been already closed
22.7 Task not found

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

2022-06-13

Added

2022-06-13

Added

2022-04-21

Changed

2022-04-07

Added

2021/08/30

Added

METHODS

Api Frontend v2

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Base URLs:

Club

GET clubs

Code samples

GET https://api-frontend2.efitness.com.pl/api/clubs HTTP/1.1
Host: api-frontend2.efitness.com.pl
Accept: application/json
client-request-id: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

GET /api/clubs

Obtaining information about clubs

Parameters

Name In Type Required Description
chainId query integer(int32) false Chain identifier
clubName query string false Club name
memberLatitude query number(double) false Member latitude
memberLongitude query number(double) false Member longitude
searchRadius query integer(int32) false Clubs search radius in meters
searchText query string false Clubs search text
mobileClubName query string false Mobile club name
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "description": "Club name",
            "type": "string"
          },
          "street": {
            "description": "Club street",
            "type": "string"
          },
          "postalCode": {
            "description": "Club postal code",
            "type": "string"
          },
          "city": {
            "description": "Club city",
            "type": "string"
          },
          "phoneNumber": {
            "description": "Club phone number",
            "type": "string"
          },
          "headquarterPhoneNumber": {
            "description": "Headquarter phone number",
            "type": "string"
          },
          "faxNumber": {
            "description": "Club fax number",
            "type": "string"
          },
          "email": {
            "description": "Club email",
            "type": "string"
          },
          "companyName": {
            "description": "Company name",
            "type": "string"
          },
          "companyStreet": {
            "description": "Company street",
            "type": "string"
          },
          "companyPostalCode": {
            "description": "Company postal code",
            "type": "string"
          },
          "companyCity": {
            "description": "Company city",
            "type": "string"
          },
          "companyPhoneNumber": {
            "description": "Company phone number",
            "type": "string"
          },
          "companyFaxNumber": {
            "description": "Company fax number",
            "type": "string"
          },
          "companyEmail": {
            "description": "Company email",
            "type": "string"
          },
          "chainId": {
            "format": "int32",
            "description": "Chain Id",
            "type": "integer"
          },
          "clubId": {
            "format": "int32",
            "description": "Club Id",
            "type": "integer"
          },
          "currency": {
            "description": "Club currency",
            "type": "string"
          },
          "currencyCode": {
            "description": "Club currency code",
            "type": "string"
          },
          "mobileClubName": {
            "description": "Mobile club name",
            "type": "string"
          },
          "mobileClubDescription": {
            "description": "Mobile club description",
            "type": "string"
          },
          "mobileClubOpeningHours": {
            "description": "Mobile club opening hours",
            "type": "string"
          },
          "mobileClubBackgroundPhoto": {
            "description": "Mobile club background photo",
            "type": "string"
          },
          "mobileClubLogo": {
            "description": "Mobile club logo",
            "type": "string"
          },
          "mobileClubUrl": {
            "description": "Mobile application url",
            "type": "string"
          },
          "mobileClubApplications": {
            "description": "Mobile club applications",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "mobileClubStyle": {
            "type": "object",
            "properties": {
              "primaryColor": {
                "description": "Primary color of an app (in HEX)",
                "type": "string"
              },
              "secondaryColor": {
                "description": "Secondary color of an app (in HEX)",
                "type": "string"
              }
            }
          },
          "isQrCodeOn": {
            "description": "Whether generation of QR codes to the card number is enabled",
            "type": "boolean"
          },
          "feedbackMail": {
            "description": "Address for sending messages and opinions about the club",
            "type": "string"
          },
          "isVersionZero": {
            "description": "Determines whether club has free subscription",
            "type": "boolean"
          }
        }
      }
    },
    "totalCount": {
      "format": "int32",
      "type": "integer"
    },
    "next": {
      "type": "string"
    },
    "previous": {
      "type": "string"
    }
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<CollectionResponse_ClubResponse_>
  <type>object</type>
  <properties>
    <results>
      <type>array</type>
      <items>
        <type>object</type>
        <properties>
          <name>
            <description>Club name</description>
            <type>string</type>
          </name>
          <street>
            <description>Club street</description>
            <type>string</type>
          </street>
          <postalCode>
            <description>Club postal code</description>
            <type>string</type>
          </postalCode>
          <city>
            <description>Club city</description>
            <type>string</type>
          </city>
          <phoneNumber>
            <description>Club phone number</description>
            <type>string</type>
          </phoneNumber>
          <headquarterPhoneNumber>
            <description>Headquarter phone number</description>
            <type>string</type>
          </headquarterPhoneNumber>
          <faxNumber>
            <description>Club fax number</description>
            <type>string</type>
          </faxNumber>
          <email>
            <description>Club email</description>
            <type>string</type>
          </email>
          <companyName>
            <description>Company name</description>
            <type>string</type>
          </companyName>
          <companyStreet>
            <description>Company street</description>
            <type>string</type>
          </companyStreet>
          <companyPostalCode>
            <description>Company postal code</description>
            <type>string</type>
          </companyPostalCode>
          <companyCity>
            <description>Company city</description>
            <type>string</type>
          </companyCity>
          <companyPhoneNumber>
            <description>Company phone number</description>
            <type>string</type>
          </companyPhoneNumber>
          <companyFaxNumber>
            <description>Company fax number</description>
            <type>string</type>
          </companyFaxNumber>
          <companyEmail>
            <description>Company email</description>
            <type>string</type>
          </companyEmail>
          <chainId>
            <format>int32</format>
            <description>Chain Id</description>
            <type>integer</type>
          </chainId>
          <clubId>
            <format>int32</format>
            <description>Club Id</description>
            <type>integer</type>
          </clubId>
          <currency>
            <description>Club currency</description>
            <type>string</type>
          </currency>
          <currencyCode>
            <description>Club currency code</description>
            <type>string</type>
          </currencyCode>
          <mobileClubName>
            <description>Mobile club name</description>
            <type>string</type>
          </mobileClubName>
          <mobileClubDescription>
            <description>Mobile club description</description>
            <type>string</type>
          </mobileClubDescription>
          <mobileClubOpeningHours>
            <description>Mobile club opening hours</description>
            <type>string</type>
          </mobileClubOpeningHours>
          <mobileClubBackgroundPhoto>
            <description>Mobile club background photo</description>
            <type>string</type>
          </mobileClubBackgroundPhoto>
          <mobileClubLogo>
            <description>Mobile club logo</description>
            <type>string</type>
          </mobileClubLogo>
          <mobileClubUrl>
            <description>Mobile application url</description>
            <type>string</type>
          </mobileClubUrl>
          <mobileClubApplications>
            <description>Mobile club applications</description>
            <type>array</type>
            <items>
              <type>string</type>
            </items>
          </mobileClubApplications>
          <mobileClubStyle>
            <type>object</type>
            <properties>
              <primaryColor>
                <description>Primary color of an app (in HEX)</description>
                <type>string</type>
              </primaryColor>
              <secondaryColor>
                <description>Secondary color of an app (in HEX)</description>
                <type>string</type>
              </secondaryColor>
            </properties>
          </mobileClubStyle>
          <isQrCodeOn>
            <description>Whether generation of QR codes to the card number is enabled</description>
            <type>boolean</type>
          </isQrCodeOn>
          <feedbackMail>
            <description>Address for sending messages and opinions about the club</description>
            <type>string</type>
          </feedbackMail>
          <isVersionZero>
            <description>Determines whether club has free subscription</description>
            <type>boolean</type>
          </isVersionZero>
        </properties>
      </items>
    </results>
    <totalCount>
      <format>int32</format>
      <type>integer</type>
    </totalCount>
    <next>
      <type>string</type>
    </next>
    <previous>
      <type>string</type>
    </previous>
  </properties>
</CollectionResponse_ClubResponse_>

Responses

Status Meaning Description Schema
200 OK OK CollectionResponse_ClubResponse_
422 Unprocessable Entity 422 ErrorResponse_ECommonResponseCode_

GET club

Code samples

GET https://api-frontend2.efitness.com.pl/api/clubs/{clubId} HTTP/1.1
Host: api-frontend2.efitness.com.pl
Accept: application/json
client-request-id: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

GET /api/clubs/{clubId}

Get club by id

Parameters

Name In Type Required Description
clubId path string true none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "name": {
      "description": "Club name",
      "type": "string"
    },
    "street": {
      "description": "Club street",
      "type": "string"
    },
    "postalCode": {
      "description": "Club postal code",
      "type": "string"
    },
    "city": {
      "description": "Club city",
      "type": "string"
    },
    "phoneNumber": {
      "description": "Club phone number",
      "type": "string"
    },
    "headquarterPhoneNumber": {
      "description": "Headquarter phone number",
      "type": "string"
    },
    "faxNumber": {
      "description": "Club fax number",
      "type": "string"
    },
    "email": {
      "description": "Club email",
      "type": "string"
    },
    "companyName": {
      "description": "Company name",
      "type": "string"
    },
    "companyStreet": {
      "description": "Company street",
      "type": "string"
    },
    "companyPostalCode": {
      "description": "Company postal code",
      "type": "string"
    },
    "companyCity": {
      "description": "Company city",
      "type": "string"
    },
    "companyPhoneNumber": {
      "description": "Company phone number",
      "type": "string"
    },
    "companyFaxNumber": {
      "description": "Company fax number",
      "type": "string"
    },
    "companyEmail": {
      "description": "Company email",
      "type": "string"
    },
    "chainId": {
      "format": "int32",
      "description": "Chain Id",
      "type": "integer"
    },
    "clubId": {
      "format": "int32",
      "description": "Club Id",
      "type": "integer"
    },
    "currency": {
      "description": "Club currency",
      "type": "string"
    },
    "currencyCode": {
      "description": "Club currency code",
      "type": "string"
    },
    "mobileClubName": {
      "description": "Mobile club name",
      "type": "string"
    },
    "mobileClubDescription": {
      "description": "Mobile club description",
      "type": "string"
    },
    "mobileClubOpeningHours": {
      "description": "Mobile club opening hours",
      "type": "string"
    },
    "mobileClubBackgroundPhoto": {
      "description": "Mobile club background photo",
      "type": "string"
    },
    "mobileClubLogo": {
      "description": "Mobile club logo",
      "type": "string"
    },
    "mobileClubUrl": {
      "description": "Mobile application url",
      "type": "string"
    },
    "mobileClubApplications": {
      "description": "Mobile club applications",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "mobileClubStyle": {
      "type": "object",
      "properties": {
        "primaryColor": {
          "description": "Primary color of an app (in HEX)",
          "type": "string"
        },
        "secondaryColor": {
          "description": "Secondary color of an app (in HEX)",
          "type": "string"
        }
      }
    },
    "isQrCodeOn": {
      "description": "Whether generation of QR codes to the card number is enabled",
      "type": "boolean"
    },
    "feedbackMail": {
      "description": "Address for sending messages and opinions about the club",
      "type": "string"
    },
    "isVersionZero": {
      "description": "Determines whether club has free subscription",
      "type": "boolean"
    }
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<ClubResponse>
  <type>object</type>
  <properties>
    <name>
      <description>Club name</description>
      <type>string</type>
    </name>
    <street>
      <description>Club street</description>
      <type>string</type>
    </street>
    <postalCode>
      <description>Club postal code</description>
      <type>string</type>
    </postalCode>
    <city>
      <description>Club city</description>
      <type>string</type>
    </city>
    <phoneNumber>
      <description>Club phone number</description>
      <type>string</type>
    </phoneNumber>
    <headquarterPhoneNumber>
      <description>Headquarter phone number</description>
      <type>string</type>
    </headquarterPhoneNumber>
    <faxNumber>
      <description>Club fax number</description>
      <type>string</type>
    </faxNumber>
    <email>
      <description>Club email</description>
      <type>string</type>
    </email>
    <companyName>
      <description>Company name</description>
      <type>string</type>
    </companyName>
    <companyStreet>
      <description>Company street</description>
      <type>string</type>
    </companyStreet>
    <companyPostalCode>
      <description>Company postal code</description>
      <type>string</type>
    </companyPostalCode>
    <companyCity>
      <description>Company city</description>
      <type>string</type>
    </companyCity>
    <companyPhoneNumber>
      <description>Company phone number</description>
      <type>string</type>
    </companyPhoneNumber>
    <companyFaxNumber>
      <description>Company fax number</description>
      <type>string</type>
    </companyFaxNumber>
    <companyEmail>
      <description>Company email</description>
      <type>string</type>
    </companyEmail>
    <chainId>
      <format>int32</format>
      <description>Chain Id</description>
      <type>integer</type>
    </chainId>
    <clubId>
      <format>int32</format>
      <description>Club Id</description>
      <type>integer</type>
    </clubId>
    <currency>
      <description>Club currency</description>
      <type>string</type>
    </currency>
    <currencyCode>
      <description>Club currency code</description>
      <type>string</type>
    </currencyCode>
    <mobileClubName>
      <description>Mobile club name</description>
      <type>string</type>
    </mobileClubName>
    <mobileClubDescription>
      <description>Mobile club description</description>
      <type>string</type>
    </mobileClubDescription>
    <mobileClubOpeningHours>
      <description>Mobile club opening hours</description>
      <type>string</type>
    </mobileClubOpeningHours>
    <mobileClubBackgroundPhoto>
      <description>Mobile club background photo</description>
      <type>string</type>
    </mobileClubBackgroundPhoto>
    <mobileClubLogo>
      <description>Mobile club logo</description>
      <type>string</type>
    </mobileClubLogo>
    <mobileClubUrl>
      <description>Mobile application url</description>
      <type>string</type>
    </mobileClubUrl>
    <mobileClubApplications>
      <description>Mobile club applications</description>
      <type>array</type>
      <items>
        <type>string</type>
      </items>
    </mobileClubApplications>
    <mobileClubStyle>
      <type>object</type>
      <properties>
        <primaryColor>
          <description>Primary color of an app (in HEX)</description>
          <type>string</type>
        </primaryColor>
        <secondaryColor>
          <description>Secondary color of an app (in HEX)</description>
          <type>string</type>
        </secondaryColor>
      </properties>
    </mobileClubStyle>
    <isQrCodeOn>
      <description>Whether generation of QR codes to the card number is enabled</description>
      <type>boolean</type>
    </isQrCodeOn>
    <feedbackMail>
      <description>Address for sending messages and opinions about the club</description>
      <type>string</type>
    </feedbackMail>
    <isVersionZero>
      <description>Determines whether club has free subscription</description>
      <type>boolean</type>
    </isVersionZero>
  </properties>
</ClubResponse>

Responses

Status Meaning Description Schema
200 OK OK ClubResponse
422 Unprocessable Entity 422 ErrorResponse_ECommonResponseCode_

POST contact-us

Code samples

POST https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/contact-us HTTP/1.1
Host: api-frontend2.efitness.com.pl
Content-Type: application/json
Accept: application/json
client-request-id: [object Object]
member-token: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

POST /api/clubs/{clubId}/contact-us

Sends an email to the club

Body parameter

{
  "required": [
    "subject",
    "body"
  ],
  "type": "object",
  "properties": {
    "subject": {
      "description": "Email subject",
      "type": "string"
    },
    "body": {
      "description": "Email body",
      "type": "string"
    }
  }
}

required:
  - subject
  - body
type: object
properties:
  subject:
    description: Email subject
    type: string
  body:
    description: Email body
    type: string


<?xml version="1.0" encoding="UTF-8" ?>
<ContactUsRequest>
  <required>subject</required>
  <required>body</required>
  <type>object</type>
  <properties>
    <subject>
      <description>Email subject</description>
      <type>string</type>
    </subject>
    <body>
      <description>Email body</description>
      <type>string</type>
    </body>
  </properties>
</ContactUsRequest>

Parameters

Name In Type Required Description
clubId path string true none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
member-token header string true Token used to authorize a club member.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.
body body ContactUsRequest true none

Example responses

422 Response

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "responseCode": {
            "type": "string",
            "readOnly": true
          },
          "message": {
            "type": "string"
          },
          "path": {
            "type": "string"
          }
        }
      }
    }
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<ErrorResponse_ECommonResponseCode_>
  <type>object</type>
  <properties>
    <errors>
      <type>array</type>
      <items>
        <type>object</type>
        <properties>
          <responseCode>
            <type>string</type>
            <readOnly>true</readOnly>
          </responseCode>
          <message>
            <type>string</type>
          </message>
          <path>
            <type>string</type>
          </path>
        </properties>
      </items>
    </errors>
  </properties>
</ErrorResponse_ECommonResponseCode_>

Responses

Status Meaning Description Schema
200 OK Email has been added successfully None
422 Unprocessable Entity 422 ErrorResponse_ECommonResponseCode_

GET members inside club

Code samples

GET https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/members-inside-club HTTP/1.1
Host: api-frontend2.efitness.com.pl
Accept: application/json
client-request-id: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

GET /api/clubs/{clubId}/members-inside-club

Obtaining information about members currently in club

Parameters

Name In Type Required Description
clubId path string true none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "membersInsideClub": {
            "format": "int32",
            "description": "Number of members inside club",
            "type": "integer"
          },
          "limit": {
            "format": "int32",
            "description": "Maximum number of members allowed to stay inside the club",
            "type": "integer"
          }
        }
      }
    },
    "totalCount": {
      "format": "int32",
      "type": "integer"
    },
    "next": {
      "type": "string"
    },
    "previous": {
      "type": "string"
    }
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<CollectionResponse_MembersInsideClubResponse_>
  <type>object</type>
  <properties>
    <results>
      <type>array</type>
      <items>
        <type>object</type>
        <properties>
          <membersInsideClub>
            <format>int32</format>
            <description>Number of members inside club</description>
            <type>integer</type>
          </membersInsideClub>
          <limit>
            <format>int32</format>
            <description>Maximum number of members allowed to stay inside the club</description>
            <type>integer</type>
          </limit>
        </properties>
      </items>
    </results>
    <totalCount>
      <format>int32</format>
      <type>integer</type>
    </totalCount>
    <next>
      <type>string</type>
    </next>
    <previous>
      <type>string</type>
    </previous>
  </properties>
</CollectionResponse_MembersInsideClubResponse_>

Responses

Status Meaning Description Schema
200 OK OK CollectionResponse_MembersInsideClubResponse_
422 Unprocessable Entity 422 ErrorResponse_ECommonResponseCode_

GET club member sources

Code samples

GET https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/member-sources HTTP/1.1
Host: api-frontend2.efitness.com.pl
Accept: application/json
client-request-id: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

GET /api/clubs/{clubId}/member-sources

Obtaining information about member sources assigned to a club

Parameters

Name In Type Required Description
clubId path string true none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "format": "int32",
            "description": "Club member source id",
            "type": "integer"
          },
          "name": {
            "description": "Club member source name",
            "type": "string"
          }
        }
      }
    },
    "totalCount": {
      "format": "int32",
      "type": "integer"
    },
    "next": {
      "type": "string"
    },
    "previous": {
      "type": "string"
    }
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<CollectionResponse_ClubMemberSourceResponse_>
  <type>object</type>
  <properties>
    <results>
      <type>array</type>
      <items>
        <type>object</type>
        <properties>
          <id>
            <format>int32</format>
            <description>Club member source id</description>
            <type>integer</type>
          </id>
          <name>
            <description>Club member source name</description>
            <type>string</type>
          </name>
        </properties>
      </items>
    </results>
    <totalCount>
      <format>int32</format>
      <type>integer</type>
    </totalCount>
    <next>
      <type>string</type>
    </next>
    <previous>
      <type>string</type>
    </previous>
  </properties>
</CollectionResponse_ClubMemberSourceResponse_>

Responses

Status Meaning Description Schema
200 OK OK CollectionResponse_ClubMemberSourceResponse_
422 Unprocessable Entity 422 ErrorResponse_ECommonResponseCode_

Configuration

GET member-area

Code samples

GET https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/configuration/member-area HTTP/1.1
Host: api-frontend2.efitness.com.pl
Accept: application/json
client-request-id: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

GET /api/clubs/{clubId}/configuration/member-area

Get a list of member area settings

Parameters

Name In Type Required Description
clubId path string true none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "description": "Name of the setting",
            "type": "string"
          },
          "displayName": {
            "description": "Localized name of the member area field",
            "type": "string"
          },
          "isOn": {
            "description": "Determines whether the setting is on",
            "type": "boolean"
          },
          "value": {
            "description": "Setting value, if setting is different than on/off",
            "type": "string"
          },
          "endpointNames": {
            "description": "Endpoint names where setting is used",
            "type": "array",
            "items": {
              "type": "string"
            },
            "readOnly": true
          }
        }
      }
    },
    "totalCount": {
      "format": "int32",
      "type": "integer"
    },
    "next": {
      "type": "string"
    },
    "previous": {
      "type": "string"
    }
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<CollectionResponse_MemberProfileSettingsResponse_>
  <type>object</type>
  <properties>
    <results>
      <type>array</type>
      <items>
        <type>object</type>
        <properties>
          <name>
            <description>Name of the setting</description>
            <type>string</type>
          </name>
          <displayName>
            <description>Localized name of the member area field</description>
            <type>string</type>
          </displayName>
          <isOn>
            <description>Determines whether the setting is on</description>
            <type>boolean</type>
          </isOn>
          <value>
            <description>Setting value, if setting is different than on/off</description>
            <type>string</type>
          </value>
          <endpointNames>
            <description>Endpoint names where setting is used</description>
            <type>array</type>
            <items>
              <type>string</type>
            </items>
            <readOnly>true</readOnly>
          </endpointNames>
        </properties>
      </items>
    </results>
    <totalCount>
      <format>int32</format>
      <type>integer</type>
    </totalCount>
    <next>
      <type>string</type>
    </next>
    <previous>
      <type>string</type>
    </previous>
  </properties>
</CollectionResponse_MemberProfileSettingsResponse_>

Responses

Status Meaning Description Schema
200 OK OK CollectionResponse_MemberProfileSettingsResponse_
422 Unprocessable Entity 422 ErrorResponse_ECommonResponseCode_

GET registration-fields

Code samples

GET https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/configuration/registration-fields HTTP/1.1
Host: api-frontend2.efitness.com.pl
Accept: application/json
client-request-id: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

GET /api/clubs/{clubId}/configuration/registration-fields

Get a list of registration form fields and informations about whether they are required or not

Parameters

Name In Type Required Description
clubId path string true none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "description": "Name of the registration form field",
            "type": "string"
          },
          "displayName": {
            "description": "Localized name of the registration form field",
            "type": "string"
          },
          "isAvailable": {
            "description": "Determines whether the field is available in registration form",
            "type": "boolean"
          },
          "isRequired": {
            "description": "Determines whether the field is required to register member",
            "type": "boolean"
          }
        }
      }
    },
    "totalCount": {
      "format": "int32",
      "type": "integer"
    },
    "next": {
      "type": "string"
    },
    "previous": {
      "type": "string"
    }
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<CollectionResponse_RegistrationFormFieldResponse_>
  <type>object</type>
  <properties>
    <results>
      <type>array</type>
      <items>
        <type>object</type>
        <properties>
          <name>
            <description>Name of the registration form field</description>
            <type>string</type>
          </name>
          <displayName>
            <description>Localized name of the registration form field</description>
            <type>string</type>
          </displayName>
          <isAvailable>
            <description>Determines whether the field is available in registration form</description>
            <type>boolean</type>
          </isAvailable>
          <isRequired>
            <description>Determines whether the field is required to register member</description>
            <type>boolean</type>
          </isRequired>
        </properties>
      </items>
    </results>
    <totalCount>
      <format>int32</format>
      <type>integer</type>
    </totalCount>
    <next>
      <type>string</type>
    </next>
    <previous>
      <type>string</type>
    </previous>
  </properties>
</CollectionResponse_RegistrationFormFieldResponse_>

Responses

Status Meaning Description Schema
200 OK OK CollectionResponse_RegistrationFormFieldResponse_
422 Unprocessable Entity 422 ErrorResponse_ECommonResponseCode_

Gift

POST gift

Code samples

POST https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/gifts HTTP/1.1
Host: api-frontend2.efitness.com.pl
Content-Type: application/json
Accept: application/json
client-request-id: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

POST /api/clubs/{clubId}/gifts

Add gift

Body parameter

{
  "required": [
    "giftDefinitionID",
    "firstName",
    "lastName",
    "email",
    "cellPhone"
  ],
  "type": "object",
  "properties": {
    "giftDefinitionID": {
      "format": "int32",
      "description": "Selected gift definition for created gift",
      "type": "integer"
    },
    "firstName": {
      "description": "Firstname of member receiving a gift",
      "type": "string"
    },
    "lastName": {
      "description": "Lastname of member receiving a gift",
      "type": "string"
    },
    "email": {
      "description": "Email of member receiving a gift",
      "type": "string"
    },
    "cellPhone": {
      "description": "Cell phone number",
      "type": "string"
    },
    "countryPhoneCode": {
      "description": "Country cell phone code",
      "type": "string"
    },
    "street": {
      "description": "Street of residence",
      "type": "string"
    },
    "flatNumber": {
      "description": "Flat number of residence",
      "type": "string"
    },
    "postalCode": {
      "description": "Postal code of residence",
      "type": "string"
    },
    "city": {
      "description": "City of residence",
      "type": "string"
    },
    "hasInvoice": {
      "description": "Should invoice data be used",
      "type": "boolean"
    },
    "companyInvoiceData": {
      "type": "object",
      "properties": {
        "CompanyName": {
          "type": "string"
        },
        "CompanyCity": {
          "type": "string"
        },
        "CompanyCounty": {
          "type": "string"
        },
        "CompanyPostalCode": {
          "type": "string"
        },
        "CompanyStreet": {
          "type": "string"
        },
        "CompanyStreetAdditionalInfo": {
          "type": "string"
        },
        "CompanyTaxIdentificationNumber": {
          "type": "string"
        }
      }
    }
  }
}

required:
  - giftDefinitionID
  - firstName
  - lastName
  - email
  - cellPhone
type: object
properties:
  giftDefinitionID:
    format: int32
    description: Selected gift definition for created gift
    type: integer
  firstName:
    description: Firstname of member receiving a gift
    type: string
  lastName:
    description: Lastname of member receiving a gift
    type: string
  email:
    description: Email of member receiving a gift
    type: string
  cellPhone:
    description: Cell phone number
    type: string
  countryPhoneCode:
    description: Country cell phone code
    type: string
  street:
    description: Street of residence
    type: string
  flatNumber:
    description: Flat number of residence
    type: string
  postalCode:
    description: Postal code of residence
    type: string
  city:
    description: City of residence
    type: string
  hasInvoice:
    description: Should invoice data be used
    type: boolean
  companyInvoiceData:
    type: object
    properties:
      CompanyName:
        type: string
      CompanyCity:
        type: string
      CompanyCounty:
        type: string
      CompanyPostalCode:
        type: string
      CompanyStreet:
        type: string
      CompanyStreetAdditionalInfo:
        type: string
      CompanyTaxIdentificationNumber:
        type: string


<?xml version="1.0" encoding="UTF-8" ?>
<AddGiftRequest>
  <required>giftDefinitionID</required>
  <required>firstName</required>
  <required>lastName</required>
  <required>email</required>
  <required>cellPhone</required>
  <type>object</type>
  <properties>
    <giftDefinitionID>
      <format>int32</format>
      <description>Selected gift definition for created gift</description>
      <type>integer</type>
    </giftDefinitionID>
    <firstName>
      <description>Firstname of member receiving a gift</description>
      <type>string</type>
    </firstName>
    <lastName>
      <description>Lastname of member receiving a gift</description>
      <type>string</type>
    </lastName>
    <email>
      <description>Email of member receiving a gift</description>
      <type>string</type>
    </email>
    <cellPhone>
      <description>Cell phone number</description>
      <type>string</type>
    </cellPhone>
    <countryPhoneCode>
      <description>Country cell phone code</description>
      <type>string</type>
    </countryPhoneCode>
    <street>
      <description>Street of residence</description>
      <type>string</type>
    </street>
    <flatNumber>
      <description>Flat number of residence</description>
      <type>string</type>
    </flatNumber>
    <postalCode>
      <description>Postal code of residence</description>
      <type>string</type>
    </postalCode>
    <city>
      <description>City of residence</description>
      <type>string</type>
    </city>
    <hasInvoice>
      <description>Should invoice data be used</description>
      <type>boolean</type>
    </hasInvoice>
    <companyInvoiceData>
      <type>object</type>
      <properties>
        <CompanyName>
          <type>string</type>
        </CompanyName>
        <CompanyCity>
          <type>string</type>
        </CompanyCity>
        <CompanyCounty>
          <type>string</type>
        </CompanyCounty>
        <CompanyPostalCode>
          <type>string</type>
        </CompanyPostalCode>
        <CompanyStreet>
          <type>string</type>
        </CompanyStreet>
        <CompanyStreetAdditionalInfo>
          <type>string</type>
        </CompanyStreetAdditionalInfo>
        <CompanyTaxIdentificationNumber>
          <type>string</type>
        </CompanyTaxIdentificationNumber>
      </properties>
    </companyInvoiceData>
  </properties>
</AddGiftRequest>

Parameters

Name In Type Required Description
clubId path string true none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.
body body AddGiftRequest true Model request

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "giftId": {
      "format": "int32",
      "description": "Id of added gift",
      "type": "integer"
    }
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<AddGiftResponse>
  <type>object</type>
  <properties>
    <giftId>
      <format>int32</format>
      <description>Id of added gift</description>
      <type>integer</type>
    </giftId>
  </properties>
</AddGiftResponse>

Responses

Status Meaning Description Schema
200 OK Promo added successfully AddGiftResponse
422 Unprocessable Entity Model validation error ErrorResponse_ECommonResponseCode_

POST payment

Code samples

POST https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/gifts/{giftId}/payment HTTP/1.1
Host: api-frontend2.efitness.com.pl
Content-Type: application/json
Accept: application/json
client-request-id: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

POST /api/clubs/{clubId}/gifts/{giftId}/payment

Pay for a gift

Body parameter

{
  "type": "object",
  "properties": {
    "returnUrl": {
      "description": "Redirect url after payment passed",
      "type": "string"
    }
  }
}

type: object
properties:
  returnUrl:
    description: Redirect url after payment passed
    type: string


<?xml version="1.0" encoding="UTF-8" ?>
<GiftPaymentRequest>
  <type>object</type>
  <properties>
    <returnUrl>
      <description>Redirect url after payment passed</description>
      <type>string</type>
    </returnUrl>
  </properties>
</GiftPaymentRequest>

Parameters

Name In Type Required Description
giftId path integer(int32) true Gift ID
clubId path string true none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.
body body GiftPaymentRequest true Model request

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "redirectUrl": {
      "description": "Provider based redirect url",
      "type": "string"
    }
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<OnlinePaymentResponse>
  <type>object</type>
  <properties>
    <redirectUrl>
      <description>Provider based redirect url</description>
      <type>string</type>
    </redirectUrl>
  </properties>
</OnlinePaymentResponse>

Responses

Status Meaning Description Schema
200 OK Gift payment order created OnlinePaymentResponse
422 Unprocessable Entity Model validation error ErrorResponse_EPaymentResponseCode_

GET gift-definitions

Code samples

GET https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/gifts/definitions HTTP/1.1
Host: api-frontend2.efitness.com.pl
Accept: application/json
client-request-id: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

GET /api/clubs/{clubId}/gifts/definitions

Get gift definitions

Parameters

Name In Type Required Description
clubId path string true none
limit query integer(int32) false none
offset query integer(int32) false none
sortBy query string false none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "format": "int32",
            "description": "Gift definition id",
            "type": "integer"
          },
          "price": {
            "format": "double",
            "description": "Gift definition price",
            "type": "number"
          },
          "name": {
            "description": "Gift definition name",
            "type": "string"
          },
          "vat": {
            "format": "double",
            "description": "Gift definition vat",
            "type": "number"
          },
          "dateFrom": {
            "format": "date-time",
            "description": "Gift date from",
            "type": "string"
          },
          "dateTo": {
            "format": "date-time",
            "description": "Gift date to",
            "type": "string"
          }
        }
      }
    },
    "totalCount": {
      "format": "int32",
      "type": "integer"
    },
    "next": {
      "type": "string"
    },
    "previous": {
      "type": "string"
    }
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<CollectionResponse_GiftDefinitionResponse_>
  <type>object</type>
  <properties>
    <results>
      <type>array</type>
      <items>
        <type>object</type>
        <properties>
          <id>
            <format>int32</format>
            <description>Gift definition id</description>
            <type>integer</type>
          </id>
          <price>
            <format>double</format>
            <description>Gift definition price</description>
            <type>number</type>
          </price>
          <name>
            <description>Gift definition name</description>
            <type>string</type>
          </name>
          <vat>
            <format>double</format>
            <description>Gift definition vat</description>
            <type>number</type>
          </vat>
          <dateFrom>
            <format>date-time</format>
            <description>Gift date from</description>
            <type>string</type>
          </dateFrom>
          <dateTo>
            <format>date-time</format>
            <description>Gift date to</description>
            <type>string</type>
          </dateTo>
        </properties>
      </items>
    </results>
    <totalCount>
      <format>int32</format>
      <type>integer</type>
    </totalCount>
    <next>
      <type>string</type>
    </next>
    <previous>
      <type>string</type>
    </previous>
  </properties>
</CollectionResponse_GiftDefinitionResponse_>

Responses

Status Meaning Description Schema
200 OK Promos returned successfully CollectionResponse_GiftDefinitionResponse_
422 Unprocessable Entity An error occured ErrorResponse_ECommonResponseCode_

Member

GET member

Code samples

GET https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/members HTTP/1.1
Host: api-frontend2.efitness.com.pl
Accept: application/json
client-request-id: [object Object]
member-token: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

GET /api/clubs/{clubId}/members

Get logged member personal data

Parameters

Name In Type Required Description
clubId path string true none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
member-token header string true Token used to authorize a club member.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "memberId": {
      "format": "int32",
      "description": "Member identifier",
      "type": "integer"
    },
    "firstName": {
      "description": "Firstname of new member",
      "type": "string"
    },
    "lastName": {
      "description": "Lastname of new member",
      "type": "string"
    },
    "personalIdentityNumber": {
      "description": "Personal Identity Number",
      "type": "string"
    },
    "email": {
      "description": "Email of new member",
      "type": "string"
    },
    "street": {
      "description": "Street of residence",
      "type": "string"
    },
    "streetAdditionalInfo": {
      "description": "Street additional info of residence",
      "type": "string"
    },
    "flatNumber": {
      "description": "Flat number of residence",
      "type": "string"
    },
    "postalCode": {
      "description": "Postal code of residence",
      "type": "string"
    },
    "city": {
      "description": "City of residence",
      "type": "string"
    },
    "county": {
      "description": "County of residence",
      "type": "string"
    },
    "carRegistrationNumber": {
      "description": "Car registration number",
      "type": "string"
    },
    "cellPhone": {
      "description": "Cell phone number",
      "type": "string"
    },
    "countryPhoneCode": {
      "description": "Country cell phone code",
      "type": "string"
    },
    "identityDocumentType": {
      "format": "int32",
      "description": "Name of the document confirming member identity: <br />  0 - ID<br />  1 - Passport<br />  2 - DriversLicense<br />  3 - RefugeePermit<br />  4 - ResidencePermit",
      "type": "integer"
    },
    "identityDocumentNumber": {
      "description": "Number of the document confirming member identity",
      "type": "string"
    },
    "gender": {
      "format": "int32",
      "description": "Gender: <br />  0 - woman<br />  1 - man<br />  2 - other",
      "type": "integer"
    },
    "birthday": {
      "format": "date-time",
      "description": "Birthday date (yyyy-MM-dd HH:mm:ss)",
      "type": "string"
    },
    "birthPlace": {
      "description": "Birth place",
      "type": "string"
    },
    "bankName": {
      "description": "Name of the bank supporting the payment",
      "type": "string"
    },
    "iban": {
      "description": "International bank account number IBAN",
      "type": "string"
    },
    "bic": {
      "description": "International code identifying the financial institution BIC",
      "type": "string"
    },
    "bankAccountOwnerName": {
      "description": "Bank account owner name",
      "type": "string"
    },
    "accountOwner": {
      "description": "Bank account owner",
      "type": "string"
    },
    "taxIdentificationNumber": {
      "description": "Tax number",
      "type": "string"
    },
    "countryOfResidence": {
      "description": "Country of residence: <br />  AF - Afghanistan<br />  AL - Albania<br />  DZ - Algeria<br />  AD - Andorra<br />  AO - Angola<br />  AI - Anguilla<br />  AQ - Antarctica<br />  AG - AntiguaAndBarbuda<br />  SA - SaudiArabia<br />  AR - Argentina<br />  AM - Armenia<br />  AW - Aruba<br />  AU - Australia<br />  AT - Austria<br />  AZ - Azerbaijan<br />  BS - Bahamas<br />  BH - Bahrain<br />  BD - Bangladesh<br />  BB - Barbados<br />  BE - Belgium<br />  BZ - Belize<br />  BJ - Benin<br />  BM - Bermuda<br />  BT - Bhutan<br />  BY - Belarus<br />  BO - Bolivia<br />  BQ - Bonaire<br />  BA - BosniaAndHerzegovina<br />  BW - Botswana<br />  BR - Brazil<br />  BN - BruneiDarussalam<br />  IO - BritishIndianOceanTerritory<br />  VG - VirginIslands<br />  BG - Bulgaria<br />  BF - BurkinaFaso<br />  BI - Burundi<br />  CL - Chile<br />  CN - China<br />  HR - Croatia<br />  CW - Curacao<br />  CY - Cyprus<br />  TD - Chad<br />  ME - Montenegro<br />  CZ - CzechRepublic<br />  UM - UnitedStatesMinorOutlyingIslands<br />  DK - Denmark<br />  CD - CongoDemocraticRepublic<br />  DM - Dominica<br />  DO - DominicanRepublic<br />  DJ - Djibouti<br />  EG - Egypt<br />  EC - Ecuador<br />  ER - Eritrea<br />  EE - Estonia<br />  ET - Ethiopia<br />  FK - FalklandIslands<br />  FJ - Fiji<br />  PH - Philippines<br />  FI - Finland<br />  FR - France<br />  TF - FrenchSouthernTerritories<br />  GA - Gabon<br />  GM - Gambia<br />  GS - SouthGeorgiaAndSouthSandwichIslands<br />  GH - Ghana<br />  GI - Gibraltar<br />  GR - Greece<br />  GD - Grenada<br />  GL - Greenland<br />  GE - Georgia<br />  GU - Guam<br />  GG - Guernsey<br />  GF - FrenchGuiana<br />  GY - Guyana<br />  GP - Guadeloupe<br />  GT - Guatemala<br />  GW - GuineaBissau<br />  GQ - EquatorialGuinea<br />  GN - Guinea<br />  HT - Haiti<br />  ES - Spain<br />  NL - Netherlands<br />  HN - Honduras<br />  HK - HongKong<br />  IN - India<br />  ID - Indonesia<br />  IQ - Iraq<br />  IR - Iran<br />  IE - Ireland<br />  IS - Iceland<br />  IL - Israel<br />  JM - Jamaica<br />  JP - Japan<br />  YE - Yemen<br />  JE - Jersey<br />  JO - Jordan<br />  KY - CaymanIslands<br />  KH - Cambodia<br />  CM - Cameroon<br />  CA - Canada<br />  QA - Qatar<br />  KZ - Kazakhstan<br />  KE - Kenya<br />  KG - Kyrgyzstan<br />  KI - Kiribati<br />  CO - Colombia<br />  KM - Comoros<br />  CG - Congo<br />  KR - SouthKorea<br />  KP - NorthKorea<br />  CR - CostaRica<br />  CU - Cuba<br />  KW - Kuwait<br />  LA - Laos<br />  LS - Lesotho<br />  LB - Lebanon<br />  LR - Liberia<br />  LY - Libya<br />  LI - Liechtenstein<br />  LT - Lithuania<br />  LU - Luxembourg<br />  LV - Latvia<br />  MK - Macedonia<br />  MG - Madagascar<br />  YT - Mayotte<br />  MO - Macao<br />  MW - Malawi<br />  MV - Maldives<br />  MY - Malaysia<br />  ML - Mali<br />  MT - Malta<br />  MP - NorthernMarianaIslands<br />  MA - Morocco<br />  MQ - Martinique<br />  MR - Mauritania<br />  MU - Mauritius<br />  MX - Mexico<br />  FM - Micronesia<br />  MM - Myanmar<br />  MD - Moldova<br />  MC - Monaco<br />  MN - Mongolia<br />  MS - Montserrat<br />  MZ - Mozambique<br />  NA - Namibia<br />  NR - Nauru<br />  NP - Nepal<br />  DE - Germany<br />  NE - Niger<br />  NG - Nigeria<br />  NI - Nicaragua<br />  NU - Niue<br />  NF - NorfolkIsland<br />  NO - Norway<br />  NC - NewCaledonia<br />  NZ - NewZealand<br />  OM - Oman<br />  PK - Pakistan<br />  PW - Palau<br />  PS - Palestine<br />  PA - Panama<br />  PG - PapuaNewGuinea<br />  PY - Paraguay<br />  PE - Peru<br />  PN - Pitcairn<br />  PF - FrenchPolynesia<br />  PL - Poland<br />  PR - PuertoRico<br />  PT - Portugal<br />  ZA - SouthAfrica<br />  CF - CentralAfricanRepublic<br />  CV - CapeVerde<br />  RE - Reunion<br />  RU - Russia<br />  RO - Romania<br />  RW - Rwanda<br />  EH - WesternSahara<br />  KN - SaintKittsAndNevis<br />  LC - SaintLucia<br />  VC - SaintVincentAndGrenadines<br />  BL - SaintBarthelemy<br />  MF - SaintMartin<br />  PM - SaintPierreAndMiquelon<br />  SV - ElSalvador<br />  AS - AmericanSamoa<br />  WS - Samoa<br />  SM - SanMarino<br />  SN - Senegal<br />  RS - Serbia<br />  SC - Seychelles<br />  SL - SierraLeone<br />  SG - Singapore<br />  SX - SintMaarten<br />  SK - Slovakia<br />  SI - Slovenia<br />  SO - Somalia<br />  LK - SriLanka<br />  US - UnitedStates<br />  SZ - Swaziland<br />  SD - Sudan<br />  SS - SouthSudan<br />  SR - Suriname<br />  SJ - SvalbardAndJanMayen<br />  SY - Syria<br />  CH - Switzerland<br />  SE - Sweden<br />  TJ - Tajikistan<br />  TH - Thailand<br />  TW - Taiwan<br />  TZ - Tanzania<br />  TL - Timor<br />  TG - Togo<br />  TK - Tokelau<br />  TO - Tonga<br />  TT - TrinidadAndTobago<br />  TN - Tunisia<br />  TR - Turkey<br />  TM - Turkmenistan<br />  TC - TurksAndCaicosIslands<br />  TV - Tuvalu<br />  UG - Uganda<br />  UA - Ukraine<br />  UY - Uruguay<br />  UZ - Uzbekistan<br />  VU - Vanuatu<br />  WF - WallisAndFutuna<br />  VA - HolySee<br />  VE - Venezuela<br />  HU - Hungary<br />  GB - UnitedKingdom<br />  VN - VietNam<br />  IT - Italy<br />  CI - IvoryCoast<br />  BV - BouvetIsland<br />  CX - ChristmasIsland<br />  IM - IsleOfMan<br />  SH - SaintHelenaAscensionTristanCunha<br />  AX - AlandIslands<br />  CK - CookIslands<br />  VI - VirginIslandsUS<br />  HM - HeardAndMcDonaldIslands<br />  CC - CocosIslands<br />  MH - MarshallIslands<br />  FO - FaroeIslands<br />  SB - SolomonIslands<br />  ST - SaoTomeAndPrincipe<br />  ZM - Zambia<br />  ZW - Zimbabwe<br />  AE - UnitedArabEmirates",
      "type": "string"
    },
    "companyInvoiceData": {
      "type": "object",
      "properties": {
        "companyName": {
          "description": "Company name",
          "type": "string"
        },
        "companyCity": {
          "description": "City of company residence",
          "type": "string"
        },
        "companyCounty": {
          "description": "County of company residence",
          "type": "string"
        },
        "companyPostalCode": {
          "description": "Postal code of company residence",
          "type": "string"
        },
        "companyStreet": {
          "description": "Street of company residence",
          "type": "string"
        },
        "companyStreetAdditionalInfo": {
          "description": "Street additional info of company residence",
          "type": "string"
        },
        "companyTaxIdentificationNumber": {
          "description": "Company tax identification number",
          "type": "string"
        },
        "companyRemarks": {
          "description": "Company remarks",
          "type": "string"
        }
      }
    },
    "personalPhoto": {
      "description": "Personal photo (made by member) - base64 string format",
      "type": "string"
    },
    "isEmailVerified": {
      "description": "Determines whether email address was verified",
      "type": "boolean"
    },
    "cardNumber": {
      "description": "Member card number",
      "type": "string"
    },
    "pin": {
      "description": "Member PIN number",
      "type": "string"
    },
    "isVindicated": {
      "description": "Specifies whether the member has active vindication",
      "type": "boolean"
    },
    "memberStatus": {
      "format": "int32",
      "description": "Status of member: <br />  0 - ProspectNew<br />  1 - ProspectHot<br />  2 - ProspectWarm<br />  3 - ProspectCold<br />  4 - ProspectLost<br />  5 - ActivePre<br />  6 - ActiveFree<br />  7 - ActiveZero<br />  8 - ActiveOK<br />  9 - ActiveFreez<br />  10 - ActiveDebt<br />  11 - ExNew<br />  12 - ExHot<br />  13 - ExWarm<br />  14 - ExCold<br />  15 - Partner<br />  16 - ActiveNew<br />  17 - ActiveExNew<br />  18 - ExDebt<br />  19 - Employee<br />  20 - NoStatus",
      "type": "integer"
    },
    "walletBalance": {
      "format": "double",
      "description": "Member current wallet balance",
      "type": "number"
    },
    "hasCreditCard": {
      "description": "Determines whether member has credit card",
      "type": "boolean"
    }
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<MemberResponse>
  <type>object</type>
  <properties>
    <memberId>
      <format>int32</format>
      <description>Member identifier</description>
      <type>integer</type>
    </memberId>
    <firstName>
      <description>Firstname of new member</description>
      <type>string</type>
    </firstName>
    <lastName>
      <description>Lastname of new member</description>
      <type>string</type>
    </lastName>
    <personalIdentityNumber>
      <description>Personal Identity Number</description>
      <type>string</type>
    </personalIdentityNumber>
    <email>
      <description>Email of new member</description>
      <type>string</type>
    </email>
    <street>
      <description>Street of residence</description>
      <type>string</type>
    </street>
    <streetAdditionalInfo>
      <description>Street additional info of residence</description>
      <type>string</type>
    </streetAdditionalInfo>
    <flatNumber>
      <description>Flat number of residence</description>
      <type>string</type>
    </flatNumber>
    <postalCode>
      <description>Postal code of residence</description>
      <type>string</type>
    </postalCode>
    <city>
      <description>City of residence</description>
      <type>string</type>
    </city>
    <county>
      <description>County of residence</description>
      <type>string</type>
    </county>
    <carRegistrationNumber>
      <description>Car registration number</description>
      <type>string</type>
    </carRegistrationNumber>
    <cellPhone>
      <description>Cell phone number</description>
      <type>string</type>
    </cellPhone>
    <countryPhoneCode>
      <description>Country cell phone code</description>
      <type>string</type>
    </countryPhoneCode>
    <identityDocumentType>
      <format>int32</format>
      <description>Name of the document confirming member identity: <br>&nbsp;&nbsp;0 - ID<br>&nbsp;&nbsp;1 - Passport<br>&nbsp;&nbsp;2 - DriversLicense<br>&nbsp;&nbsp;3 - RefugeePermit<br>&nbsp;&nbsp;4 - ResidencePermit</description>
      <type>integer</type>
    </identityDocumentType>
    <identityDocumentNumber>
      <description>Number of the document confirming member identity</description>
      <type>string</type>
    </identityDocumentNumber>
    <gender>
      <format>int32</format>
      <description>Gender: <br>&nbsp;&nbsp;0 - woman<br>&nbsp;&nbsp;1 - man<br>&nbsp;&nbsp;2 - other</description>
      <type>integer</type>
    </gender>
    <birthday>
      <format>date-time</format>
      <description>Birthday date (yyyy-MM-dd HH:mm:ss)</description>
      <type>string</type>
    </birthday>
    <birthPlace>
      <description>Birth place</description>
      <type>string</type>
    </birthPlace>
    <bankName>
      <description>Name of the bank supporting the payment</description>
      <type>string</type>
    </bankName>
    <iban>
      <description>International bank account number IBAN</description>
      <type>string</type>
    </iban>
    <bic>
      <description>International code identifying the financial institution BIC</description>
      <type>string</type>
    </bic>
    <bankAccountOwnerName>
      <description>Bank account owner name</description>
      <type>string</type>
    </bankAccountOwnerName>
    <accountOwner>
      <description>Bank account owner</description>
      <type>string</type>
    </accountOwner>
    <taxIdentificationNumber>
      <description>Tax number</description>
      <type>string</type>
    </taxIdentificationNumber>
    <countryOfResidence>
      <description>Country of residence: <br>&nbsp;&nbsp;AF - Afghanistan<br>&nbsp;&nbsp;AL - Albania<br>&nbsp;&nbsp;DZ - Algeria<br>&nbsp;&nbsp;AD - Andorra<br>&nbsp;&nbsp;AO - Angola<br>&nbsp;&nbsp;AI - Anguilla<br>&nbsp;&nbsp;AQ - Antarctica<br>&nbsp;&nbsp;AG - AntiguaAndBarbuda<br>&nbsp;&nbsp;SA - SaudiArabia<br>&nbsp;&nbsp;AR - Argentina<br>&nbsp;&nbsp;AM - Armenia<br>&nbsp;&nbsp;AW - Aruba<br>&nbsp;&nbsp;AU - Australia<br>&nbsp;&nbsp;AT - Austria<br>&nbsp;&nbsp;AZ - Azerbaijan<br>&nbsp;&nbsp;BS - Bahamas<br>&nbsp;&nbsp;BH - Bahrain<br>&nbsp;&nbsp;BD - Bangladesh<br>&nbsp;&nbsp;BB - Barbados<br>&nbsp;&nbsp;BE - Belgium<br>&nbsp;&nbsp;BZ - Belize<br>&nbsp;&nbsp;BJ - Benin<br>&nbsp;&nbsp;BM - Bermuda<br>&nbsp;&nbsp;BT - Bhutan<br>&nbsp;&nbsp;BY - Belarus<br>&nbsp;&nbsp;BO - Bolivia<br>&nbsp;&nbsp;BQ - Bonaire<br>&nbsp;&nbsp;BA - BosniaAndHerzegovina<br>&nbsp;&nbsp;BW - Botswana<br>&nbsp;&nbsp;BR - Brazil<br>&nbsp;&nbsp;BN - BruneiDarussalam<br>&nbsp;&nbsp;IO - BritishIndianOceanTerritory<br>&nbsp;&nbsp;VG - VirginIslands<br>&nbsp;&nbsp;BG - Bulgaria<br>&nbsp;&nbsp;BF - BurkinaFaso<br>&nbsp;&nbsp;BI - Burundi<br>&nbsp;&nbsp;CL - Chile<br>&nbsp;&nbsp;CN - China<br>&nbsp;&nbsp;HR - Croatia<br>&nbsp;&nbsp;CW - Curacao<br>&nbsp;&nbsp;CY - Cyprus<br>&nbsp;&nbsp;TD - Chad<br>&nbsp;&nbsp;ME - Montenegro<br>&nbsp;&nbsp;CZ - CzechRepublic<br>&nbsp;&nbsp;UM - UnitedStatesMinorOutlyingIslands<br>&nbsp;&nbsp;DK - Denmark<br>&nbsp;&nbsp;CD - CongoDemocraticRepublic<br>&nbsp;&nbsp;DM - Dominica<br>&nbsp;&nbsp;DO - DominicanRepublic<br>&nbsp;&nbsp;DJ - Djibouti<br>&nbsp;&nbsp;EG - Egypt<br>&nbsp;&nbsp;EC - Ecuador<br>&nbsp;&nbsp;ER - Eritrea<br>&nbsp;&nbsp;EE - Estonia<br>&nbsp;&nbsp;ET - Ethiopia<br>&nbsp;&nbsp;FK - FalklandIslands<br>&nbsp;&nbsp;FJ - Fiji<br>&nbsp;&nbsp;PH - Philippines<br>&nbsp;&nbsp;FI - Finland<br>&nbsp;&nbsp;FR - France<br>&nbsp;&nbsp;TF - FrenchSouthernTerritories<br>&nbsp;&nbsp;GA - Gabon<br>&nbsp;&nbsp;GM - Gambia<br>&nbsp;&nbsp;GS - SouthGeorgiaAndSouthSandwichIslands<br>&nbsp;&nbsp;GH - Ghana<br>&nbsp;&nbsp;GI - Gibraltar<br>&nbsp;&nbsp;GR - Greece<br>&nbsp;&nbsp;GD - Grenada<br>&nbsp;&nbsp;GL - Greenland<br>&nbsp;&nbsp;GE - Georgia<br>&nbsp;&nbsp;GU - Guam<br>&nbsp;&nbsp;GG - Guernsey<br>&nbsp;&nbsp;GF - FrenchGuiana<br>&nbsp;&nbsp;GY - Guyana<br>&nbsp;&nbsp;GP - Guadeloupe<br>&nbsp;&nbsp;GT - Guatemala<br>&nbsp;&nbsp;GW - GuineaBissau<br>&nbsp;&nbsp;GQ - EquatorialGuinea<br>&nbsp;&nbsp;GN - Guinea<br>&nbsp;&nbsp;HT - Haiti<br>&nbsp;&nbsp;ES - Spain<br>&nbsp;&nbsp;NL - Netherlands<br>&nbsp;&nbsp;HN - Honduras<br>&nbsp;&nbsp;HK - HongKong<br>&nbsp;&nbsp;IN - India<br>&nbsp;&nbsp;ID - Indonesia<br>&nbsp;&nbsp;IQ - Iraq<br>&nbsp;&nbsp;IR - Iran<br>&nbsp;&nbsp;IE - Ireland<br>&nbsp;&nbsp;IS - Iceland<br>&nbsp;&nbsp;IL - Israel<br>&nbsp;&nbsp;JM - Jamaica<br>&nbsp;&nbsp;JP - Japan<br>&nbsp;&nbsp;YE - Yemen<br>&nbsp;&nbsp;JE - Jersey<br>&nbsp;&nbsp;JO - Jordan<br>&nbsp;&nbsp;KY - CaymanIslands<br>&nbsp;&nbsp;KH - Cambodia<br>&nbsp;&nbsp;CM - Cameroon<br>&nbsp;&nbsp;CA - Canada<br>&nbsp;&nbsp;QA - Qatar<br>&nbsp;&nbsp;KZ - Kazakhstan<br>&nbsp;&nbsp;KE - Kenya<br>&nbsp;&nbsp;KG - Kyrgyzstan<br>&nbsp;&nbsp;KI - Kiribati<br>&nbsp;&nbsp;CO - Colombia<br>&nbsp;&nbsp;KM - Comoros<br>&nbsp;&nbsp;CG - Congo<br>&nbsp;&nbsp;KR - SouthKorea<br>&nbsp;&nbsp;KP - NorthKorea<br>&nbsp;&nbsp;CR - CostaRica<br>&nbsp;&nbsp;CU - Cuba<br>&nbsp;&nbsp;KW - Kuwait<br>&nbsp;&nbsp;LA - Laos<br>&nbsp;&nbsp;LS - Lesotho<br>&nbsp;&nbsp;LB - Lebanon<br>&nbsp;&nbsp;LR - Liberia<br>&nbsp;&nbsp;LY - Libya<br>&nbsp;&nbsp;LI - Liechtenstein<br>&nbsp;&nbsp;LT - Lithuania<br>&nbsp;&nbsp;LU - Luxembourg<br>&nbsp;&nbsp;LV - Latvia<br>&nbsp;&nbsp;MK - Macedonia<br>&nbsp;&nbsp;MG - Madagascar<br>&nbsp;&nbsp;YT - Mayotte<br>&nbsp;&nbsp;MO - Macao<br>&nbsp;&nbsp;MW - Malawi<br>&nbsp;&nbsp;MV - Maldives<br>&nbsp;&nbsp;MY - Malaysia<br>&nbsp;&nbsp;ML - Mali<br>&nbsp;&nbsp;MT - Malta<br>&nbsp;&nbsp;MP - NorthernMarianaIslands<br>&nbsp;&nbsp;MA - Morocco<br>&nbsp;&nbsp;MQ - Martinique<br>&nbsp;&nbsp;MR - Mauritania<br>&nbsp;&nbsp;MU - Mauritius<br>&nbsp;&nbsp;MX - Mexico<br>&nbsp;&nbsp;FM - Micronesia<br>&nbsp;&nbsp;MM - Myanmar<br>&nbsp;&nbsp;MD - Moldova<br>&nbsp;&nbsp;MC - Monaco<br>&nbsp;&nbsp;MN - Mongolia<br>&nbsp;&nbsp;MS - Montserrat<br>&nbsp;&nbsp;MZ - Mozambique<br>&nbsp;&nbsp;NA - Namibia<br>&nbsp;&nbsp;NR - Nauru<br>&nbsp;&nbsp;NP - Nepal<br>&nbsp;&nbsp;DE - Germany<br>&nbsp;&nbsp;NE - Niger<br>&nbsp;&nbsp;NG - Nigeria<br>&nbsp;&nbsp;NI - Nicaragua<br>&nbsp;&nbsp;NU - Niue<br>&nbsp;&nbsp;NF - NorfolkIsland<br>&nbsp;&nbsp;NO - Norway<br>&nbsp;&nbsp;NC - NewCaledonia<br>&nbsp;&nbsp;NZ - NewZealand<br>&nbsp;&nbsp;OM - Oman<br>&nbsp;&nbsp;PK - Pakistan<br>&nbsp;&nbsp;PW - Palau<br>&nbsp;&nbsp;PS - Palestine<br>&nbsp;&nbsp;PA - Panama<br>&nbsp;&nbsp;PG - PapuaNewGuinea<br>&nbsp;&nbsp;PY - Paraguay<br>&nbsp;&nbsp;PE - Peru<br>&nbsp;&nbsp;PN - Pitcairn<br>&nbsp;&nbsp;PF - FrenchPolynesia<br>&nbsp;&nbsp;PL - Poland<br>&nbsp;&nbsp;PR - PuertoRico<br>&nbsp;&nbsp;PT - Portugal<br>&nbsp;&nbsp;ZA - SouthAfrica<br>&nbsp;&nbsp;CF - CentralAfricanRepublic<br>&nbsp;&nbsp;CV - CapeVerde<br>&nbsp;&nbsp;RE - Reunion<br>&nbsp;&nbsp;RU - Russia<br>&nbsp;&nbsp;RO - Romania<br>&nbsp;&nbsp;RW - Rwanda<br>&nbsp;&nbsp;EH - WesternSahara<br>&nbsp;&nbsp;KN - SaintKittsAndNevis<br>&nbsp;&nbsp;LC - SaintLucia<br>&nbsp;&nbsp;VC - SaintVincentAndGrenadines<br>&nbsp;&nbsp;BL - SaintBarthelemy<br>&nbsp;&nbsp;MF - SaintMartin<br>&nbsp;&nbsp;PM - SaintPierreAndMiquelon<br>&nbsp;&nbsp;SV - ElSalvador<br>&nbsp;&nbsp;AS - AmericanSamoa<br>&nbsp;&nbsp;WS - Samoa<br>&nbsp;&nbsp;SM - SanMarino<br>&nbsp;&nbsp;SN - Senegal<br>&nbsp;&nbsp;RS - Serbia<br>&nbsp;&nbsp;SC - Seychelles<br>&nbsp;&nbsp;SL - SierraLeone<br>&nbsp;&nbsp;SG - Singapore<br>&nbsp;&nbsp;SX - SintMaarten<br>&nbsp;&nbsp;SK - Slovakia<br>&nbsp;&nbsp;SI - Slovenia<br>&nbsp;&nbsp;SO - Somalia<br>&nbsp;&nbsp;LK - SriLanka<br>&nbsp;&nbsp;US - UnitedStates<br>&nbsp;&nbsp;SZ - Swaziland<br>&nbsp;&nbsp;SD - Sudan<br>&nbsp;&nbsp;SS - SouthSudan<br>&nbsp;&nbsp;SR - Suriname<br>&nbsp;&nbsp;SJ - SvalbardAndJanMayen<br>&nbsp;&nbsp;SY - Syria<br>&nbsp;&nbsp;CH - Switzerland<br>&nbsp;&nbsp;SE - Sweden<br>&nbsp;&nbsp;TJ - Tajikistan<br>&nbsp;&nbsp;TH - Thailand<br>&nbsp;&nbsp;TW - Taiwan<br>&nbsp;&nbsp;TZ - Tanzania<br>&nbsp;&nbsp;TL - Timor<br>&nbsp;&nbsp;TG - Togo<br>&nbsp;&nbsp;TK - Tokelau<br>&nbsp;&nbsp;TO - Tonga<br>&nbsp;&nbsp;TT - TrinidadAndTobago<br>&nbsp;&nbsp;TN - Tunisia<br>&nbsp;&nbsp;TR - Turkey<br>&nbsp;&nbsp;TM - Turkmenistan<br>&nbsp;&nbsp;TC - TurksAndCaicosIslands<br>&nbsp;&nbsp;TV - Tuvalu<br>&nbsp;&nbsp;UG - Uganda<br>&nbsp;&nbsp;UA - Ukraine<br>&nbsp;&nbsp;UY - Uruguay<br>&nbsp;&nbsp;UZ - Uzbekistan<br>&nbsp;&nbsp;VU - Vanuatu<br>&nbsp;&nbsp;WF - WallisAndFutuna<br>&nbsp;&nbsp;VA - HolySee<br>&nbsp;&nbsp;VE - Venezuela<br>&nbsp;&nbsp;HU - Hungary<br>&nbsp;&nbsp;GB - UnitedKingdom<br>&nbsp;&nbsp;VN - VietNam<br>&nbsp;&nbsp;IT - Italy<br>&nbsp;&nbsp;CI - IvoryCoast<br>&nbsp;&nbsp;BV - BouvetIsland<br>&nbsp;&nbsp;CX - ChristmasIsland<br>&nbsp;&nbsp;IM - IsleOfMan<br>&nbsp;&nbsp;SH - SaintHelenaAscensionTristanCunha<br>&nbsp;&nbsp;AX - AlandIslands<br>&nbsp;&nbsp;CK - CookIslands<br>&nbsp;&nbsp;VI - VirginIslandsUS<br>&nbsp;&nbsp;HM - HeardAndMcDonaldIslands<br>&nbsp;&nbsp;CC - CocosIslands<br>&nbsp;&nbsp;MH - MarshallIslands<br>&nbsp;&nbsp;FO - FaroeIslands<br>&nbsp;&nbsp;SB - SolomonIslands<br>&nbsp;&nbsp;ST - SaoTomeAndPrincipe<br>&nbsp;&nbsp;ZM - Zambia<br>&nbsp;&nbsp;ZW - Zimbabwe<br>&nbsp;&nbsp;AE - UnitedArabEmirates</description>
      <type>string</type>
    </countryOfResidence>
    <companyInvoiceData>
      <type>object</type>
      <properties>
        <companyName>
          <description>Company name</description>
          <type>string</type>
        </companyName>
        <companyCity>
          <description>City of company residence</description>
          <type>string</type>
        </companyCity>
        <companyCounty>
          <description>County of company residence</description>
          <type>string</type>
        </companyCounty>
        <companyPostalCode>
          <description>Postal code of company residence</description>
          <type>string</type>
        </companyPostalCode>
        <companyStreet>
          <description>Street of company residence</description>
          <type>string</type>
        </companyStreet>
        <companyStreetAdditionalInfo>
          <description>Street additional info of company residence</description>
          <type>string</type>
        </companyStreetAdditionalInfo>
        <companyTaxIdentificationNumber>
          <description>Company tax identification number</description>
          <type>string</type>
        </companyTaxIdentificationNumber>
        <companyRemarks>
          <description>Company remarks</description>
          <type>string</type>
        </companyRemarks>
      </properties>
    </companyInvoiceData>
    <personalPhoto>
      <description>Personal photo (made by member) - base64 string format</description>
      <type>string</type>
    </personalPhoto>
    <isEmailVerified>
      <description>Determines whether email address was verified</description>
      <type>boolean</type>
    </isEmailVerified>
    <cardNumber>
      <description>Member card number</description>
      <type>string</type>
    </cardNumber>
    <pin>
      <description>Member PIN number</description>
      <type>string</type>
    </pin>
    <isVindicated>
      <description>Specifies whether the member has active vindication</description>
      <type>boolean</type>
    </isVindicated>
    <memberStatus>
      <format>int32</format>
      <description>Status of member: <br>&nbsp;&nbsp;0 - ProspectNew<br>&nbsp;&nbsp;1 - ProspectHot<br>&nbsp;&nbsp;2 - ProspectWarm<br>&nbsp;&nbsp;3 - ProspectCold<br>&nbsp;&nbsp;4 - ProspectLost<br>&nbsp;&nbsp;5 - ActivePre<br>&nbsp;&nbsp;6 - ActiveFree<br>&nbsp;&nbsp;7 - ActiveZero<br>&nbsp;&nbsp;8 - ActiveOK<br>&nbsp;&nbsp;9 - ActiveFreez<br>&nbsp;&nbsp;10 - ActiveDebt<br>&nbsp;&nbsp;11 - ExNew<br>&nbsp;&nbsp;12 - ExHot<br>&nbsp;&nbsp;13 - ExWarm<br>&nbsp;&nbsp;14 - ExCold<br>&nbsp;&nbsp;15 - Partner<br>&nbsp;&nbsp;16 - ActiveNew<br>&nbsp;&nbsp;17 - ActiveExNew<br>&nbsp;&nbsp;18 - ExDebt<br>&nbsp;&nbsp;19 - Employee<br>&nbsp;&nbsp;20 - NoStatus</description>
      <type>integer</type>
    </memberStatus>
    <walletBalance>
      <format>double</format>
      <description>Member current wallet balance</description>
      <type>number</type>
    </walletBalance>
    <hasCreditCard>
      <description>Determines whether member has credit card</description>
      <type>boolean</type>
    </hasCreditCard>
  </properties>
</MemberResponse>

Responses

Status Meaning Description Schema
200 OK OK MemberResponse
422 Unprocessable Entity 422 ErrorResponse_ECommonResponseCode_

PUT member

Code samples

PUT https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/members HTTP/1.1
Host: api-frontend2.efitness.com.pl
Content-Type: application/json
Accept: application/json
client-request-id: [object Object]
member-token: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

PUT /api/clubs/{clubId}/members

Update member personal data

Body parameter

{
  "type": "object",
  "properties": {
    "firstName": {
      "description": "New firstname of member",
      "type": "string"
    },
    "lastName": {
      "description": "New surname of member",
      "type": "string"
    },
    "birthday": {
      "format": "date-time",
      "description": "New date of birth (yyyy-MM-dd HH:mm:ss)",
      "type": "string"
    },
    "birthPlace": {
      "description": "New place of birth",
      "type": "string"
    },
    "gender": {
      "format": "int32",
      "description": "Member gender, allowed values: <br />  0 - woman<br />  1 - man<br />  2 - other",
      "type": "integer"
    },
    "street": {
      "description": "Street of residence",
      "type": "string"
    },
    "streetAdditionalInfo": {
      "description": "Street additional info of residence",
      "type": "string"
    },
    "flatNumber": {
      "description": "Flat number of residence",
      "type": "string"
    },
    "postalCode": {
      "description": "Postal code of residence",
      "type": "string"
    },
    "city": {
      "description": "City of residence",
      "type": "string"
    },
    "county": {
      "description": "County of residence",
      "type": "string"
    },
    "carRegistrationNumber": {
      "description": "Car registration number",
      "type": "string"
    },
    "cellPhone": {
      "description": "Cell phone number",
      "type": "string"
    },
    "countryPhoneCode": {
      "description": "Country phone",
      "type": "string"
    },
    "countryOfResidence": {
      "description": "Country of residence: <br />  AF - Afghanistan<br />  AL - Albania<br />  DZ - Algeria<br />  AD - Andorra<br />  AO - Angola<br />  AI - Anguilla<br />  AQ - Antarctica<br />  AG - AntiguaAndBarbuda<br />  SA - SaudiArabia<br />  AR - Argentina<br />  AM - Armenia<br />  AW - Aruba<br />  AU - Australia<br />  AT - Austria<br />  AZ - Azerbaijan<br />  BS - Bahamas<br />  BH - Bahrain<br />  BD - Bangladesh<br />  BB - Barbados<br />  BE - Belgium<br />  BZ - Belize<br />  BJ - Benin<br />  BM - Bermuda<br />  BT - Bhutan<br />  BY - Belarus<br />  BO - Bolivia<br />  BQ - Bonaire<br />  BA - BosniaAndHerzegovina<br />  BW - Botswana<br />  BR - Brazil<br />  BN - BruneiDarussalam<br />  IO - BritishIndianOceanTerritory<br />  VG - VirginIslands<br />  BG - Bulgaria<br />  BF - BurkinaFaso<br />  BI - Burundi<br />  CL - Chile<br />  CN - China<br />  HR - Croatia<br />  CW - Curacao<br />  CY - Cyprus<br />  TD - Chad<br />  ME - Montenegro<br />  CZ - CzechRepublic<br />  UM - UnitedStatesMinorOutlyingIslands<br />  DK - Denmark<br />  CD - CongoDemocraticRepublic<br />  DM - Dominica<br />  DO - DominicanRepublic<br />  DJ - Djibouti<br />  EG - Egypt<br />  EC - Ecuador<br />  ER - Eritrea<br />  EE - Estonia<br />  ET - Ethiopia<br />  FK - FalklandIslands<br />  FJ - Fiji<br />  PH - Philippines<br />  FI - Finland<br />  FR - France<br />  TF - FrenchSouthernTerritories<br />  GA - Gabon<br />  GM - Gambia<br />  GS - SouthGeorgiaAndSouthSandwichIslands<br />  GH - Ghana<br />  GI - Gibraltar<br />  GR - Greece<br />  GD - Grenada<br />  GL - Greenland<br />  GE - Georgia<br />  GU - Guam<br />  GG - Guernsey<br />  GF - FrenchGuiana<br />  GY - Guyana<br />  GP - Guadeloupe<br />  GT - Guatemala<br />  GW - GuineaBissau<br />  GQ - EquatorialGuinea<br />  GN - Guinea<br />  HT - Haiti<br />  ES - Spain<br />  NL - Netherlands<br />  HN - Honduras<br />  HK - HongKong<br />  IN - India<br />  ID - Indonesia<br />  IQ - Iraq<br />  IR - Iran<br />  IE - Ireland<br />  IS - Iceland<br />  IL - Israel<br />  JM - Jamaica<br />  JP - Japan<br />  YE - Yemen<br />  JE - Jersey<br />  JO - Jordan<br />  KY - CaymanIslands<br />  KH - Cambodia<br />  CM - Cameroon<br />  CA - Canada<br />  QA - Qatar<br />  KZ - Kazakhstan<br />  KE - Kenya<br />  KG - Kyrgyzstan<br />  KI - Kiribati<br />  CO - Colombia<br />  KM - Comoros<br />  CG - Congo<br />  KR - SouthKorea<br />  KP - NorthKorea<br />  CR - CostaRica<br />  CU - Cuba<br />  KW - Kuwait<br />  LA - Laos<br />  LS - Lesotho<br />  LB - Lebanon<br />  LR - Liberia<br />  LY - Libya<br />  LI - Liechtenstein<br />  LT - Lithuania<br />  LU - Luxembourg<br />  LV - Latvia<br />  MK - Macedonia<br />  MG - Madagascar<br />  YT - Mayotte<br />  MO - Macao<br />  MW - Malawi<br />  MV - Maldives<br />  MY - Malaysia<br />  ML - Mali<br />  MT - Malta<br />  MP - NorthernMarianaIslands<br />  MA - Morocco<br />  MQ - Martinique<br />  MR - Mauritania<br />  MU - Mauritius<br />  MX - Mexico<br />  FM - Micronesia<br />  MM - Myanmar<br />  MD - Moldova<br />  MC - Monaco<br />  MN - Mongolia<br />  MS - Montserrat<br />  MZ - Mozambique<br />  NA - Namibia<br />  NR - Nauru<br />  NP - Nepal<br />  DE - Germany<br />  NE - Niger<br />  NG - Nigeria<br />  NI - Nicaragua<br />  NU - Niue<br />  NF - NorfolkIsland<br />  NO - Norway<br />  NC - NewCaledonia<br />  NZ - NewZealand<br />  OM - Oman<br />  PK - Pakistan<br />  PW - Palau<br />  PS - Palestine<br />  PA - Panama<br />  PG - PapuaNewGuinea<br />  PY - Paraguay<br />  PE - Peru<br />  PN - Pitcairn<br />  PF - FrenchPolynesia<br />  PL - Poland<br />  PR - PuertoRico<br />  PT - Portugal<br />  ZA - SouthAfrica<br />  CF - CentralAfricanRepublic<br />  CV - CapeVerde<br />  RE - Reunion<br />  RU - Russia<br />  RO - Romania<br />  RW - Rwanda<br />  EH - WesternSahara<br />  KN - SaintKittsAndNevis<br />  LC - SaintLucia<br />  VC - SaintVincentAndGrenadines<br />  BL - SaintBarthelemy<br />  MF - SaintMartin<br />  PM - SaintPierreAndMiquelon<br />  SV - ElSalvador<br />  AS - AmericanSamoa<br />  WS - Samoa<br />  SM - SanMarino<br />  SN - Senegal<br />  RS - Serbia<br />  SC - Seychelles<br />  SL - SierraLeone<br />  SG - Singapore<br />  SX - SintMaarten<br />  SK - Slovakia<br />  SI - Slovenia<br />  SO - Somalia<br />  LK - SriLanka<br />  US - UnitedStates<br />  SZ - Swaziland<br />  SD - Sudan<br />  SS - SouthSudan<br />  SR - Suriname<br />  SJ - SvalbardAndJanMayen<br />  SY - Syria<br />  CH - Switzerland<br />  SE - Sweden<br />  TJ - Tajikistan<br />  TH - Thailand<br />  TW - Taiwan<br />  TZ - Tanzania<br />  TL - Timor<br />  TG - Togo<br />  TK - Tokelau<br />  TO - Tonga<br />  TT - TrinidadAndTobago<br />  TN - Tunisia<br />  TR - Turkey<br />  TM - Turkmenistan<br />  TC - TurksAndCaicosIslands<br />  TV - Tuvalu<br />  UG - Uganda<br />  UA - Ukraine<br />  UY - Uruguay<br />  UZ - Uzbekistan<br />  VU - Vanuatu<br />  WF - WallisAndFutuna<br />  VA - HolySee<br />  VE - Venezuela<br />  HU - Hungary<br />  GB - UnitedKingdom<br />  VN - VietNam<br />  IT - Italy<br />  CI - IvoryCoast<br />  BV - BouvetIsland<br />  CX - ChristmasIsland<br />  IM - IsleOfMan<br />  SH - SaintHelenaAscensionTristanCunha<br />  AX - AlandIslands<br />  CK - CookIslands<br />  VI - VirginIslandsUS<br />  HM - HeardAndMcDonaldIslands<br />  CC - CocosIslands<br />  MH - MarshallIslands<br />  FO - FaroeIslands<br />  SB - SolomonIslands<br />  ST - SaoTomeAndPrincipe<br />  ZM - Zambia<br />  ZW - Zimbabwe<br />  AE - UnitedArabEmirates",
      "type": "string"
    },
    "taxIdentificationNumber": {
      "description": "Tax number",
      "type": "string"
    },
    "companyInvoiceData": {
      "type": "object",
      "properties": {
        "companyName": {
          "description": "Company name",
          "type": "string"
        },
        "companyCity": {
          "description": "City of company residence",
          "type": "string"
        },
        "companyCounty": {
          "description": "County of company residence",
          "type": "string"
        },
        "companyPostalCode": {
          "description": "Postal code of company residence",
          "type": "string"
        },
        "companyStreet": {
          "description": "Street of company residence",
          "type": "string"
        },
        "companyStreetAdditionalInfo": {
          "description": "Street additional info of company residence",
          "type": "string"
        },
        "companyTaxIdentificationNumber": {
          "description": "Company tax identification number",
          "type": "string"
        },
        "companyRemarks": {
          "description": "Company remarks",
          "type": "string"
        }
      }
    },
    "bankName": {
      "description": "Name of the bank supporting the payment",
      "type": "string"
    },
    "iban": {
      "description": "International bank account number IBAN",
      "type": "string"
    },
    "bic": {
      "description": "International code identifying the financial institution BIC",
      "type": "string"
    },
    "bankAccountOwnerName": {
      "description": "Bank account owner name",
      "type": "string"
    },
    "accountOwner": {
      "description": "Bank account owner",
      "type": "string"
    }
  }
}

type: object
properties:
  firstName:
    description: New firstname of member
    type: string
  lastName:
    description: New surname of member
    type: string
  birthday:
    format: date-time
    description: 'New date of birth (yyyy-MM-dd HH:mm:ss)'
    type: string
  birthPlace:
    description: New place of birth
    type: string
  gender:
    format: int32
    description: >-
      Member gender, allowed values: <br />  0 - woman<br />  1
      - man<br />  2 - other
    type: integer
  street:
    description: Street of residence
    type: string
  streetAdditionalInfo:
    description: Street additional info of residence
    type: string
  flatNumber:
    description: Flat number of residence
    type: string
  postalCode:
    description: Postal code of residence
    type: string
  city:
    description: City of residence
    type: string
  county:
    description: County of residence
    type: string
  carRegistrationNumber:
    description: Car registration number
    type: string
  cellPhone:
    description: Cell phone number
    type: string
  countryPhoneCode:
    description: Country phone
    type: string
  countryOfResidence:
    description: >-
      Country of residence: <br />  AF - Afghanistan<br />  AL -
      Albania<br />  DZ - Algeria<br />  AD -
      Andorra<br />  AO - Angola<br />  AI -
      Anguilla<br />  AQ - Antarctica<br />  AG -
      AntiguaAndBarbuda<br />  SA - SaudiArabia<br />  AR -
      Argentina<br />  AM - Armenia<br />  AW -
      Aruba<br />  AU - Australia<br />  AT -
      Austria<br />  AZ - Azerbaijan<br />  BS -
      Bahamas<br />  BH - Bahrain<br />  BD -
      Bangladesh<br />  BB - Barbados<br />  BE -
      Belgium<br />  BZ - Belize<br />  BJ -
      Benin<br />  BM - Bermuda<br />  BT -
      Bhutan<br />  BY - Belarus<br />  BO -
      Bolivia<br />  BQ - Bonaire<br />  BA -
      BosniaAndHerzegovina<br />  BW - Botswana<br />  BR -
      Brazil<br />  BN - BruneiDarussalam<br />  IO -
      BritishIndianOceanTerritory<br />  VG -
      VirginIslands<br />  BG - Bulgaria<br />  BF -
      BurkinaFaso<br />  BI - Burundi<br />  CL -
      Chile<br />  CN - China<br />  HR -
      Croatia<br />  CW - Curacao<br />  CY -
      Cyprus<br />  TD - Chad<br />  ME -
      Montenegro<br />  CZ - CzechRepublic<br />  UM -
      UnitedStatesMinorOutlyingIslands<br />  DK -
      Denmark<br />  CD - CongoDemocraticRepublic<br />  DM -
      Dominica<br />  DO - DominicanRepublic<br />  DJ -
      Djibouti<br />  EG - Egypt<br />  EC -
      Ecuador<br />  ER - Eritrea<br />  EE -
      Estonia<br />  ET - Ethiopia<br />  FK -
      FalklandIslands<br />  FJ - Fiji<br />  PH -
      Philippines<br />  FI - Finland<br />  FR -
      France<br />  TF - FrenchSouthernTerritories<br />  GA -
      Gabon<br />  GM - Gambia<br />  GS -
      SouthGeorgiaAndSouthSandwichIslands<br />  GH -
      Ghana<br />  GI - Gibraltar<br />  GR -
      Greece<br />  GD - Grenada<br />  GL -
      Greenland<br />  GE - Georgia<br />  GU -
      Guam<br />  GG - Guernsey<br />  GF -
      FrenchGuiana<br />  GY - Guyana<br />  GP -
      Guadeloupe<br />  GT - Guatemala<br />  GW -
      GuineaBissau<br />  GQ - EquatorialGuinea<br />  GN -
      Guinea<br />  HT - Haiti<br />  ES -
      Spain<br />  NL - Netherlands<br />  HN -
      Honduras<br />  HK - HongKong<br />  IN -
      India<br />  ID - Indonesia<br />  IQ -
      Iraq<br />  IR - Iran<br />  IE -
      Ireland<br />  IS - Iceland<br />  IL -
      Israel<br />  JM - Jamaica<br />  JP -
      Japan<br />  YE - Yemen<br />  JE -
      Jersey<br />  JO - Jordan<br />  KY -
      CaymanIslands<br />  KH - Cambodia<br />  CM -
      Cameroon<br />  CA - Canada<br />  QA -
      Qatar<br />  KZ - Kazakhstan<br />  KE -
      Kenya<br />  KG - Kyrgyzstan<br />  KI -
      Kiribati<br />  CO - Colombia<br />  KM -
      Comoros<br />  CG - Congo<br />  KR -
      SouthKorea<br />  KP - NorthKorea<br />  CR -
      CostaRica<br />  CU - Cuba<br />  KW -
      Kuwait<br />  LA - Laos<br />  LS -
      Lesotho<br />  LB - Lebanon<br />  LR -
      Liberia<br />  LY - Libya<br />  LI -
      Liechtenstein<br />  LT - Lithuania<br />  LU -
      Luxembourg<br />  LV - Latvia<br />  MK -
      Macedonia<br />  MG - Madagascar<br />  YT -
      Mayotte<br />  MO - Macao<br />  MW -
      Malawi<br />  MV - Maldives<br />  MY -
      Malaysia<br />  ML - Mali<br />  MT -
      Malta<br />  MP - NorthernMarianaIslands<br />  MA -
      Morocco<br />  MQ - Martinique<br />  MR -
      Mauritania<br />  MU - Mauritius<br />  MX -
      Mexico<br />  FM - Micronesia<br />  MM -
      Myanmar<br />  MD - Moldova<br />  MC -
      Monaco<br />  MN - Mongolia<br />  MS -
      Montserrat<br />  MZ - Mozambique<br />  NA -
      Namibia<br />  NR - Nauru<br />  NP -
      Nepal<br />  DE - Germany<br />  NE -
      Niger<br />  NG - Nigeria<br />  NI -
      Nicaragua<br />  NU - Niue<br />  NF -
      NorfolkIsland<br />  NO - Norway<br />  NC -
      NewCaledonia<br />  NZ - NewZealand<br />  OM -
      Oman<br />  PK - Pakistan<br />  PW -
      Palau<br />  PS - Palestine<br />  PA -
      Panama<br />  PG - PapuaNewGuinea<br />  PY -
      Paraguay<br />  PE - Peru<br />  PN -
      Pitcairn<br />  PF - FrenchPolynesia<br />  PL -
      Poland<br />  PR - PuertoRico<br />  PT -
      Portugal<br />  ZA - SouthAfrica<br />  CF -
      CentralAfricanRepublic<br />  CV - CapeVerde<br />  RE -
      Reunion<br />  RU - Russia<br />  RO -
      Romania<br />  RW - Rwanda<br />  EH -
      WesternSahara<br />  KN - SaintKittsAndNevis<br />  LC -
      SaintLucia<br />  VC - SaintVincentAndGrenadines<br />  BL
      - SaintBarthelemy<br />  MF - SaintMartin<br />  PM -
      SaintPierreAndMiquelon<br />  SV - ElSalvador<br />  AS -
      AmericanSamoa<br />  WS - Samoa<br />  SM -
      SanMarino<br />  SN - Senegal<br />  RS -
      Serbia<br />  SC - Seychelles<br />  SL -
      SierraLeone<br />  SG - Singapore<br />  SX -
      SintMaarten<br />  SK - Slovakia<br />  SI -
      Slovenia<br />  SO - Somalia<br />  LK -
      SriLanka<br />  US - UnitedStates<br />  SZ -
      Swaziland<br />  SD - Sudan<br />  SS -
      SouthSudan<br />  SR - Suriname<br />  SJ -
      SvalbardAndJanMayen<br />  SY - Syria<br />  CH -
      Switzerland<br />  SE - Sweden<br />  TJ -
      Tajikistan<br />  TH - Thailand<br />  TW -
      Taiwan<br />  TZ - Tanzania<br />  TL -
      Timor<br />  TG - Togo<br />  TK -
      Tokelau<br />  TO - Tonga<br />  TT -
      TrinidadAndTobago<br />  TN - Tunisia<br />  TR -
      Turkey<br />  TM - Turkmenistan<br />  TC -
      TurksAndCaicosIslands<br />  TV - Tuvalu<br />  UG -
      Uganda<br />  UA - Ukraine<br />  UY -
      Uruguay<br />  UZ - Uzbekistan<br />  VU -
      Vanuatu<br />  WF - WallisAndFutuna<br />  VA -
      HolySee<br />  VE - Venezuela<br />  HU -
      Hungary<br />  GB - UnitedKingdom<br />  VN -
      VietNam<br />  IT - Italy<br />  CI -
      IvoryCoast<br />  BV - BouvetIsland<br />  CX -
      ChristmasIsland<br />  IM - IsleOfMan<br />  SH -
      SaintHelenaAscensionTristanCunha<br />  AX -
      AlandIslands<br />  CK - CookIslands<br />  VI -
      VirginIslandsUS<br />  HM -
      HeardAndMcDonaldIslands<br />  CC - CocosIslands<br />  MH
      - MarshallIslands<br />  FO - FaroeIslands<br />  SB -
      SolomonIslands<br />  ST - SaoTomeAndPrincipe<br />  ZM -
      Zambia<br />  ZW - Zimbabwe<br />  AE - UnitedArabEmirates
    type: string
  taxIdentificationNumber:
    description: Tax number
    type: string
  companyInvoiceData:
    type: object
    properties:
      companyName:
        description: Company name
        type: string
      companyCity:
        description: City of company residence
        type: string
      companyCounty:
        description: County of company residence
        type: string
      companyPostalCode:
        description: Postal code of company residence
        type: string
      companyStreet:
        description: Street of company residence
        type: string
      companyStreetAdditionalInfo:
        description: Street additional info of company residence
        type: string
      companyTaxIdentificationNumber:
        description: Company tax identification number
        type: string
      companyRemarks:
        description: Company remarks
        type: string
  bankName:
    description: Name of the bank supporting the payment
    type: string
  iban:
    description: International bank account number IBAN
    type: string
  bic:
    description: International code identifying the financial institution BIC
    type: string
  bankAccountOwnerName:
    description: Bank account owner name
    type: string
  accountOwner:
    description: Bank account owner
    type: string


<?xml version="1.0" encoding="UTF-8" ?>
<UpdateMemberRequest>
  <type>object</type>
  <properties>
    <firstName>
      <description>New firstname of member</description>
      <type>string</type>
    </firstName>
    <lastName>
      <description>New surname of member</description>
      <type>string</type>
    </lastName>
    <birthday>
      <format>date-time</format>
      <description>New date of birth (yyyy-MM-dd HH:mm:ss)</description>
      <type>string</type>
    </birthday>
    <birthPlace>
      <description>New place of birth</description>
      <type>string</type>
    </birthPlace>
    <gender>
      <format>int32</format>
      <description>Member gender, allowed values: <br>&nbsp;&nbsp;0 - woman<br>&nbsp;&nbsp;1 - man<br>&nbsp;&nbsp;2 - other</description>
      <type>integer</type>
    </gender>
    <street>
      <description>Street of residence</description>
      <type>string</type>
    </street>
    <streetAdditionalInfo>
      <description>Street additional info of residence</description>
      <type>string</type>
    </streetAdditionalInfo>
    <flatNumber>
      <description>Flat number of residence</description>
      <type>string</type>
    </flatNumber>
    <postalCode>
      <description>Postal code of residence</description>
      <type>string</type>
    </postalCode>
    <city>
      <description>City of residence</description>
      <type>string</type>
    </city>
    <county>
      <description>County of residence</description>
      <type>string</type>
    </county>
    <carRegistrationNumber>
      <description>Car registration number</description>
      <type>string</type>
    </carRegistrationNumber>
    <cellPhone>
      <description>Cell phone number</description>
      <type>string</type>
    </cellPhone>
    <countryPhoneCode>
      <description>Country phone</description>
      <type>string</type>
    </countryPhoneCode>
    <countryOfResidence>
      <description>Country of residence: <br>&nbsp;&nbsp;AF - Afghanistan<br>&nbsp;&nbsp;AL - Albania<br>&nbsp;&nbsp;DZ - Algeria<br>&nbsp;&nbsp;AD - Andorra<br>&nbsp;&nbsp;AO - Angola<br>&nbsp;&nbsp;AI - Anguilla<br>&nbsp;&nbsp;AQ - Antarctica<br>&nbsp;&nbsp;AG - AntiguaAndBarbuda<br>&nbsp;&nbsp;SA - SaudiArabia<br>&nbsp;&nbsp;AR - Argentina<br>&nbsp;&nbsp;AM - Armenia<br>&nbsp;&nbsp;AW - Aruba<br>&nbsp;&nbsp;AU - Australia<br>&nbsp;&nbsp;AT - Austria<br>&nbsp;&nbsp;AZ - Azerbaijan<br>&nbsp;&nbsp;BS - Bahamas<br>&nbsp;&nbsp;BH - Bahrain<br>&nbsp;&nbsp;BD - Bangladesh<br>&nbsp;&nbsp;BB - Barbados<br>&nbsp;&nbsp;BE - Belgium<br>&nbsp;&nbsp;BZ - Belize<br>&nbsp;&nbsp;BJ - Benin<br>&nbsp;&nbsp;BM - Bermuda<br>&nbsp;&nbsp;BT - Bhutan<br>&nbsp;&nbsp;BY - Belarus<br>&nbsp;&nbsp;BO - Bolivia<br>&nbsp;&nbsp;BQ - Bonaire<br>&nbsp;&nbsp;BA - BosniaAndHerzegovina<br>&nbsp;&nbsp;BW - Botswana<br>&nbsp;&nbsp;BR - Brazil<br>&nbsp;&nbsp;BN - BruneiDarussalam<br>&nbsp;&nbsp;IO - BritishIndianOceanTerritory<br>&nbsp;&nbsp;VG - VirginIslands<br>&nbsp;&nbsp;BG - Bulgaria<br>&nbsp;&nbsp;BF - BurkinaFaso<br>&nbsp;&nbsp;BI - Burundi<br>&nbsp;&nbsp;CL - Chile<br>&nbsp;&nbsp;CN - China<br>&nbsp;&nbsp;HR - Croatia<br>&nbsp;&nbsp;CW - Curacao<br>&nbsp;&nbsp;CY - Cyprus<br>&nbsp;&nbsp;TD - Chad<br>&nbsp;&nbsp;ME - Montenegro<br>&nbsp;&nbsp;CZ - CzechRepublic<br>&nbsp;&nbsp;UM - UnitedStatesMinorOutlyingIslands<br>&nbsp;&nbsp;DK - Denmark<br>&nbsp;&nbsp;CD - CongoDemocraticRepublic<br>&nbsp;&nbsp;DM - Dominica<br>&nbsp;&nbsp;DO - DominicanRepublic<br>&nbsp;&nbsp;DJ - Djibouti<br>&nbsp;&nbsp;EG - Egypt<br>&nbsp;&nbsp;EC - Ecuador<br>&nbsp;&nbsp;ER - Eritrea<br>&nbsp;&nbsp;EE - Estonia<br>&nbsp;&nbsp;ET - Ethiopia<br>&nbsp;&nbsp;FK - FalklandIslands<br>&nbsp;&nbsp;FJ - Fiji<br>&nbsp;&nbsp;PH - Philippines<br>&nbsp;&nbsp;FI - Finland<br>&nbsp;&nbsp;FR - France<br>&nbsp;&nbsp;TF - FrenchSouthernTerritories<br>&nbsp;&nbsp;GA - Gabon<br>&nbsp;&nbsp;GM - Gambia<br>&nbsp;&nbsp;GS - SouthGeorgiaAndSouthSandwichIslands<br>&nbsp;&nbsp;GH - Ghana<br>&nbsp;&nbsp;GI - Gibraltar<br>&nbsp;&nbsp;GR - Greece<br>&nbsp;&nbsp;GD - Grenada<br>&nbsp;&nbsp;GL - Greenland<br>&nbsp;&nbsp;GE - Georgia<br>&nbsp;&nbsp;GU - Guam<br>&nbsp;&nbsp;GG - Guernsey<br>&nbsp;&nbsp;GF - FrenchGuiana<br>&nbsp;&nbsp;GY - Guyana<br>&nbsp;&nbsp;GP - Guadeloupe<br>&nbsp;&nbsp;GT - Guatemala<br>&nbsp;&nbsp;GW - GuineaBissau<br>&nbsp;&nbsp;GQ - EquatorialGuinea<br>&nbsp;&nbsp;GN - Guinea<br>&nbsp;&nbsp;HT - Haiti<br>&nbsp;&nbsp;ES - Spain<br>&nbsp;&nbsp;NL - Netherlands<br>&nbsp;&nbsp;HN - Honduras<br>&nbsp;&nbsp;HK - HongKong<br>&nbsp;&nbsp;IN - India<br>&nbsp;&nbsp;ID - Indonesia<br>&nbsp;&nbsp;IQ - Iraq<br>&nbsp;&nbsp;IR - Iran<br>&nbsp;&nbsp;IE - Ireland<br>&nbsp;&nbsp;IS - Iceland<br>&nbsp;&nbsp;IL - Israel<br>&nbsp;&nbsp;JM - Jamaica<br>&nbsp;&nbsp;JP - Japan<br>&nbsp;&nbsp;YE - Yemen<br>&nbsp;&nbsp;JE - Jersey<br>&nbsp;&nbsp;JO - Jordan<br>&nbsp;&nbsp;KY - CaymanIslands<br>&nbsp;&nbsp;KH - Cambodia<br>&nbsp;&nbsp;CM - Cameroon<br>&nbsp;&nbsp;CA - Canada<br>&nbsp;&nbsp;QA - Qatar<br>&nbsp;&nbsp;KZ - Kazakhstan<br>&nbsp;&nbsp;KE - Kenya<br>&nbsp;&nbsp;KG - Kyrgyzstan<br>&nbsp;&nbsp;KI - Kiribati<br>&nbsp;&nbsp;CO - Colombia<br>&nbsp;&nbsp;KM - Comoros<br>&nbsp;&nbsp;CG - Congo<br>&nbsp;&nbsp;KR - SouthKorea<br>&nbsp;&nbsp;KP - NorthKorea<br>&nbsp;&nbsp;CR - CostaRica<br>&nbsp;&nbsp;CU - Cuba<br>&nbsp;&nbsp;KW - Kuwait<br>&nbsp;&nbsp;LA - Laos<br>&nbsp;&nbsp;LS - Lesotho<br>&nbsp;&nbsp;LB - Lebanon<br>&nbsp;&nbsp;LR - Liberia<br>&nbsp;&nbsp;LY - Libya<br>&nbsp;&nbsp;LI - Liechtenstein<br>&nbsp;&nbsp;LT - Lithuania<br>&nbsp;&nbsp;LU - Luxembourg<br>&nbsp;&nbsp;LV - Latvia<br>&nbsp;&nbsp;MK - Macedonia<br>&nbsp;&nbsp;MG - Madagascar<br>&nbsp;&nbsp;YT - Mayotte<br>&nbsp;&nbsp;MO - Macao<br>&nbsp;&nbsp;MW - Malawi<br>&nbsp;&nbsp;MV - Maldives<br>&nbsp;&nbsp;MY - Malaysia<br>&nbsp;&nbsp;ML - Mali<br>&nbsp;&nbsp;MT - Malta<br>&nbsp;&nbsp;MP - NorthernMarianaIslands<br>&nbsp;&nbsp;MA - Morocco<br>&nbsp;&nbsp;MQ - Martinique<br>&nbsp;&nbsp;MR - Mauritania<br>&nbsp;&nbsp;MU - Mauritius<br>&nbsp;&nbsp;MX - Mexico<br>&nbsp;&nbsp;FM - Micronesia<br>&nbsp;&nbsp;MM - Myanmar<br>&nbsp;&nbsp;MD - Moldova<br>&nbsp;&nbsp;MC - Monaco<br>&nbsp;&nbsp;MN - Mongolia<br>&nbsp;&nbsp;MS - Montserrat<br>&nbsp;&nbsp;MZ - Mozambique<br>&nbsp;&nbsp;NA - Namibia<br>&nbsp;&nbsp;NR - Nauru<br>&nbsp;&nbsp;NP - Nepal<br>&nbsp;&nbsp;DE - Germany<br>&nbsp;&nbsp;NE - Niger<br>&nbsp;&nbsp;NG - Nigeria<br>&nbsp;&nbsp;NI - Nicaragua<br>&nbsp;&nbsp;NU - Niue<br>&nbsp;&nbsp;NF - NorfolkIsland<br>&nbsp;&nbsp;NO - Norway<br>&nbsp;&nbsp;NC - NewCaledonia<br>&nbsp;&nbsp;NZ - NewZealand<br>&nbsp;&nbsp;OM - Oman<br>&nbsp;&nbsp;PK - Pakistan<br>&nbsp;&nbsp;PW - Palau<br>&nbsp;&nbsp;PS - Palestine<br>&nbsp;&nbsp;PA - Panama<br>&nbsp;&nbsp;PG - PapuaNewGuinea<br>&nbsp;&nbsp;PY - Paraguay<br>&nbsp;&nbsp;PE - Peru<br>&nbsp;&nbsp;PN - Pitcairn<br>&nbsp;&nbsp;PF - FrenchPolynesia<br>&nbsp;&nbsp;PL - Poland<br>&nbsp;&nbsp;PR - PuertoRico<br>&nbsp;&nbsp;PT - Portugal<br>&nbsp;&nbsp;ZA - SouthAfrica<br>&nbsp;&nbsp;CF - CentralAfricanRepublic<br>&nbsp;&nbsp;CV - CapeVerde<br>&nbsp;&nbsp;RE - Reunion<br>&nbsp;&nbsp;RU - Russia<br>&nbsp;&nbsp;RO - Romania<br>&nbsp;&nbsp;RW - Rwanda<br>&nbsp;&nbsp;EH - WesternSahara<br>&nbsp;&nbsp;KN - SaintKittsAndNevis<br>&nbsp;&nbsp;LC - SaintLucia<br>&nbsp;&nbsp;VC - SaintVincentAndGrenadines<br>&nbsp;&nbsp;BL - SaintBarthelemy<br>&nbsp;&nbsp;MF - SaintMartin<br>&nbsp;&nbsp;PM - SaintPierreAndMiquelon<br>&nbsp;&nbsp;SV - ElSalvador<br>&nbsp;&nbsp;AS - AmericanSamoa<br>&nbsp;&nbsp;WS - Samoa<br>&nbsp;&nbsp;SM - SanMarino<br>&nbsp;&nbsp;SN - Senegal<br>&nbsp;&nbsp;RS - Serbia<br>&nbsp;&nbsp;SC - Seychelles<br>&nbsp;&nbsp;SL - SierraLeone<br>&nbsp;&nbsp;SG - Singapore<br>&nbsp;&nbsp;SX - SintMaarten<br>&nbsp;&nbsp;SK - Slovakia<br>&nbsp;&nbsp;SI - Slovenia<br>&nbsp;&nbsp;SO - Somalia<br>&nbsp;&nbsp;LK - SriLanka<br>&nbsp;&nbsp;US - UnitedStates<br>&nbsp;&nbsp;SZ - Swaziland<br>&nbsp;&nbsp;SD - Sudan<br>&nbsp;&nbsp;SS - SouthSudan<br>&nbsp;&nbsp;SR - Suriname<br>&nbsp;&nbsp;SJ - SvalbardAndJanMayen<br>&nbsp;&nbsp;SY - Syria<br>&nbsp;&nbsp;CH - Switzerland<br>&nbsp;&nbsp;SE - Sweden<br>&nbsp;&nbsp;TJ - Tajikistan<br>&nbsp;&nbsp;TH - Thailand<br>&nbsp;&nbsp;TW - Taiwan<br>&nbsp;&nbsp;TZ - Tanzania<br>&nbsp;&nbsp;TL - Timor<br>&nbsp;&nbsp;TG - Togo<br>&nbsp;&nbsp;TK - Tokelau<br>&nbsp;&nbsp;TO - Tonga<br>&nbsp;&nbsp;TT - TrinidadAndTobago<br>&nbsp;&nbsp;TN - Tunisia<br>&nbsp;&nbsp;TR - Turkey<br>&nbsp;&nbsp;TM - Turkmenistan<br>&nbsp;&nbsp;TC - TurksAndCaicosIslands<br>&nbsp;&nbsp;TV - Tuvalu<br>&nbsp;&nbsp;UG - Uganda<br>&nbsp;&nbsp;UA - Ukraine<br>&nbsp;&nbsp;UY - Uruguay<br>&nbsp;&nbsp;UZ - Uzbekistan<br>&nbsp;&nbsp;VU - Vanuatu<br>&nbsp;&nbsp;WF - WallisAndFutuna<br>&nbsp;&nbsp;VA - HolySee<br>&nbsp;&nbsp;VE - Venezuela<br>&nbsp;&nbsp;HU - Hungary<br>&nbsp;&nbsp;GB - UnitedKingdom<br>&nbsp;&nbsp;VN - VietNam<br>&nbsp;&nbsp;IT - Italy<br>&nbsp;&nbsp;CI - IvoryCoast<br>&nbsp;&nbsp;BV - BouvetIsland<br>&nbsp;&nbsp;CX - ChristmasIsland<br>&nbsp;&nbsp;IM - IsleOfMan<br>&nbsp;&nbsp;SH - SaintHelenaAscensionTristanCunha<br>&nbsp;&nbsp;AX - AlandIslands<br>&nbsp;&nbsp;CK - CookIslands<br>&nbsp;&nbsp;VI - VirginIslandsUS<br>&nbsp;&nbsp;HM - HeardAndMcDonaldIslands<br>&nbsp;&nbsp;CC - CocosIslands<br>&nbsp;&nbsp;MH - MarshallIslands<br>&nbsp;&nbsp;FO - FaroeIslands<br>&nbsp;&nbsp;SB - SolomonIslands<br>&nbsp;&nbsp;ST - SaoTomeAndPrincipe<br>&nbsp;&nbsp;ZM - Zambia<br>&nbsp;&nbsp;ZW - Zimbabwe<br>&nbsp;&nbsp;AE - UnitedArabEmirates</description>
      <type>string</type>
    </countryOfResidence>
    <taxIdentificationNumber>
      <description>Tax number</description>
      <type>string</type>
    </taxIdentificationNumber>
    <companyInvoiceData>
      <type>object</type>
      <properties>
        <companyName>
          <description>Company name</description>
          <type>string</type>
        </companyName>
        <companyCity>
          <description>City of company residence</description>
          <type>string</type>
        </companyCity>
        <companyCounty>
          <description>County of company residence</description>
          <type>string</type>
        </companyCounty>
        <companyPostalCode>
          <description>Postal code of company residence</description>
          <type>string</type>
        </companyPostalCode>
        <companyStreet>
          <description>Street of company residence</description>
          <type>string</type>
        </companyStreet>
        <companyStreetAdditionalInfo>
          <description>Street additional info of company residence</description>
          <type>string</type>
        </companyStreetAdditionalInfo>
        <companyTaxIdentificationNumber>
          <description>Company tax identification number</description>
          <type>string</type>
        </companyTaxIdentificationNumber>
        <companyRemarks>
          <description>Company remarks</description>
          <type>string</type>
        </companyRemarks>
      </properties>
    </companyInvoiceData>
    <bankName>
      <description>Name of the bank supporting the payment</description>
      <type>string</type>
    </bankName>
    <iban>
      <description>International bank account number IBAN</description>
      <type>string</type>
    </iban>
    <bic>
      <description>International code identifying the financial institution BIC</description>
      <type>string</type>
    </bic>
    <bankAccountOwnerName>
      <description>Bank account owner name</description>
      <type>string</type>
    </bankAccountOwnerName>
    <accountOwner>
      <description>Bank account owner</description>
      <type>string</type>
    </accountOwner>
  </properties>
</UpdateMemberRequest>

Parameters

Name In Type Required Description
clubId path string true none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
member-token header string true Token used to authorize a club member.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.
body body UpdateMemberRequest true Model request

Example responses

422 Response

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "responseCode": {
            "type": "string",
            "readOnly": true
          },
          "message": {
            "type": "string"
          },
          "path": {
            "type": "string"
          }
        }
      }
    }
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<ErrorResponse_MemberResponseCode_>
  <type>object</type>
  <properties>
    <errors>
      <type>array</type>
      <items>
        <type>object</type>
        <properties>
          <responseCode>
            <type>string</type>
            <readOnly>true</readOnly>
          </responseCode>
          <message>
            <type>string</type>
          </message>
          <path>
            <type>string</type>
          </path>
        </properties>
      </items>
    </errors>
  </properties>
</ErrorResponse_MemberResponseCode_>

Responses

Status Meaning Description Schema
200 OK Member updated successfully None
422 Unprocessable Entity Model validation error ErrorResponse_MemberResponseCode_

POST member

Code samples

POST https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/members HTTP/1.1
Host: api-frontend2.efitness.com.pl
Content-Type: application/json
Accept: application/json
client-request-id: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

POST /api/clubs/{clubId}/members

Add new member

Body parameter

{
  "description": "The required fields are set here: https://{eFitness-backend-url}/Configuration/MemberProfileRegistration",
  "required": [
    "firstName",
    "lastName"
  ],
  "type": "object",
  "properties": {
    "firstName": {
      "description": "Firstname of new member",
      "type": "string"
    },
    "lastName": {
      "description": "Lastname of new member",
      "type": "string"
    },
    "personalIdentityNumber": {
      "description": "Personal Identity Number",
      "type": "string"
    },
    "email": {
      "description": "Email of new member",
      "type": "string"
    },
    "confirmationEmail": {
      "description": "Confirmation email of new member",
      "type": "string"
    },
    "street": {
      "description": "Street of residence",
      "type": "string"
    },
    "streetAdditionalInfo": {
      "description": "Street additional info of residence",
      "type": "string"
    },
    "flatNumber": {
      "description": "Flat number of residence",
      "type": "string"
    },
    "postalCode": {
      "description": "Postal code of residence",
      "type": "string"
    },
    "city": {
      "description": "City of residence",
      "type": "string"
    },
    "county": {
      "description": "County of residence",
      "type": "string"
    },
    "carRegistrationNumber": {
      "description": "Car registration number",
      "type": "string"
    },
    "landlinePhoneNumber": {
      "description": "Landline phone number",
      "type": "string"
    },
    "countryLandlinePhoneCode": {
      "description": "Country landline phone code",
      "type": "string"
    },
    "cellPhone": {
      "description": "Cell phone number",
      "type": "string"
    },
    "countryPhoneCode": {
      "description": "Country phone",
      "type": "string"
    },
    "identityDocumentType": {
      "format": "int32",
      "description": "Name of the document confirming member identity: <br />  0 - ID<br />  1 - Passport<br />  2 - DriversLicense<br />  3 - RefugeePermit<br />  4 - ResidencePermit",
      "type": "integer"
    },
    "identityDocumentNumber": {
      "description": "Number of the document confirming member identity",
      "type": "string"
    },
    "gender": {
      "format": "int32",
      "description": "Gender: <br />  0 - woman<br />  1 - man<br />  2 - other",
      "type": "integer"
    },
    "birthday": {
      "format": "date-time",
      "description": "Birthday date (yyyy-MM-dd HH:mm:ss)",
      "type": "string"
    },
    "bankName": {
      "description": "Name of the bank supporting the payment",
      "type": "string"
    },
    "iban": {
      "description": "International bank account number IBAN",
      "type": "string"
    },
    "bic": {
      "description": "International code identifying the financial institution BIC",
      "type": "string"
    },
    "taxIdentificationNumber": {
      "description": "Tax number",
      "type": "string"
    },
    "isForeign": {
      "description": "Is member foreigner",
      "type": "boolean"
    },
    "memberSource": {
      "format": "int32",
      "description": "ID of the club member's knowledge about the club, can be obtained at '~/api/clubs/{clubId}/member-sources'",
      "type": "integer"
    },
    "countryOfResidence": {
      "description": "Country of residence: <br />  AF - Afghanistan<br />  AL - Albania<br />  DZ - Algeria<br />  AD - Andorra<br />  AO - Angola<br />  AI - Anguilla<br />  AQ - Antarctica<br />  AG - AntiguaAndBarbuda<br />  SA - SaudiArabia<br />  AR - Argentina<br />  AM - Armenia<br />  AW - Aruba<br />  AU - Australia<br />  AT - Austria<br />  AZ - Azerbaijan<br />  BS - Bahamas<br />  BH - Bahrain<br />  BD - Bangladesh<br />  BB - Barbados<br />  BE - Belgium<br />  BZ - Belize<br />  BJ - Benin<br />  BM - Bermuda<br />  BT - Bhutan<br />  BY - Belarus<br />  BO - Bolivia<br />  BQ - Bonaire<br />  BA - BosniaAndHerzegovina<br />  BW - Botswana<br />  BR - Brazil<br />  BN - BruneiDarussalam<br />  IO - BritishIndianOceanTerritory<br />  VG - VirginIslands<br />  BG - Bulgaria<br />  BF - BurkinaFaso<br />  BI - Burundi<br />  CL - Chile<br />  CN - China<br />  HR - Croatia<br />  CW - Curacao<br />  CY - Cyprus<br />  TD - Chad<br />  ME - Montenegro<br />  CZ - CzechRepublic<br />  UM - UnitedStatesMinorOutlyingIslands<br />  DK - Denmark<br />  CD - CongoDemocraticRepublic<br />  DM - Dominica<br />  DO - DominicanRepublic<br />  DJ - Djibouti<br />  EG - Egypt<br />  EC - Ecuador<br />  ER - Eritrea<br />  EE - Estonia<br />  ET - Ethiopia<br />  FK - FalklandIslands<br />  FJ - Fiji<br />  PH - Philippines<br />  FI - Finland<br />  FR - France<br />  TF - FrenchSouthernTerritories<br />  GA - Gabon<br />  GM - Gambia<br />  GS - SouthGeorgiaAndSouthSandwichIslands<br />  GH - Ghana<br />  GI - Gibraltar<br />  GR - Greece<br />  GD - Grenada<br />  GL - Greenland<br />  GE - Georgia<br />  GU - Guam<br />  GG - Guernsey<br />  GF - FrenchGuiana<br />  GY - Guyana<br />  GP - Guadeloupe<br />  GT - Guatemala<br />  GW - GuineaBissau<br />  GQ - EquatorialGuinea<br />  GN - Guinea<br />  HT - Haiti<br />  ES - Spain<br />  NL - Netherlands<br />  HN - Honduras<br />  HK - HongKong<br />  IN - India<br />  ID - Indonesia<br />  IQ - Iraq<br />  IR - Iran<br />  IE - Ireland<br />  IS - Iceland<br />  IL - Israel<br />  JM - Jamaica<br />  JP - Japan<br />  YE - Yemen<br />  JE - Jersey<br />  JO - Jordan<br />  KY - CaymanIslands<br />  KH - Cambodia<br />  CM - Cameroon<br />  CA - Canada<br />  QA - Qatar<br />  KZ - Kazakhstan<br />  KE - Kenya<br />  KG - Kyrgyzstan<br />  KI - Kiribati<br />  CO - Colombia<br />  KM - Comoros<br />  CG - Congo<br />  KR - SouthKorea<br />  KP - NorthKorea<br />  CR - CostaRica<br />  CU - Cuba<br />  KW - Kuwait<br />  LA - Laos<br />  LS - Lesotho<br />  LB - Lebanon<br />  LR - Liberia<br />  LY - Libya<br />  LI - Liechtenstein<br />  LT - Lithuania<br />  LU - Luxembourg<br />  LV - Latvia<br />  MK - Macedonia<br />  MG - Madagascar<br />  YT - Mayotte<br />  MO - Macao<br />  MW - Malawi<br />  MV - Maldives<br />  MY - Malaysia<br />  ML - Mali<br />  MT - Malta<br />  MP - NorthernMarianaIslands<br />  MA - Morocco<br />  MQ - Martinique<br />  MR - Mauritania<br />  MU - Mauritius<br />  MX - Mexico<br />  FM - Micronesia<br />  MM - Myanmar<br />  MD - Moldova<br />  MC - Monaco<br />  MN - Mongolia<br />  MS - Montserrat<br />  MZ - Mozambique<br />  NA - Namibia<br />  NR - Nauru<br />  NP - Nepal<br />  DE - Germany<br />  NE - Niger<br />  NG - Nigeria<br />  NI - Nicaragua<br />  NU - Niue<br />  NF - NorfolkIsland<br />  NO - Norway<br />  NC - NewCaledonia<br />  NZ - NewZealand<br />  OM - Oman<br />  PK - Pakistan<br />  PW - Palau<br />  PS - Palestine<br />  PA - Panama<br />  PG - PapuaNewGuinea<br />  PY - Paraguay<br />  PE - Peru<br />  PN - Pitcairn<br />  PF - FrenchPolynesia<br />  PL - Poland<br />  PR - PuertoRico<br />  PT - Portugal<br />  ZA - SouthAfrica<br />  CF - CentralAfricanRepublic<br />  CV - CapeVerde<br />  RE - Reunion<br />  RU - Russia<br />  RO - Romania<br />  RW - Rwanda<br />  EH - WesternSahara<br />  KN - SaintKittsAndNevis<br />  LC - SaintLucia<br />  VC - SaintVincentAndGrenadines<br />  BL - SaintBarthelemy<br />  MF - SaintMartin<br />  PM - SaintPierreAndMiquelon<br />  SV - ElSalvador<br />  AS - AmericanSamoa<br />  WS - Samoa<br />  SM - SanMarino<br />  SN - Senegal<br />  RS - Serbia<br />  SC - Seychelles<br />  SL - SierraLeone<br />  SG - Singapore<br />  SX - SintMaarten<br />  SK - Slovakia<br />  SI - Slovenia<br />  SO - Somalia<br />  LK - SriLanka<br />  US - UnitedStates<br />  SZ - Swaziland<br />  SD - Sudan<br />  SS - SouthSudan<br />  SR - Suriname<br />  SJ - SvalbardAndJanMayen<br />  SY - Syria<br />  CH - Switzerland<br />  SE - Sweden<br />  TJ - Tajikistan<br />  TH - Thailand<br />  TW - Taiwan<br />  TZ - Tanzania<br />  TL - Timor<br />  TG - Togo<br />  TK - Tokelau<br />  TO - Tonga<br />  TT - TrinidadAndTobago<br />  TN - Tunisia<br />  TR - Turkey<br />  TM - Turkmenistan<br />  TC - TurksAndCaicosIslands<br />  TV - Tuvalu<br />  UG - Uganda<br />  UA - Ukraine<br />  UY - Uruguay<br />  UZ - Uzbekistan<br />  VU - Vanuatu<br />  WF - WallisAndFutuna<br />  VA - HolySee<br />  VE - Venezuela<br />  HU - Hungary<br />  GB - UnitedKingdom<br />  VN - VietNam<br />  IT - Italy<br />  CI - IvoryCoast<br />  BV - BouvetIsland<br />  CX - ChristmasIsland<br />  IM - IsleOfMan<br />  SH - SaintHelenaAscensionTristanCunha<br />  AX - AlandIslands<br />  CK - CookIslands<br />  VI - VirginIslandsUS<br />  HM - HeardAndMcDonaldIslands<br />  CC - CocosIslands<br />  MH - MarshallIslands<br />  FO - FaroeIslands<br />  SB - SolomonIslands<br />  ST - SaoTomeAndPrincipe<br />  ZM - Zambia<br />  ZW - Zimbabwe<br />  AE - UnitedArabEmirates",
      "type": "string"
    },
    "selectedConsentIds": {
      "description": "Member consents",
      "type": "array",
      "items": {
        "format": "int32",
        "type": "integer"
      }
    },
    "companyInvoiceData": {
      "type": "object",
      "properties": {
        "companyName": {
          "description": "Company name",
          "type": "string"
        },
        "companyCity": {
          "description": "City of company residence",
          "type": "string"
        },
        "companyCounty": {
          "description": "County of company residence",
          "type": "string"
        },
        "companyPostalCode": {
          "description": "Postal code of company residence",
          "type": "string"
        },
        "companyStreet": {
          "description": "Street of company residence",
          "type": "string"
        },
        "companyStreetAdditionalInfo": {
          "description": "Street additional info of company residence",
          "type": "string"
        },
        "companyTaxIdentificationNumber": {
          "description": "Company tax identification number",
          "type": "string"
        }
      }
    },
    "password": {
      "description": "Password",
      "type": "string"
    },
    "memberTitle": {
      "format": "int32",
      "description": "Title of member which will be using in correspondence: <br />  0 - Mrs<br />  1 - Mr",
      "type": "integer"
    },
    "bankAccountOwnerName": {
      "description": "Bank account owner",
      "type": "string"
    },
    "confirmationUrl": {
      "description": "Url for confirmation email link (optional)",
      "type": "string"
    }
  }
}

description: >-
  The required fields are set here:
  https://{eFitness-backend-url}/Configuration/MemberProfileRegistration
required:
  - firstName
  - lastName
type: object
properties:
  firstName:
    description: Firstname of new member
    type: string
  lastName:
    description: Lastname of new member
    type: string
  personalIdentityNumber:
    description: Personal Identity Number
    type: string
  email:
    description: Email of new member
    type: string
  confirmationEmail:
    description: Confirmation email of new member
    type: string
  street:
    description: Street of residence
    type: string
  streetAdditionalInfo:
    description: Street additional info of residence
    type: string
  flatNumber:
    description: Flat number of residence
    type: string
  postalCode:
    description: Postal code of residence
    type: string
  city:
    description: City of residence
    type: string
  county:
    description: County of residence
    type: string
  carRegistrationNumber:
    description: Car registration number
    type: string
  landlinePhoneNumber:
    description: Landline phone number
    type: string
  countryLandlinePhoneCode:
    description: Country landline phone code
    type: string
  cellPhone:
    description: Cell phone number
    type: string
  countryPhoneCode:
    description: Country phone
    type: string
  identityDocumentType:
    format: int32
    description: >-
      Name of the document confirming member identity: <br />  0 -
      ID<br />  1 - Passport<br />  2 -
      DriversLicense<br />  3 - RefugeePermit<br />  4 -
      ResidencePermit
    type: integer
  identityDocumentNumber:
    description: Number of the document confirming member identity
    type: string
  gender:
    format: int32
    description: >-
      Gender: <br />  0 - woman<br />  1 - man<br />  2
      - other
    type: integer
  birthday:
    format: date-time
    description: 'Birthday date (yyyy-MM-dd HH:mm:ss)'
    type: string
  bankName:
    description: Name of the bank supporting the payment
    type: string
  iban:
    description: International bank account number IBAN
    type: string
  bic:
    description: International code identifying the financial institution BIC
    type: string
  taxIdentificationNumber:
    description: Tax number
    type: string
  isForeign:
    description: Is member foreigner
    type: boolean
  memberSource:
    format: int32
    description: >-
      ID of the club member's knowledge about the club, can be obtained at
      '~/api/clubs/{clubId}/member-sources'
    type: integer
  countryOfResidence:
    description: >-
      Country of residence: <br />  AF - Afghanistan<br />  AL -
      Albania<br />  DZ - Algeria<br />  AD -
      Andorra<br />  AO - Angola<br />  AI -
      Anguilla<br />  AQ - Antarctica<br />  AG -
      AntiguaAndBarbuda<br />  SA - SaudiArabia<br />  AR -
      Argentina<br />  AM - Armenia<br />  AW -
      Aruba<br />  AU - Australia<br />  AT -
      Austria<br />  AZ - Azerbaijan<br />  BS -
      Bahamas<br />  BH - Bahrain<br />  BD -
      Bangladesh<br />  BB - Barbados<br />  BE -
      Belgium<br />  BZ - Belize<br />  BJ -
      Benin<br />  BM - Bermuda<br />  BT -
      Bhutan<br />  BY - Belarus<br />  BO -
      Bolivia<br />  BQ - Bonaire<br />  BA -
      BosniaAndHerzegovina<br />  BW - Botswana<br />  BR -
      Brazil<br />  BN - BruneiDarussalam<br />  IO -
      BritishIndianOceanTerritory<br />  VG -
      VirginIslands<br />  BG - Bulgaria<br />  BF -
      BurkinaFaso<br />  BI - Burundi<br />  CL -
      Chile<br />  CN - China<br />  HR -
      Croatia<br />  CW - Curacao<br />  CY -
      Cyprus<br />  TD - Chad<br />  ME -
      Montenegro<br />  CZ - CzechRepublic<br />  UM -
      UnitedStatesMinorOutlyingIslands<br />  DK -
      Denmark<br />  CD - CongoDemocraticRepublic<br />  DM -
      Dominica<br />  DO - DominicanRepublic<br />  DJ -
      Djibouti<br />  EG - Egypt<br />  EC -
      Ecuador<br />  ER - Eritrea<br />  EE -
      Estonia<br />  ET - Ethiopia<br />  FK -
      FalklandIslands<br />  FJ - Fiji<br />  PH -
      Philippines<br />  FI - Finland<br />  FR -
      France<br />  TF - FrenchSouthernTerritories<br />  GA -
      Gabon<br />  GM - Gambia<br />  GS -
      SouthGeorgiaAndSouthSandwichIslands<br />  GH -
      Ghana<br />  GI - Gibraltar<br />  GR -
      Greece<br />  GD - Grenada<br />  GL -
      Greenland<br />  GE - Georgia<br />  GU -
      Guam<br />  GG - Guernsey<br />  GF -
      FrenchGuiana<br />  GY - Guyana<br />  GP -
      Guadeloupe<br />  GT - Guatemala<br />  GW -
      GuineaBissau<br />  GQ - EquatorialGuinea<br />  GN -
      Guinea<br />  HT - Haiti<br />  ES -
      Spain<br />  NL - Netherlands<br />  HN -
      Honduras<br />  HK - HongKong<br />  IN -
      India<br />  ID - Indonesia<br />  IQ -
      Iraq<br />  IR - Iran<br />  IE -
      Ireland<br />  IS - Iceland<br />  IL -
      Israel<br />  JM - Jamaica<br />  JP -
      Japan<br />  YE - Yemen<br />  JE -
      Jersey<br />  JO - Jordan<br />  KY -
      CaymanIslands<br />  KH - Cambodia<br />  CM -
      Cameroon<br />  CA - Canada<br />  QA -
      Qatar<br />  KZ - Kazakhstan<br />  KE -
      Kenya<br />  KG - Kyrgyzstan<br />  KI -
      Kiribati<br />  CO - Colombia<br />  KM -
      Comoros<br />  CG - Congo<br />  KR -
      SouthKorea<br />  KP - NorthKorea<br />  CR -
      CostaRica<br />  CU - Cuba<br />  KW -
      Kuwait<br />  LA - Laos<br />  LS -
      Lesotho<br />  LB - Lebanon<br />  LR -
      Liberia<br />  LY - Libya<br />  LI -
      Liechtenstein<br />  LT - Lithuania<br />  LU -
      Luxembourg<br />  LV - Latvia<br />  MK -
      Macedonia<br />  MG - Madagascar<br />  YT -
      Mayotte<br />  MO - Macao<br />  MW -
      Malawi<br />  MV - Maldives<br />  MY -
      Malaysia<br />  ML - Mali<br />  MT -
      Malta<br />  MP - NorthernMarianaIslands<br />  MA -
      Morocco<br />  MQ - Martinique<br />  MR -
      Mauritania<br />  MU - Mauritius<br />  MX -
      Mexico<br />  FM - Micronesia<br />  MM -
      Myanmar<br />  MD - Moldova<br />  MC -
      Monaco<br />  MN - Mongolia<br />  MS -
      Montserrat<br />  MZ - Mozambique<br />  NA -
      Namibia<br />  NR - Nauru<br />  NP -
      Nepal<br />  DE - Germany<br />  NE -
      Niger<br />  NG - Nigeria<br />  NI -
      Nicaragua<br />  NU - Niue<br />  NF -
      NorfolkIsland<br />  NO - Norway<br />  NC -
      NewCaledonia<br />  NZ - NewZealand<br />  OM -
      Oman<br />  PK - Pakistan<br />  PW -
      Palau<br />  PS - Palestine<br />  PA -
      Panama<br />  PG - PapuaNewGuinea<br />  PY -
      Paraguay<br />  PE - Peru<br />  PN -
      Pitcairn<br />  PF - FrenchPolynesia<br />  PL -
      Poland<br />  PR - PuertoRico<br />  PT -
      Portugal<br />  ZA - SouthAfrica<br />  CF -
      CentralAfricanRepublic<br />  CV - CapeVerde<br />  RE -
      Reunion<br />  RU - Russia<br />  RO -
      Romania<br />  RW - Rwanda<br />  EH -
      WesternSahara<br />  KN - SaintKittsAndNevis<br />  LC -
      SaintLucia<br />  VC - SaintVincentAndGrenadines<br />  BL
      - SaintBarthelemy<br />  MF - SaintMartin<br />  PM -
      SaintPierreAndMiquelon<br />  SV - ElSalvador<br />  AS -
      AmericanSamoa<br />  WS - Samoa<br />  SM -
      SanMarino<br />  SN - Senegal<br />  RS -
      Serbia<br />  SC - Seychelles<br />  SL -
      SierraLeone<br />  SG - Singapore<br />  SX -
      SintMaarten<br />  SK - Slovakia<br />  SI -
      Slovenia<br />  SO - Somalia<br />  LK -
      SriLanka<br />  US - UnitedStates<br />  SZ -
      Swaziland<br />  SD - Sudan<br />  SS -
      SouthSudan<br />  SR - Suriname<br />  SJ -
      SvalbardAndJanMayen<br />  SY - Syria<br />  CH -
      Switzerland<br />  SE - Sweden<br />  TJ -
      Tajikistan<br />  TH - Thailand<br />  TW -
      Taiwan<br />  TZ - Tanzania<br />  TL -
      Timor<br />  TG - Togo<br />  TK -
      Tokelau<br />  TO - Tonga<br />  TT -
      TrinidadAndTobago<br />  TN - Tunisia<br />  TR -
      Turkey<br />  TM - Turkmenistan<br />  TC -
      TurksAndCaicosIslands<br />  TV - Tuvalu<br />  UG -
      Uganda<br />  UA - Ukraine<br />  UY -
      Uruguay<br />  UZ - Uzbekistan<br />  VU -
      Vanuatu<br />  WF - WallisAndFutuna<br />  VA -
      HolySee<br />  VE - Venezuela<br />  HU -
      Hungary<br />  GB - UnitedKingdom<br />  VN -
      VietNam<br />  IT - Italy<br />  CI -
      IvoryCoast<br />  BV - BouvetIsland<br />  CX -
      ChristmasIsland<br />  IM - IsleOfMan<br />  SH -
      SaintHelenaAscensionTristanCunha<br />  AX -
      AlandIslands<br />  CK - CookIslands<br />  VI -
      VirginIslandsUS<br />  HM -
      HeardAndMcDonaldIslands<br />  CC - CocosIslands<br />  MH
      - MarshallIslands<br />  FO - FaroeIslands<br />  SB -
      SolomonIslands<br />  ST - SaoTomeAndPrincipe<br />  ZM -
      Zambia<br />  ZW - Zimbabwe<br />  AE - UnitedArabEmirates
    type: string
  selectedConsentIds:
    description: Member consents
    type: array
    items:
      format: int32
      type: integer
  companyInvoiceData:
    type: object
    properties:
      companyName:
        description: Company name
        type: string
      companyCity:
        description: City of company residence
        type: string
      companyCounty:
        description: County of company residence
        type: string
      companyPostalCode:
        description: Postal code of company residence
        type: string
      companyStreet:
        description: Street of company residence
        type: string
      companyStreetAdditionalInfo:
        description: Street additional info of company residence
        type: string
      companyTaxIdentificationNumber:
        description: Company tax identification number
        type: string
  password:
    description: Password
    type: string
  memberTitle:
    format: int32
    description: >-
      Title of member which will be using in correspondence: <br />  0 -
      Mrs<br />  1 - Mr
    type: integer
  bankAccountOwnerName:
    description: Bank account owner
    type: string
  confirmationUrl:
    description: Url for confirmation email link (optional)
    type: string


<?xml version="1.0" encoding="UTF-8" ?>
<AddMemberRequest>
  <description>The required fields are set here: https://{eFitness-backend-url}/Configuration/MemberProfileRegistration</description>
  <required>firstName</required>
  <required>lastName</required>
  <type>object</type>
  <properties>
    <firstName>
      <description>Firstname of new member</description>
      <type>string</type>
    </firstName>
    <lastName>
      <description>Lastname of new member</description>
      <type>string</type>
    </lastName>
    <personalIdentityNumber>
      <description>Personal Identity Number</description>
      <type>string</type>
    </personalIdentityNumber>
    <email>
      <description>Email of new member</description>
      <type>string</type>
    </email>
    <confirmationEmail>
      <description>Confirmation email of new member</description>
      <type>string</type>
    </confirmationEmail>
    <street>
      <description>Street of residence</description>
      <type>string</type>
    </street>
    <streetAdditionalInfo>
      <description>Street additional info of residence</description>
      <type>string</type>
    </streetAdditionalInfo>
    <flatNumber>
      <description>Flat number of residence</description>
      <type>string</type>
    </flatNumber>
    <postalCode>
      <description>Postal code of residence</description>
      <type>string</type>
    </postalCode>
    <city>
      <description>City of residence</description>
      <type>string</type>
    </city>
    <county>
      <description>County of residence</description>
      <type>string</type>
    </county>
    <carRegistrationNumber>
      <description>Car registration number</description>
      <type>string</type>
    </carRegistrationNumber>
    <landlinePhoneNumber>
      <description>Landline phone number</description>
      <type>string</type>
    </landlinePhoneNumber>
    <countryLandlinePhoneCode>
      <description>Country landline phone code</description>
      <type>string</type>
    </countryLandlinePhoneCode>
    <cellPhone>
      <description>Cell phone number</description>
      <type>string</type>
    </cellPhone>
    <countryPhoneCode>
      <description>Country phone</description>
      <type>string</type>
    </countryPhoneCode>
    <identityDocumentType>
      <format>int32</format>
      <description>Name of the document confirming member identity: <br>&nbsp;&nbsp;0 - ID<br>&nbsp;&nbsp;1 - Passport<br>&nbsp;&nbsp;2 - DriversLicense<br>&nbsp;&nbsp;3 - RefugeePermit<br>&nbsp;&nbsp;4 - ResidencePermit</description>
      <type>integer</type>
    </identityDocumentType>
    <identityDocumentNumber>
      <description>Number of the document confirming member identity</description>
      <type>string</type>
    </identityDocumentNumber>
    <gender>
      <format>int32</format>
      <description>Gender: <br>&nbsp;&nbsp;0 - woman<br>&nbsp;&nbsp;1 - man<br>&nbsp;&nbsp;2 - other</description>
      <type>integer</type>
    </gender>
    <birthday>
      <format>date-time</format>
      <description>Birthday date (yyyy-MM-dd HH:mm:ss)</description>
      <type>string</type>
    </birthday>
    <bankName>
      <description>Name of the bank supporting the payment</description>
      <type>string</type>
    </bankName>
    <iban>
      <description>International bank account number IBAN</description>
      <type>string</type>
    </iban>
    <bic>
      <description>International code identifying the financial institution BIC</description>
      <type>string</type>
    </bic>
    <taxIdentificationNumber>
      <description>Tax number</description>
      <type>string</type>
    </taxIdentificationNumber>
    <isForeign>
      <description>Is member foreigner</description>
      <type>boolean</type>
    </isForeign>
    <memberSource>
      <format>int32</format>
      <description>ID of the club member&apos;s knowledge about the club, can be obtained at &apos;~/api/clubs/{clubId}/member-sources&apos;</description>
      <type>integer</type>
    </memberSource>
    <countryOfResidence>
      <description>Country of residence: <br>&nbsp;&nbsp;AF - Afghanistan<br>&nbsp;&nbsp;AL - Albania<br>&nbsp;&nbsp;DZ - Algeria<br>&nbsp;&nbsp;AD - Andorra<br>&nbsp;&nbsp;AO - Angola<br>&nbsp;&nbsp;AI - Anguilla<br>&nbsp;&nbsp;AQ - Antarctica<br>&nbsp;&nbsp;AG - AntiguaAndBarbuda<br>&nbsp;&nbsp;SA - SaudiArabia<br>&nbsp;&nbsp;AR - Argentina<br>&nbsp;&nbsp;AM - Armenia<br>&nbsp;&nbsp;AW - Aruba<br>&nbsp;&nbsp;AU - Australia<br>&nbsp;&nbsp;AT - Austria<br>&nbsp;&nbsp;AZ - Azerbaijan<br>&nbsp;&nbsp;BS - Bahamas<br>&nbsp;&nbsp;BH - Bahrain<br>&nbsp;&nbsp;BD - Bangladesh<br>&nbsp;&nbsp;BB - Barbados<br>&nbsp;&nbsp;BE - Belgium<br>&nbsp;&nbsp;BZ - Belize<br>&nbsp;&nbsp;BJ - Benin<br>&nbsp;&nbsp;BM - Bermuda<br>&nbsp;&nbsp;BT - Bhutan<br>&nbsp;&nbsp;BY - Belarus<br>&nbsp;&nbsp;BO - Bolivia<br>&nbsp;&nbsp;BQ - Bonaire<br>&nbsp;&nbsp;BA - BosniaAndHerzegovina<br>&nbsp;&nbsp;BW - Botswana<br>&nbsp;&nbsp;BR - Brazil<br>&nbsp;&nbsp;BN - BruneiDarussalam<br>&nbsp;&nbsp;IO - BritishIndianOceanTerritory<br>&nbsp;&nbsp;VG - VirginIslands<br>&nbsp;&nbsp;BG - Bulgaria<br>&nbsp;&nbsp;BF - BurkinaFaso<br>&nbsp;&nbsp;BI - Burundi<br>&nbsp;&nbsp;CL - Chile<br>&nbsp;&nbsp;CN - China<br>&nbsp;&nbsp;HR - Croatia<br>&nbsp;&nbsp;CW - Curacao<br>&nbsp;&nbsp;CY - Cyprus<br>&nbsp;&nbsp;TD - Chad<br>&nbsp;&nbsp;ME - Montenegro<br>&nbsp;&nbsp;CZ - CzechRepublic<br>&nbsp;&nbsp;UM - UnitedStatesMinorOutlyingIslands<br>&nbsp;&nbsp;DK - Denmark<br>&nbsp;&nbsp;CD - CongoDemocraticRepublic<br>&nbsp;&nbsp;DM - Dominica<br>&nbsp;&nbsp;DO - DominicanRepublic<br>&nbsp;&nbsp;DJ - Djibouti<br>&nbsp;&nbsp;EG - Egypt<br>&nbsp;&nbsp;EC - Ecuador<br>&nbsp;&nbsp;ER - Eritrea<br>&nbsp;&nbsp;EE - Estonia<br>&nbsp;&nbsp;ET - Ethiopia<br>&nbsp;&nbsp;FK - FalklandIslands<br>&nbsp;&nbsp;FJ - Fiji<br>&nbsp;&nbsp;PH - Philippines<br>&nbsp;&nbsp;FI - Finland<br>&nbsp;&nbsp;FR - France<br>&nbsp;&nbsp;TF - FrenchSouthernTerritories<br>&nbsp;&nbsp;GA - Gabon<br>&nbsp;&nbsp;GM - Gambia<br>&nbsp;&nbsp;GS - SouthGeorgiaAndSouthSandwichIslands<br>&nbsp;&nbsp;GH - Ghana<br>&nbsp;&nbsp;GI - Gibraltar<br>&nbsp;&nbsp;GR - Greece<br>&nbsp;&nbsp;GD - Grenada<br>&nbsp;&nbsp;GL - Greenland<br>&nbsp;&nbsp;GE - Georgia<br>&nbsp;&nbsp;GU - Guam<br>&nbsp;&nbsp;GG - Guernsey<br>&nbsp;&nbsp;GF - FrenchGuiana<br>&nbsp;&nbsp;GY - Guyana<br>&nbsp;&nbsp;GP - Guadeloupe<br>&nbsp;&nbsp;GT - Guatemala<br>&nbsp;&nbsp;GW - GuineaBissau<br>&nbsp;&nbsp;GQ - EquatorialGuinea<br>&nbsp;&nbsp;GN - Guinea<br>&nbsp;&nbsp;HT - Haiti<br>&nbsp;&nbsp;ES - Spain<br>&nbsp;&nbsp;NL - Netherlands<br>&nbsp;&nbsp;HN - Honduras<br>&nbsp;&nbsp;HK - HongKong<br>&nbsp;&nbsp;IN - India<br>&nbsp;&nbsp;ID - Indonesia<br>&nbsp;&nbsp;IQ - Iraq<br>&nbsp;&nbsp;IR - Iran<br>&nbsp;&nbsp;IE - Ireland<br>&nbsp;&nbsp;IS - Iceland<br>&nbsp;&nbsp;IL - Israel<br>&nbsp;&nbsp;JM - Jamaica<br>&nbsp;&nbsp;JP - Japan<br>&nbsp;&nbsp;YE - Yemen<br>&nbsp;&nbsp;JE - Jersey<br>&nbsp;&nbsp;JO - Jordan<br>&nbsp;&nbsp;KY - CaymanIslands<br>&nbsp;&nbsp;KH - Cambodia<br>&nbsp;&nbsp;CM - Cameroon<br>&nbsp;&nbsp;CA - Canada<br>&nbsp;&nbsp;QA - Qatar<br>&nbsp;&nbsp;KZ - Kazakhstan<br>&nbsp;&nbsp;KE - Kenya<br>&nbsp;&nbsp;KG - Kyrgyzstan<br>&nbsp;&nbsp;KI - Kiribati<br>&nbsp;&nbsp;CO - Colombia<br>&nbsp;&nbsp;KM - Comoros<br>&nbsp;&nbsp;CG - Congo<br>&nbsp;&nbsp;KR - SouthKorea<br>&nbsp;&nbsp;KP - NorthKorea<br>&nbsp;&nbsp;CR - CostaRica<br>&nbsp;&nbsp;CU - Cuba<br>&nbsp;&nbsp;KW - Kuwait<br>&nbsp;&nbsp;LA - Laos<br>&nbsp;&nbsp;LS - Lesotho<br>&nbsp;&nbsp;LB - Lebanon<br>&nbsp;&nbsp;LR - Liberia<br>&nbsp;&nbsp;LY - Libya<br>&nbsp;&nbsp;LI - Liechtenstein<br>&nbsp;&nbsp;LT - Lithuania<br>&nbsp;&nbsp;LU - Luxembourg<br>&nbsp;&nbsp;LV - Latvia<br>&nbsp;&nbsp;MK - Macedonia<br>&nbsp;&nbsp;MG - Madagascar<br>&nbsp;&nbsp;YT - Mayotte<br>&nbsp;&nbsp;MO - Macao<br>&nbsp;&nbsp;MW - Malawi<br>&nbsp;&nbsp;MV - Maldives<br>&nbsp;&nbsp;MY - Malaysia<br>&nbsp;&nbsp;ML - Mali<br>&nbsp;&nbsp;MT - Malta<br>&nbsp;&nbsp;MP - NorthernMarianaIslands<br>&nbsp;&nbsp;MA - Morocco<br>&nbsp;&nbsp;MQ - Martinique<br>&nbsp;&nbsp;MR - Mauritania<br>&nbsp;&nbsp;MU - Mauritius<br>&nbsp;&nbsp;MX - Mexico<br>&nbsp;&nbsp;FM - Micronesia<br>&nbsp;&nbsp;MM - Myanmar<br>&nbsp;&nbsp;MD - Moldova<br>&nbsp;&nbsp;MC - Monaco<br>&nbsp;&nbsp;MN - Mongolia<br>&nbsp;&nbsp;MS - Montserrat<br>&nbsp;&nbsp;MZ - Mozambique<br>&nbsp;&nbsp;NA - Namibia<br>&nbsp;&nbsp;NR - Nauru<br>&nbsp;&nbsp;NP - Nepal<br>&nbsp;&nbsp;DE - Germany<br>&nbsp;&nbsp;NE - Niger<br>&nbsp;&nbsp;NG - Nigeria<br>&nbsp;&nbsp;NI - Nicaragua<br>&nbsp;&nbsp;NU - Niue<br>&nbsp;&nbsp;NF - NorfolkIsland<br>&nbsp;&nbsp;NO - Norway<br>&nbsp;&nbsp;NC - NewCaledonia<br>&nbsp;&nbsp;NZ - NewZealand<br>&nbsp;&nbsp;OM - Oman<br>&nbsp;&nbsp;PK - Pakistan<br>&nbsp;&nbsp;PW - Palau<br>&nbsp;&nbsp;PS - Palestine<br>&nbsp;&nbsp;PA - Panama<br>&nbsp;&nbsp;PG - PapuaNewGuinea<br>&nbsp;&nbsp;PY - Paraguay<br>&nbsp;&nbsp;PE - Peru<br>&nbsp;&nbsp;PN - Pitcairn<br>&nbsp;&nbsp;PF - FrenchPolynesia<br>&nbsp;&nbsp;PL - Poland<br>&nbsp;&nbsp;PR - PuertoRico<br>&nbsp;&nbsp;PT - Portugal<br>&nbsp;&nbsp;ZA - SouthAfrica<br>&nbsp;&nbsp;CF - CentralAfricanRepublic<br>&nbsp;&nbsp;CV - CapeVerde<br>&nbsp;&nbsp;RE - Reunion<br>&nbsp;&nbsp;RU - Russia<br>&nbsp;&nbsp;RO - Romania<br>&nbsp;&nbsp;RW - Rwanda<br>&nbsp;&nbsp;EH - WesternSahara<br>&nbsp;&nbsp;KN - SaintKittsAndNevis<br>&nbsp;&nbsp;LC - SaintLucia<br>&nbsp;&nbsp;VC - SaintVincentAndGrenadines<br>&nbsp;&nbsp;BL - SaintBarthelemy<br>&nbsp;&nbsp;MF - SaintMartin<br>&nbsp;&nbsp;PM - SaintPierreAndMiquelon<br>&nbsp;&nbsp;SV - ElSalvador<br>&nbsp;&nbsp;AS - AmericanSamoa<br>&nbsp;&nbsp;WS - Samoa<br>&nbsp;&nbsp;SM - SanMarino<br>&nbsp;&nbsp;SN - Senegal<br>&nbsp;&nbsp;RS - Serbia<br>&nbsp;&nbsp;SC - Seychelles<br>&nbsp;&nbsp;SL - SierraLeone<br>&nbsp;&nbsp;SG - Singapore<br>&nbsp;&nbsp;SX - SintMaarten<br>&nbsp;&nbsp;SK - Slovakia<br>&nbsp;&nbsp;SI - Slovenia<br>&nbsp;&nbsp;SO - Somalia<br>&nbsp;&nbsp;LK - SriLanka<br>&nbsp;&nbsp;US - UnitedStates<br>&nbsp;&nbsp;SZ - Swaziland<br>&nbsp;&nbsp;SD - Sudan<br>&nbsp;&nbsp;SS - SouthSudan<br>&nbsp;&nbsp;SR - Suriname<br>&nbsp;&nbsp;SJ - SvalbardAndJanMayen<br>&nbsp;&nbsp;SY - Syria<br>&nbsp;&nbsp;CH - Switzerland<br>&nbsp;&nbsp;SE - Sweden<br>&nbsp;&nbsp;TJ - Tajikistan<br>&nbsp;&nbsp;TH - Thailand<br>&nbsp;&nbsp;TW - Taiwan<br>&nbsp;&nbsp;TZ - Tanzania<br>&nbsp;&nbsp;TL - Timor<br>&nbsp;&nbsp;TG - Togo<br>&nbsp;&nbsp;TK - Tokelau<br>&nbsp;&nbsp;TO - Tonga<br>&nbsp;&nbsp;TT - TrinidadAndTobago<br>&nbsp;&nbsp;TN - Tunisia<br>&nbsp;&nbsp;TR - Turkey<br>&nbsp;&nbsp;TM - Turkmenistan<br>&nbsp;&nbsp;TC - TurksAndCaicosIslands<br>&nbsp;&nbsp;TV - Tuvalu<br>&nbsp;&nbsp;UG - Uganda<br>&nbsp;&nbsp;UA - Ukraine<br>&nbsp;&nbsp;UY - Uruguay<br>&nbsp;&nbsp;UZ - Uzbekistan<br>&nbsp;&nbsp;VU - Vanuatu<br>&nbsp;&nbsp;WF - WallisAndFutuna<br>&nbsp;&nbsp;VA - HolySee<br>&nbsp;&nbsp;VE - Venezuela<br>&nbsp;&nbsp;HU - Hungary<br>&nbsp;&nbsp;GB - UnitedKingdom<br>&nbsp;&nbsp;VN - VietNam<br>&nbsp;&nbsp;IT - Italy<br>&nbsp;&nbsp;CI - IvoryCoast<br>&nbsp;&nbsp;BV - BouvetIsland<br>&nbsp;&nbsp;CX - ChristmasIsland<br>&nbsp;&nbsp;IM - IsleOfMan<br>&nbsp;&nbsp;SH - SaintHelenaAscensionTristanCunha<br>&nbsp;&nbsp;AX - AlandIslands<br>&nbsp;&nbsp;CK - CookIslands<br>&nbsp;&nbsp;VI - VirginIslandsUS<br>&nbsp;&nbsp;HM - HeardAndMcDonaldIslands<br>&nbsp;&nbsp;CC - CocosIslands<br>&nbsp;&nbsp;MH - MarshallIslands<br>&nbsp;&nbsp;FO - FaroeIslands<br>&nbsp;&nbsp;SB - SolomonIslands<br>&nbsp;&nbsp;ST - SaoTomeAndPrincipe<br>&nbsp;&nbsp;ZM - Zambia<br>&nbsp;&nbsp;ZW - Zimbabwe<br>&nbsp;&nbsp;AE - UnitedArabEmirates</description>
      <type>string</type>
    </countryOfResidence>
    <selectedConsentIds>
      <description>Member consents</description>
      <type>array</type>
      <items>
        <format>int32</format>
        <type>integer</type>
      </items>
    </selectedConsentIds>
    <companyInvoiceData>
      <type>object</type>
      <properties>
        <companyName>
          <description>Company name</description>
          <type>string</type>
        </companyName>
        <companyCity>
          <description>City of company residence</description>
          <type>string</type>
        </companyCity>
        <companyCounty>
          <description>County of company residence</description>
          <type>string</type>
        </companyCounty>
        <companyPostalCode>
          <description>Postal code of company residence</description>
          <type>string</type>
        </companyPostalCode>
        <companyStreet>
          <description>Street of company residence</description>
          <type>string</type>
        </companyStreet>
        <companyStreetAdditionalInfo>
          <description>Street additional info of company residence</description>
          <type>string</type>
        </companyStreetAdditionalInfo>
        <companyTaxIdentificationNumber>
          <description>Company tax identification number</description>
          <type>string</type>
        </companyTaxIdentificationNumber>
      </properties>
    </companyInvoiceData>
    <password>
      <description>Password</description>
      <type>string</type>
    </password>
    <memberTitle>
      <format>int32</format>
      <description>Title of member which will be using in correspondence: <br>&nbsp;&nbsp;0 - Mrs<br>&nbsp;&nbsp;1 - Mr</description>
      <type>integer</type>
    </memberTitle>
    <bankAccountOwnerName>
      <description>Bank account owner</description>
      <type>string</type>
    </bankAccountOwnerName>
    <confirmationUrl>
      <description>Url for confirmation email link (optional)</description>
      <type>string</type>
    </confirmationUrl>
  </properties>
</AddMemberRequest>

Parameters

Name In Type Required Description
clubId path string true none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.
body body AddMemberRequest true Model request

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "memberId": {
      "format": "int32",
      "description": "Id of added member",
      "type": "integer"
    },
    "authorizationData": {
      "type": "object",
      "properties": {
        "accessToken": {
          "description": "String of characters that provides encrypted information about the assigned access to API",
          "type": "string"
        },
        "tokenType": {
          "description": "String of characters that provides encrypted information about the assigned access to API",
          "type": "string"
        },
        "refreshToken": {
          "description": "It is used to refresh the generated token",
          "type": "string"
        },
        "name": {
          "description": "Name of the client requesting the token",
          "type": "string"
        },
        "id": {
          "description": "Identifier of the client requesting the token",
          "type": "string"
        },
        "issued": {
          "format": "date-time",
          "description": "Date of issue of the token (yyyy-MM-dd HH:mm:ss)",
          "type": "string"
        },
        "expires": {
          "format": "date-time",
          "description": "Date of expiry of the token (yyyy-MM-dd HH:mm:ss)",
          "type": "string"
        },
        "expiresIn": {
          "format": "int32",
          "description": "Seconds of validity of the token from the moment of generation",
          "type": "integer"
        }
      }
    }
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<AddMemberResponse>
  <type>object</type>
  <properties>
    <memberId>
      <format>int32</format>
      <description>Id of added member</description>
      <type>integer</type>
    </memberId>
    <authorizationData>
      <type>object</type>
      <properties>
        <accessToken>
          <description>String of characters that provides encrypted information about the assigned access to API</description>
          <type>string</type>
        </accessToken>
        <tokenType>
          <description>String of characters that provides encrypted information about the assigned access to API</description>
          <type>string</type>
        </tokenType>
        <refreshToken>
          <description>It is used to refresh the generated token</description>
          <type>string</type>
        </refreshToken>
        <name>
          <description>Name of the client requesting the token</description>
          <type>string</type>
        </name>
        <id>
          <description>Identifier of the client requesting the token</description>
          <type>string</type>
        </id>
        <issued>
          <format>date-time</format>
          <description>Date of issue of the token (yyyy-MM-dd HH:mm:ss)</description>
          <type>string</type>
        </issued>
        <expires>
          <format>date-time</format>
          <description>Date of expiry of the token (yyyy-MM-dd HH:mm:ss)</description>
          <type>string</type>
        </expires>
        <expiresIn>
          <format>int32</format>
          <description>Seconds of validity of the token from the moment of generation</description>
          <type>integer</type>
        </expiresIn>
      </properties>
    </authorizationData>
  </properties>
</AddMemberResponse>

Responses

Status Meaning Description Schema
200 OK Member added successfully AddMemberResponse
422 Unprocessable Entity Model validation error ErrorResponse_MemberResponseCode_

GET bonuspoint-transactions

Code samples

GET https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/members/bonuspoint-transactions HTTP/1.1
Host: api-frontend2.efitness.com.pl
Accept: application/json
client-request-id: [object Object]
member-token: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

GET /api/clubs/{clubId}/members/bonuspoint-transactions

Get a list of member bonuspoint transactions

Parameters

Name In Type Required Description
clubId path string true none
limit query integer(int32) false none
offset query integer(int32) false none
sortBy query string false none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
member-token header string true Token used to authorize a club member.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "bonuspointTransactionID": {
            "format": "int32",
            "description": "Identity Number of bonus transaction",
            "type": "integer"
          },
          "dateAdded": {
            "format": "date-time",
            "description": "Transaction date (yyyy-MM-dd HH:mm:ss)",
            "type": "string"
          },
          "value": {
            "format": "double",
            "description": "Value of bonus transaction",
            "type": "number"
          },
          "description": {
            "description": "Description of bonus transaction",
            "type": "string"
          }
        }
      }
    },
    "totalCount": {
      "format": "int32",
      "type": "integer"
    },
    "next": {
      "type": "string"
    },
    "previous": {
      "type": "string"
    }
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<CollectionResponse_BonuspointTransactionResponse_>
  <type>object</type>
  <properties>
    <results>
      <type>array</type>
      <items>
        <type>object</type>
        <properties>
          <bonuspointTransactionID>
            <format>int32</format>
            <description>Identity Number of bonus transaction</description>
            <type>integer</type>
          </bonuspointTransactionID>
          <dateAdded>
            <format>date-time</format>
            <description>Transaction date (yyyy-MM-dd HH:mm:ss)</description>
            <type>string</type>
          </dateAdded>
          <value>
            <format>double</format>
            <description>Value of bonus transaction</description>
            <type>number</type>
          </value>
          <description>
            <description>Description of bonus transaction</description>
            <type>string</type>
          </description>
        </properties>
      </items>
    </results>
    <totalCount>
      <format>int32</format>
      <type>integer</type>
    </totalCount>
    <next>
      <type>string</type>
    </next>
    <previous>
      <type>string</type>
    </previous>
  </properties>
</CollectionResponse_BonuspointTransactionResponse_>

Responses

Status Meaning Description Schema
200 OK OK CollectionResponse_BonuspointTransactionResponse_
422 Unprocessable Entity 422 ErrorResponse_ECommonResponseCode_

GET member class-reservations

Code samples

GET https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/members/class-reservations HTTP/1.1
Host: api-frontend2.efitness.com.pl
Accept: application/json
client-request-id: [object Object]
member-token: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

GET /api/clubs/{clubId}/members/class-reservations

Get a list of member classes reservations

Parameters

Name In Type Required Description
clubId path string true none
dateFrom query string(date-time) false none
dateTo query string(date-time) false none
limit query integer(int32) false none
offset query integer(int32) false none
sortBy query string false none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
member-token header string true Token used to authorize a club member.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "classReservationId": {
            "format": "int32",
            "description": "Class reservation identifier",
            "type": "integer"
          },
          "className": {
            "description": "Class reservation name",
            "type": "string"
          },
          "description": {
            "description": "Class description",
            "type": "string"
          },
          "startDate": {
            "format": "date-time",
            "description": "Class start date (yyyy-MM-dd HH:mm:ss)",
            "type": "string"
          },
          "endDate": {
            "format": "date-time",
            "description": "Class end date (yyyy-MM-dd HH:mm:ss)",
            "type": "string"
          },
          "status": {
            "format": "int32",
            "description": "Class reservation status name: <br />  0 - not visited<br />  1 - visited<br />  3 - payment required",
            "type": "integer"
          },
          "positionOnWaitList": {
            "format": "int32",
            "description": "Position number on waiting list if member is on it",
            "type": "integer"
          },
          "clubId": {
            "format": "int32",
            "description": "Club identifier",
            "type": "integer"
          },
          "duration": {
            "format": "int32",
            "description": "Classes duration (in minutes)",
            "type": "integer"
          },
          "instructorId": {
            "format": "int32",
            "description": "Instructor identifier",
            "type": "integer"
          },
          "instructorName": {
            "description": "Instructor name",
            "type": "string"
          },
          "roomName": {
            "description": "Class room name",
            "type": "string"
          },
          "classId": {
            "format": "int32",
            "description": "Class identifier",
            "type": "integer"
          },
          "canCancel": {
            "description": "Whether class reservation can be canceled",
            "type": "boolean"
          },
          "cancellationBlockReasons": {
            "description": "If canCancel is false, this field contains exact status codes that block member from cancelling: <br />  0 - Cannot unregister the member from this class, because the member is not registered for it<br />  1 - Reservation cancellation is not allowed for this type of classes<br />  2 - Reservation cancellation is not allowed in this club<br />  3 - The class can not be deleted, because it was settled<br />  4 - The option of class resignation has been blocked by the Club<br />  5 - The class can not be deleted, because it has already started<br />  6 - Available time for class resignation has expired<br />  7 - The class can not be deleted, because it was payed",
            "type": "array",
            "items": {
              "format": "int32",
              "enum": [
                0,
                1,
                2,
                3,
                4,
                5,
                6,
                7
              ],
              "type": "integer"
            }
          },
          "isPast": {
            "description": "Whether class is in past",
            "type": "boolean"
          },
          "attendanceStatus": {
            "format": "int32",
            "description": "Whether member was present in class: <br />  0 - ReservedVisited<br />  1 - ReservedNotVisit<br />  2 - EntryTakenAsPenalty<br />  3 - OnReserveNotVisited",
            "type": "integer"
          },
          "iconUrl": {
            "description": "Class definition icon",
            "type": "string"
          },
          "virtualClassUrl": {
            "description": "Url for virtual class (google meet)",
            "type": "string"
          }
        }
      }
    },
    "totalCount": {
      "format": "int32",
      "type": "integer"
    },
    "next": {
      "type": "string"
    },
    "previous": {
      "type": "string"
    }
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<CollectionResponse_ClassReservationResponse_>
  <type>object</type>
  <properties>
    <results>
      <type>array</type>
      <items>
        <type>object</type>
        <properties>
          <classReservationId>
            <format>int32</format>
            <description>Class reservation identifier</description>
            <type>integer</type>
          </classReservationId>
          <className>
            <description>Class reservation name</description>
            <type>string</type>
          </className>
          <description>
            <description>Class description</description>
            <type>string</type>
          </description>
          <startDate>
            <format>date-time</format>
            <description>Class start date (yyyy-MM-dd HH:mm:ss)</description>
            <type>string</type>
          </startDate>
          <endDate>
            <format>date-time</format>
            <description>Class end date (yyyy-MM-dd HH:mm:ss)</description>
            <type>string</type>
          </endDate>
          <status>
            <format>int32</format>
            <description>Class reservation status name: <br>&nbsp;&nbsp;0 - not visited<br>&nbsp;&nbsp;1 - visited<br>&nbsp;&nbsp;3 - payment required</description>
            <type>integer</type>
          </status>
          <positionOnWaitList>
            <format>int32</format>
            <description>Position number on waiting list if member is on it</description>
            <type>integer</type>
          </positionOnWaitList>
          <clubId>
            <format>int32</format>
            <description>Club identifier</description>
            <type>integer</type>
          </clubId>
          <duration>
            <format>int32</format>
            <description>Classes duration (in minutes)</description>
            <type>integer</type>
          </duration>
          <instructorId>
            <format>int32</format>
            <description>Instructor identifier</description>
            <type>integer</type>
          </instructorId>
          <instructorName>
            <description>Instructor name</description>
            <type>string</type>
          </instructorName>
          <roomName>
            <description>Class room name</description>
            <type>string</type>
          </roomName>
          <classId>
            <format>int32</format>
            <description>Class identifier</description>
            <type>integer</type>
          </classId>
          <canCancel>
            <description>Whether class reservation can be canceled</description>
            <type>boolean</type>
          </canCancel>
          <cancellationBlockReasons>
            <description>If canCancel is false, this field contains exact status codes that block member from cancelling: <br>&nbsp;&nbsp;0 - Cannot unregister the member from this class, because the member is not registered for it<br>&nbsp;&nbsp;1 - Reservation cancellation is not allowed for this type of classes<br>&nbsp;&nbsp;2 - Reservation cancellation is not allowed in this club<br>&nbsp;&nbsp;3 - The class can not be deleted, because it was settled<br>&nbsp;&nbsp;4 - The option of class resignation has been blocked by the Club<br>&nbsp;&nbsp;5 - The class can not be deleted, because it has already started<br>&nbsp;&nbsp;6 - Available time for class resignation has expired<br>&nbsp;&nbsp;7 - The class can not be deleted, because it was payed</description>
            <type>array</type>
            <items>
              <format>int32</format>
              <enum>0</enum>
              <enum>1</enum>
              <enum>2</enum>
              <enum>3</enum>
              <enum>4</enum>
              <enum>5</enum>
              <enum>6</enum>
              <enum>7</enum>
              <type>integer</type>
            </items>
          </cancellationBlockReasons>
          <isPast>
            <description>Whether class is in past</description>
            <type>boolean</type>
          </isPast>
          <attendanceStatus>
            <format>int32</format>
            <description>Whether member was present in class: <br>&nbsp;&nbsp;0 - ReservedVisited<br>&nbsp;&nbsp;1 - ReservedNotVisit<br>&nbsp;&nbsp;2 - EntryTakenAsPenalty<br>&nbsp;&nbsp;3 - OnReserveNotVisited</description>
            <type>integer</type>
          </attendanceStatus>
          <iconUrl>
            <description>Class definition icon</description>
            <type>string</type>
          </iconUrl>
          <virtualClassUrl>
            <description>Url for virtual class (google meet)</description>
            <type>string</type>
          </virtualClassUrl>
        </properties>
      </items>
    </results>
    <totalCount>
      <format>int32</format>
      <type>integer</type>
    </totalCount>
    <next>
      <type>string</type>
    </next>
    <previous>
      <type>string</type>
    </previous>
  </properties>
</CollectionResponse_ClassReservationResponse_>

Responses

Status Meaning Description Schema
200 OK OK CollectionResponse_ClassReservationResponse_
422 Unprocessable Entity 422 ErrorResponse_ECommonResponseCode_

POST member class-reservation

Code samples

POST https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/members/class-reservations HTTP/1.1
Host: api-frontend2.efitness.com.pl
Content-Type: application/json
Accept: application/json
client-request-id: [object Object]
member-token: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

POST /api/clubs/{clubId}/members/class-reservations

Add member class reservation

Body parameter

{
  "required": [
    "classId"
  ],
  "type": "object",
  "properties": {
    "classId": {
      "format": "int32",
      "description": "Id of concrete class for reservation",
      "type": "integer"
    },
    "subClassId": {
      "format": "int32",
      "description": "SubClass id of current class",
      "type": "integer"
    },
    "promoCode": {
      "description": "Promotional code reducing the price",
      "type": "string"
    }
  }
}

required:
  - classId
type: object
properties:
  classId:
    format: int32
    description: Id of concrete class for reservation
    type: integer
  subClassId:
    format: int32
    description: SubClass id of current class
    type: integer
  promoCode:
    description: Promotional code reducing the price
    type: string


<?xml version="1.0" encoding="UTF-8" ?>
<ClassReservationRequest>
  <required>classId</required>
  <type>object</type>
  <properties>
    <classId>
      <format>int32</format>
      <description>Id of concrete class for reservation</description>
      <type>integer</type>
    </classId>
    <subClassId>
      <format>int32</format>
      <description>SubClass id of current class</description>
      <type>integer</type>
    </subClassId>
    <promoCode>
      <description>Promotional code reducing the price</description>
      <type>string</type>
    </promoCode>
  </properties>
</ClassReservationRequest>

Parameters

Name In Type Required Description
clubId path string true none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
member-token header string true Token used to authorize a club member.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.
body body ClassReservationRequest true Model request

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "classReservations": {
      "description": "Class reservations",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "classReservationId": {
            "format": "int32",
            "description": "Id of class reservation",
            "type": "integer"
          },
          "positionOnReserveList": {
            "format": "int32",
            "description": "Position on reserve list",
            "type": "integer"
          }
        }
      }
    },
    "isCourse": {
      "description": "Is course",
      "type": "boolean"
    },
    "price": {
      "format": "double",
      "description": "Price",
      "type": "number"
    }
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<AddClassReservationResponse>
  <type>object</type>
  <properties>
    <classReservations>
      <description>Class reservations</description>
      <type>array</type>
      <items>
        <type>object</type>
        <properties>
          <classReservationId>
            <format>int32</format>
            <description>Id of class reservation</description>
            <type>integer</type>
          </classReservationId>
          <positionOnReserveList>
            <format>int32</format>
            <description>Position on reserve list</description>
            <type>integer</type>
          </positionOnReserveList>
        </properties>
      </items>
    </classReservations>
    <isCourse>
      <description>Is course</description>
      <type>boolean</type>
    </isCourse>
    <price>
      <format>double</format>
      <description>Price</description>
      <type>number</type>
    </price>
  </properties>
</AddClassReservationResponse>

Responses

Status Meaning Description Schema
200 OK Class reservation added successfully AddClassReservationResponse
422 Unprocessable Entity Model validation error ErrorResponse_ClassReservationResponseCode_

GET member class-reservation

Code samples

GET https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/members/class-reservations/{id} HTTP/1.1
Host: api-frontend2.efitness.com.pl
Accept: application/json
client-request-id: [object Object]
member-token: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

GET /api/clubs/{clubId}/members/class-reservations/{id}

Get member class reservation

Parameters

Name In Type Required Description
id path integer(int32) true class reservation id
clubId path string true none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
member-token header string true Token used to authorize a club member.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "classReservationId": {
      "format": "int32",
      "description": "Class reservation identifier",
      "type": "integer"
    },
    "className": {
      "description": "Class reservation name",
      "type": "string"
    },
    "description": {
      "description": "Class description",
      "type": "string"
    },
    "startDate": {
      "format": "date-time",
      "description": "Class start date (yyyy-MM-dd HH:mm:ss)",
      "type": "string"
    },
    "endDate": {
      "format": "date-time",
      "description": "Class end date (yyyy-MM-dd HH:mm:ss)",
      "type": "string"
    },
    "status": {
      "format": "int32",
      "description": "Class reservation status name: <br />  0 - not visited<br />  1 - visited<br />  3 - payment required",
      "type": "integer"
    },
    "positionOnWaitList": {
      "format": "int32",
      "description": "Position number on waiting list if member is on it",
      "type": "integer"
    },
    "clubId": {
      "format": "int32",
      "description": "Club identifier",
      "type": "integer"
    },
    "duration": {
      "format": "int32",
      "description": "Classs duration (in minutes)",
      "type": "integer"
    },
    "instructorId": {
      "format": "int32",
      "description": "Instructor identifier",
      "type": "integer"
    },
    "instructorName": {
      "description": "Instructor name",
      "type": "string"
    },
    "roomName": {
      "description": "Class room name",
      "type": "string"
    },
    "classId": {
      "format": "int32",
      "description": "Class identifier",
      "type": "integer"
    },
    "canCancel": {
      "description": "Whether class reservation can be canceled",
      "type": "boolean"
    },
    "cancellationBlockReasons": {
      "description": "If canCancel is false, this field contains exact status codes that block member from cancelling: <br />  0 - Cannot unregister the member from this class, because the member is not registered for it<br />  1 - Reservation cancellation is not allowed for this type of classes<br />  2 - Reservation cancellation is not allowed in this club<br />  3 - The class can not be deleted, because it was settled<br />  4 - The option of class resignation has been blocked by the Club<br />  5 - The class can not be deleted, because it has already started<br />  6 - Available time for class resignation has expired<br />  7 - The class can not be deleted, because it was payed",
      "type": "array",
      "items": {
        "format": "int32",
        "enum": [
          0,
          1,
          2,
          3,
          4,
          5,
          6,
          7
        ],
        "type": "integer"
      }
    },
    "iconUrl": {
      "description": "Class definition icon",
      "type": "string"
    },
    "virtualClassUrl": {
      "description": "Url for virtual class(google meet)",
      "type": "string"
    }
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<ClassReservationCurrentResponse>
  <type>object</type>
  <properties>
    <classReservationId>
      <format>int32</format>
      <description>Class reservation identifier</description>
      <type>integer</type>
    </classReservationId>
    <className>
      <description>Class reservation name</description>
      <type>string</type>
    </className>
    <description>
      <description>Class description</description>
      <type>string</type>
    </description>
    <startDate>
      <format>date-time</format>
      <description>Class start date (yyyy-MM-dd HH:mm:ss)</description>
      <type>string</type>
    </startDate>
    <endDate>
      <format>date-time</format>
      <description>Class end date (yyyy-MM-dd HH:mm:ss)</description>
      <type>string</type>
    </endDate>
    <status>
      <format>int32</format>
      <description>Class reservation status name: <br>&nbsp;&nbsp;0 - not visited<br>&nbsp;&nbsp;1 - visited<br>&nbsp;&nbsp;3 - payment required</description>
      <type>integer</type>
    </status>
    <positionOnWaitList>
      <format>int32</format>
      <description>Position number on waiting list if member is on it</description>
      <type>integer</type>
    </positionOnWaitList>
    <clubId>
      <format>int32</format>
      <description>Club identifier</description>
      <type>integer</type>
    </clubId>
    <duration>
      <format>int32</format>
      <description>Classs duration (in minutes)</description>
      <type>integer</type>
    </duration>
    <instructorId>
      <format>int32</format>
      <description>Instructor identifier</description>
      <type>integer</type>
    </instructorId>
    <instructorName>
      <description>Instructor name</description>
      <type>string</type>
    </instructorName>
    <roomName>
      <description>Class room name</description>
      <type>string</type>
    </roomName>
    <classId>
      <format>int32</format>
      <description>Class identifier</description>
      <type>integer</type>
    </classId>
    <canCancel>
      <description>Whether class reservation can be canceled</description>
      <type>boolean</type>
    </canCancel>
    <cancellationBlockReasons>
      <description>If canCancel is false, this field contains exact status codes that block member from cancelling: <br>&nbsp;&nbsp;0 - Cannot unregister the member from this class, because the member is not registered for it<br>&nbsp;&nbsp;1 - Reservation cancellation is not allowed for this type of classes<br>&nbsp;&nbsp;2 - Reservation cancellation is not allowed in this club<br>&nbsp;&nbsp;3 - The class can not be deleted, because it was settled<br>&nbsp;&nbsp;4 - The option of class resignation has been blocked by the Club<br>&nbsp;&nbsp;5 - The class can not be deleted, because it has already started<br>&nbsp;&nbsp;6 - Available time for class resignation has expired<br>&nbsp;&nbsp;7 - The class can not be deleted, because it was payed</description>
      <type>array</type>
      <items>
        <format>int32</format>
        <enum>0</enum>
        <enum>1</enum>
        <enum>2</enum>
        <enum>3</enum>
        <enum>4</enum>
        <enum>5</enum>
        <enum>6</enum>
        <enum>7</enum>
        <type>integer</type>
      </items>
    </cancellationBlockReasons>
    <iconUrl>
      <description>Class definition icon</description>
      <type>string</type>
    </iconUrl>
    <virtualClassUrl>
      <description>Url for virtual class(google meet)</description>
      <type>string</type>
    </virtualClassUrl>
  </properties>
</ClassReservationCurrentResponse>

Responses

Status Meaning Description Schema
200 OK OK ClassReservationCurrentResponse
422 Unprocessable Entity 422 ErrorResponse_ECommonResponseCode_

DELETE member class-reservation

Code samples

DELETE https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/members/class-reservations/{id} HTTP/1.1
Host: api-frontend2.efitness.com.pl
Accept: application/json
client-request-id: [object Object]
member-token: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

DELETE /api/clubs/{clubId}/members/class-reservations/{id}

Delete member class reservation

Parameters

Name In Type Required Description
id path integer(int32) true class reservation identifier
clubId path string true none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
member-token header string true Token used to authorize a club member.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.

Example responses

422 Response

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "responseCode": {
            "type": "string",
            "readOnly": true
          },
          "message": {
            "type": "string"
          },
          "path": {
            "type": "string"
          }
        }
      }
    }
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<ErrorResponse_RemoveClassReservationResponseCode_>
  <type>object</type>
  <properties>
    <errors>
      <type>array</type>
      <items>
        <type>object</type>
        <properties>
          <responseCode>
            <type>string</type>
            <readOnly>true</readOnly>
          </responseCode>
          <message>
            <type>string</type>
          </message>
          <path>
            <type>string</type>
          </path>
        </properties>
      </items>
    </errors>
  </properties>
</ErrorResponse_RemoveClassReservationResponseCode_>

Responses

Status Meaning Description Schema
200 OK Class reservation removed successfully None
422 Unprocessable Entity Model validation error ErrorResponse_RemoveClassReservationResponseCode_

Code samples

GET https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/members/consent-definitions HTTP/1.1
Host: api-frontend2.efitness.com.pl
Accept: application/json
client-request-id: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

GET /api/clubs/{clubId}/members/consent-definitions

Get a list of consent definitions for member registration

Name In Type Required Description
clubId path string true none
limit query integer(int32) false none
offset query integer(int32) false none
sortBy query string false none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "consentDefinitionId": {
            "format": "int32",
            "description": "Registration consent Id",
            "type": "integer"
          },
          "content": {
            "description": "Registration consent content",
            "type": "string"
          },
          "links": {
            "description": "Registration consent links",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "url": {
                  "description": "Registration consent link url",
                  "type": "string"
                },
                "text": {
                  "description": "Registration consent link text",
                  "type": "string"
                }
              }
            }
          },
          "name": {
            "description": "Registration consent name",
            "type": "string"
          },
          "required": {
            "description": "Indicates whether consent is required",
            "type": "boolean"
          },
          "defaultChecked": {
            "description": "Indicates whether consent should be default checked",
            "type": "boolean"
          },
          "signatureRequired": {
            "description": "Indicates whether consent should be signed",
            "type": "boolean"
          }
        }
      }
    },
    "totalCount": {
      "format": "int32",
      "type": "integer"
    },
    "next": {
      "type": "string"
    },
    "previous": {
      "type": "string"
    }
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<CollectionResponse_ConsentDefinitionResponse_>
  <type>object</type>
  <properties>
    <results>
      <type>array</type>
      <items>
        <type>object</type>
        <properties>
          <consentDefinitionId>
            <format>int32</format>
            <description>Registration consent Id</description>
            <type>integer</type>
          </consentDefinitionId>
          <content>
            <description>Registration consent content</description>
            <type>string</type>
          </content>
          <links>
            <description>Registration consent links</description>
            <type>array</type>
            <items>
              <type>object</type>
              <properties>
                <url>
                  <description>Registration consent link url</description>
                  <type>string</type>
                </url>
                <text>
                  <description>Registration consent link text</description>
                  <type>string</type>
                </text>
              </properties>
            </items>
          </links>
          <name>
            <description>Registration consent name</description>
            <type>string</type>
          </name>
          <required>
            <description>Indicates whether consent is required</description>
            <type>boolean</type>
          </required>
          <defaultChecked>
            <description>Indicates whether consent should be default checked</description>
            <type>boolean</type>
          </defaultChecked>
          <signatureRequired>
            <description>Indicates whether consent should be signed</description>
            <type>boolean</type>
          </signatureRequired>
        </properties>
      </items>
    </results>
    <totalCount>
      <format>int32</format>
      <type>integer</type>
    </totalCount>
    <next>
      <type>string</type>
    </next>
    <previous>
      <type>string</type>
    </previous>
  </properties>
</CollectionResponse_ConsentDefinitionResponse_>
Status Meaning Description Schema
200 OK OK CollectionResponse_ConsentDefinitionResponse_
422 Unprocessable Entity 422 ErrorResponse_ECommonResponseCode_

GET consents

Code samples

GET https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/members/consents HTTP/1.1
Host: api-frontend2.efitness.com.pl
Accept: application/json
client-request-id: [object Object]
member-token: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

GET /api/clubs/{clubId}/members/consents

Get a list of signed member consents

Parameters

Name In Type Required Description
clubId path string true none
limit query integer(int32) false none
offset query integer(int32) false none
sortBy query string false none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
member-token header string true Token used to authorize a club member.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "consentId": {
            "format": "int32",
            "description": "Consent ID",
            "type": "integer"
          },
          "consentDefinitionID": {
            "format": "int32",
            "description": "Registration consent definition Id",
            "type": "integer"
          },
          "name": {
            "description": "Registration consent name",
            "type": "string"
          },
          "content": {
            "description": "Registration consent content",
            "type": "string"
          },
          "links": {
            "description": "Registration consent links",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "url": {
                  "description": "Registration consent link url",
                  "type": "string"
                },
                "text": {
                  "description": "Registration consent link text",
                  "type": "string"
                }
              }
            }
          },
          "isActive": {
            "description": "Indicates whether consent is active",
            "type": "boolean"
          },
          "ip": {
            "description": "IP address from which the consent was given",
            "type": "string"
          },
          "dateAdded": {
            "format": "date-time",
            "description": "Date of signing consent (yyyy-MM-dd HH:mm:ss)",
            "type": "string"
          },
          "required": {
            "description": "Determines whether consent is required",
            "type": "boolean"
          },
          "consentType": {
            "format": "int32",
            "description": "Consent type: : <br />  0 - Regulation<br />  1 - Marketing<br />  2 - Biometric<br />  3 - Other<br />  4 - MarketingPartner<br />  6 - SystemMailer<br />  7 - SystemSmser<br />  8 - SystemAutoMail<br />  9 - SystemAutoSms",
            "type": "integer"
          },
          "membershipId": {
            "format": "int32",
            "description": "Membership ID contracted with consent",
            "type": "integer"
          }
        }
      }
    },
    "totalCount": {
      "format": "int32",
      "type": "integer"
    },
    "next": {
      "type": "string"
    },
    "previous": {
      "type": "string"
    }
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<CollectionResponse_MemberConsentResponse_>
  <type>object</type>
  <properties>
    <results>
      <type>array</type>
      <items>
        <type>object</type>
        <properties>
          <consentId>
            <format>int32</format>
            <description>Consent ID</description>
            <type>integer</type>
          </consentId>
          <consentDefinitionID>
            <format>int32</format>
            <description>Registration consent definition Id</description>
            <type>integer</type>
          </consentDefinitionID>
          <name>
            <description>Registration consent name</description>
            <type>string</type>
          </name>
          <content>
            <description>Registration consent content</description>
            <type>string</type>
          </content>
          <links>
            <description>Registration consent links</description>
            <type>array</type>
            <items>
              <type>object</type>
              <properties>
                <url>
                  <description>Registration consent link url</description>
                  <type>string</type>
                </url>
                <text>
                  <description>Registration consent link text</description>
                  <type>string</type>
                </text>
              </properties>
            </items>
          </links>
          <isActive>
            <description>Indicates whether consent is active</description>
            <type>boolean</type>
          </isActive>
          <ip>
            <description>IP address from which the consent was given</description>
            <type>string</type>
          </ip>
          <dateAdded>
            <format>date-time</format>
            <description>Date of signing consent (yyyy-MM-dd HH:mm:ss)</description>
            <type>string</type>
          </dateAdded>
          <required>
            <description>Determines whether consent is required</description>
            <type>boolean</type>
          </required>
          <consentType>
            <format>int32</format>
            <description>Consent type: : <br>&nbsp;&nbsp;0 - Regulation<br>&nbsp;&nbsp;1 - Marketing<br>&nbsp;&nbsp;2 - Biometric<br>&nbsp;&nbsp;3 - Other<br>&nbsp;&nbsp;4 - MarketingPartner<br>&nbsp;&nbsp;6 - SystemMailer<br>&nbsp;&nbsp;7 - SystemSmser<br>&nbsp;&nbsp;8 - SystemAutoMail<br>&nbsp;&nbsp;9 - SystemAutoSms</description>
            <type>integer</type>
          </consentType>
          <membershipId>
            <format>int32</format>
            <description>Membership ID contracted with consent</description>
            <type>integer</type>
          </membershipId>
        </properties>
      </items>
    </results>
    <totalCount>
      <format>int32</format>
      <type>integer</type>
    </totalCount>
    <next>
      <type>string</type>
    </next>
    <previous>
      <type>string</type>
    </previous>
  </properties>
</CollectionResponse_MemberConsentResponse_>

Responses

Status Meaning Description Schema
200 OK OK CollectionResponse_MemberConsentResponse_
422 Unprocessable Entity 422 ErrorResponse_ECommonResponseCode_

Code samples

PUT https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/members/consents/{id} HTTP/1.1
Host: api-frontend2.efitness.com.pl
Content-Type: application/json
Accept: application/json
client-request-id: [object Object]
member-token: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

PUT /api/clubs/{clubId}/members/consents/{id}

Update member consent

Body parameter

{
  "type": "object",
  "properties": {
    "isActive": {
      "description": "Is consent to activate(1) or deactivate",
      "type": "boolean"
    },
    "IP": {
      "description": "IP of update the consent",
      "type": "string"
    }
  }
}

type: object
properties:
  isActive:
    description: Is consent to activate(1) or deactivate
    type: boolean
  IP:
    description: IP of update the consent
    type: string


<?xml version="1.0" encoding="UTF-8" ?>
<ConsentUpdateRequest>
  <type>object</type>
  <properties>
    <isActive>
      <description>Is consent to activate(1) or deactivate</description>
      <type>boolean</type>
    </isActive>
    <IP>
      <description>IP of update the consent</description>
      <type>string</type>
    </IP>
  </properties>
</ConsentUpdateRequest>
Name In Type Required Description
id path integer(int32) true Member consent ID
clubId path string true none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
member-token header string true Token used to authorize a club member.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.
body body ConsentUpdateRequest true Model request

Example responses

422 Response

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "responseCode": {
            "type": "string",
            "readOnly": true
          },
          "message": {
            "type": "string"
          },
          "path": {
            "type": "string"
          }
        }
      }
    }
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<ErrorResponse_MemberResponseCode_>
  <type>object</type>
  <properties>
    <errors>
      <type>array</type>
      <items>
        <type>object</type>
        <properties>
          <responseCode>
            <type>string</type>
            <readOnly>true</readOnly>
          </responseCode>
          <message>
            <type>string</type>
          </message>
          <path>
            <type>string</type>
          </path>
        </properties>
      </items>
    </errors>
  </properties>
</ErrorResponse_MemberResponseCode_>
Status Meaning Description Schema
200 OK Member consents updated successfully None
422 Unprocessable Entity Model validation error ErrorResponse_MemberResponseCode_

POST email-update

Code samples

POST https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/members/email HTTP/1.1
Host: api-frontend2.efitness.com.pl
Content-Type: application/json
Accept: application/json
client-request-id: [object Object]
member-token: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

POST /api/clubs/{clubId}/members/email

Returns token for two factor email update

Body parameter

{
  "required": [
    "newEmail"
  ],
  "type": "object",
  "properties": {
    "newEmail": {
      "description": "New member email",
      "type": "string"
    },
    "confirmationUrl": {
      "description": "Url for confirmation email link (optional)",
      "type": "string"
    }
  }
}

required:
  - newEmail
type: object
properties:
  newEmail:
    description: New member email
    type: string
  confirmationUrl:
    description: Url for confirmation email link (optional)
    type: string


<?xml version="1.0" encoding="UTF-8" ?>
<TwoFactorEmailUpdateRequest>
  <required>newEmail</required>
  <type>object</type>
  <properties>
    <newEmail>
      <description>New member email</description>
      <type>string</type>
    </newEmail>
    <confirmationUrl>
      <description>Url for confirmation email link (optional)</description>
      <type>string</type>
    </confirmationUrl>
  </properties>
</TwoFactorEmailUpdateRequest>

Parameters

Name In Type Required Description
clubId path string true none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
member-token header string true Token used to authorize a club member.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.
body body TwoFactorEmailUpdateRequest true Model request

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "token": {
      "description": "Token required for two factor update email",
      "type": "string"
    },
    "isTwoFactor": {
      "description": "Determine when update was in two factor way",
      "type": "boolean"
    },
    "expires": {
      "description": "Date until when token is valid",
      "type": "string"
    }
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<TwoFactorUpdateEmailResponse>
  <type>object</type>
  <properties>
    <token>
      <description>Token required for two factor update email</description>
      <type>string</type>
    </token>
    <isTwoFactor>
      <description>Determine when update was in two factor way</description>
      <type>boolean</type>
    </isTwoFactor>
    <expires>
      <description>Date until when token is valid</description>
      <type>string</type>
    </expires>
  </properties>
</TwoFactorUpdateEmailResponse>

Responses

Status Meaning Description Schema
200 OK Update member email TwoFactorUpdateEmailResponse
422 Unprocessable Entity Model validation error ErrorResponse_MemberResponseCode_

POST email-confirm

Code samples

POST https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/members/email-confirm HTTP/1.1
Host: api-frontend2.efitness.com.pl
Content-Type: application/json
Accept: application/json
client-request-id: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

POST /api/clubs/{clubId}/members/email-confirm

Confirm email update with token

Body parameter

{
  "required": [
    "token"
  ],
  "type": "object",
  "properties": {
    "token": {
      "description": "Token for confirm member email update",
      "type": "string"
    }
  }
}

required:
  - token
type: object
properties:
  token:
    description: Token for confirm member email update
    type: string


<?xml version="1.0" encoding="UTF-8" ?>
<TwoFactorEmailConfirmRequest>
  <required>token</required>
  <type>object</type>
  <properties>
    <token>
      <description>Token for confirm member email update</description>
      <type>string</type>
    </token>
  </properties>
</TwoFactorEmailConfirmRequest>

Parameters

Name In Type Required Description
clubId path string true none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.
body body TwoFactorEmailConfirmRequest true Model request

Example responses

200 Response

{
  "format": "int32",
  "enum": [
    100,
    101,
    200,
    201,
    202,
    203,
    204,
    205,
    206,
    300,
    300,
    301,
    301,
    302,
    302,
    303,
    303,
    304,
    305,
    306,
    307,
    307,
    400,
    401,
    402,
    403,
    404,
    405,
    406,
    407,
    408,
    409,
    410,
    411,
    412,
    413,
    414,
    415,
    416,
    417,
    426,
    500,
    501,
    502,
    503,
    504,
    505
  ],
  "type": "integer"
}

<?xml version="1.0" encoding="UTF-8" ?>
<format>int32</format>
<enum>100</enum>
<enum>101</enum>
<enum>200</enum>
<enum>201</enum>
<enum>202</enum>
<enum>203</enum>
<enum>204</enum>
<enum>205</enum>
<enum>206</enum>
<enum>300</enum>
<enum>300</enum>
<enum>301</enum>
<enum>301</enum>
<enum>302</enum>
<enum>302</enum>
<enum>303</enum>
<enum>303</enum>
<enum>304</enum>
<enum>305</enum>
<enum>306</enum>
<enum>307</enum>
<enum>307</enum>
<enum>400</enum>
<enum>401</enum>
<enum>402</enum>
<enum>403</enum>
<enum>404</enum>
<enum>405</enum>
<enum>406</enum>
<enum>407</enum>
<enum>408</enum>
<enum>409</enum>
<enum>410</enum>
<enum>411</enum>
<enum>412</enum>
<enum>413</enum>
<enum>414</enum>
<enum>415</enum>
<enum>416</enum>
<enum>417</enum>
<enum>426</enum>
<enum>500</enum>
<enum>501</enum>
<enum>502</enum>
<enum>503</enum>
<enum>504</enum>
<enum>505</enum>
<type>integer</type>

Responses

Status Meaning Description Schema
200 OK Member email updated integer
422 Unprocessable Entity Model validation error ErrorResponse_MemberResponseCode_

GET entries

Code samples

GET https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/members/entries HTTP/1.1
Host: api-frontend2.efitness.com.pl
Accept: application/json
client-request-id: [object Object]
member-token: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

GET /api/clubs/{clubId}/members/entries

Get a list of member entries

Parameters

Name In Type Required Description
clubId path string true none
dateFrom query string(date-time) false none
dateTo query string(date-time) false none
limit query integer(int32) false none
offset query integer(int32) false none
sortBy query string false none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
member-token header string true Token used to authorize a club member.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "date": {
            "format": "date-time",
            "description": "Date when member enter club (yyyy-MM-dd HH:mm:ss)",
            "type": "string"
          },
          "isEntry": {
            "description": "Determines if a date in model describes entry (if true) or exit (if false)",
            "type": "boolean"
          },
          "clubId": {
            "format": "int32",
            "description": "ID of the club member entered",
            "type": "integer"
          },
          "agreementId": {
            "format": "int32",
            "description": "ID of the member agreement",
            "type": "integer"
          },
          "source": {
            "format": "int32",
            "description": "Source of entry",
            "type": "integer"
          }
        }
      }
    },
    "totalCount": {
      "format": "int32",
      "type": "integer"
    },
    "next": {
      "type": "string"
    },
    "previous": {
      "type": "string"
    }
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<CollectionResponse_EntryResponse_>
  <type>object</type>
  <properties>
    <results>
      <type>array</type>
      <items>
        <type>object</type>
        <properties>
          <date>
            <format>date-time</format>
            <description>Date when member enter club (yyyy-MM-dd HH:mm:ss)</description>
            <type>string</type>
          </date>
          <isEntry>
            <description>Determines if a date in model describes entry (if true) or exit (if false)</description>
            <type>boolean</type>
          </isEntry>
          <clubId>
            <format>int32</format>
            <description>ID of the club member entered</description>
            <type>integer</type>
          </clubId>
          <agreementId>
            <format>int32</format>
            <description>ID of the member agreement</description>
            <type>integer</type>
          </agreementId>
          <source>
            <format>int32</format>
            <description>Source of entry</description>
            <type>integer</type>
          </source>
        </properties>
      </items>
    </results>
    <totalCount>
      <format>int32</format>
      <type>integer</type>
    </totalCount>
    <next>
      <type>string</type>
    </next>
    <previous>
      <type>string</type>
    </previous>
  </properties>
</CollectionResponse_EntryResponse_>

Responses

Status Meaning Description Schema
200 OK OK CollectionResponse_EntryResponse_
422 Unprocessable Entity 422 ErrorResponse_ECommonResponseCode_

GET invoices

Code samples

GET https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/members/invoices HTTP/1.1
Host: api-frontend2.efitness.com.pl
Accept: application/json
client-request-id: [object Object]
member-token: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

GET /api/clubs/{clubId}/members/invoices

Get a list of member invoices

Parameters

Name In Type Required Description
clubId path string true none
limit query integer(int32) false none
offset query integer(int32) false none
sortBy query string false none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
member-token header string true Token used to authorize a club member.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "invoiceId": {
            "format": "int32",
            "description": "Invoice Id",
            "type": "integer"
          },
          "sellDate": {
            "format": "date-time",
            "description": "Invoice sell date (yyyy-MM-dd HH:mm:ss)",
            "type": "string"
          },
          "fullNumber": {
            "description": "Invoice full number",
            "type": "string"
          },
          "value": {
            "format": "double",
            "description": "Invoice value",
            "type": "number"
          }
        }
      }
    },
    "totalCount": {
      "format": "int32",
      "type": "integer"
    },
    "next": {
      "type": "string"
    },
    "previous": {
      "type": "string"
    }
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<CollectionResponse_InvoiceResponse_>
  <type>object</type>
  <properties>
    <results>
      <type>array</type>
      <items>
        <type>object</type>
        <properties>
          <invoiceId>
            <format>int32</format>
            <description>Invoice Id</description>
            <type>integer</type>
          </invoiceId>
          <sellDate>
            <format>date-time</format>
            <description>Invoice sell date (yyyy-MM-dd HH:mm:ss)</description>
            <type>string</type>
          </sellDate>
          <fullNumber>
            <description>Invoice full number</description>
            <type>string</type>
          </fullNumber>
          <value>
            <format>double</format>
            <description>Invoice value</description>
            <type>number</type>
          </value>
        </properties>
      </items>
    </results>
    <totalCount>
      <format>int32</format>
      <type>integer</type>
    </totalCount>
    <next>
      <type>string</type>
    </next>
    <previous>
      <type>string</type>
    </previous>
  </properties>
</CollectionResponse_InvoiceResponse_>

Responses

Status Meaning Description Schema
200 OK OK CollectionResponse_InvoiceResponse_
422 Unprocessable Entity 422 ErrorResponse_ECommonResponseCode_

GET invoice content

Code samples

GET https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/members/invoices/{id} HTTP/1.1
Host: api-frontend2.efitness.com.pl
Accept: application/json
client-request-id: [object Object]
member-token: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

GET /api/clubs/{clubId}/members/invoices/{id}

Get content of member invoice

Parameters

Name In Type Required Description
id path integer(int32) true Invoice Id
clubId path string true none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
member-token header string true Token used to authorize a club member.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "base64Content": {
      "description": "Base64 encoded content of invoice",
      "type": "string"
    }
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<InvoiceContentResponse>
  <type>object</type>
  <properties>
    <base64Content>
      <description>Base64 encoded content of invoice</description>
      <type>string</type>
    </base64Content>
  </properties>
</InvoiceContentResponse>

Responses

Status Meaning Description Schema
200 OK OK InvoiceContentResponse
422 Unprocessable Entity 422 ErrorResponse_ECommonResponseCode_

GET current and limit number of the members inside the club

Code samples

GET https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/members/members-inside-club HTTP/1.1
Host: api-frontend2.efitness.com.pl
Accept: application/json
client-request-id: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

GET /api/clubs/{clubId}/members/members-inside-club

Get a number of members inside the club and limit number

Parameters

Name In Type Required Description
clubId path string true none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "membersInsideClub": {
      "format": "int32",
      "description": "Number of members inside club",
      "type": "integer"
    },
    "limit": {
      "format": "int32",
      "description": "Maximum number of members allowed to stay inside the club",
      "type": "integer"
    }
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<MembersInsideClubResponse>
  <type>object</type>
  <properties>
    <membersInsideClub>
      <format>int32</format>
      <description>Number of members inside club</description>
      <type>integer</type>
    </membersInsideClub>
    <limit>
      <format>int32</format>
      <description>Maximum number of members allowed to stay inside the club</description>
      <type>integer</type>
    </limit>
  </properties>
</MembersInsideClubResponse>

Responses

Status Meaning Description Schema
200 OK OK MembersInsideClubResponse
422 Unprocessable Entity 422 ErrorResponse_ECommonResponseCode_

POST save-mobile-push-info

Code samples

POST https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/members/save-mobile-push-info HTTP/1.1
Host: api-frontend2.efitness.com.pl
Content-Type: application/json
Accept: application/json
client-request-id: [object Object]
member-token: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

POST /api/clubs/{clubId}/members/save-mobile-push-info

OBSOLETE, USE POST api/clubs/{clubId}/members/mobile-push-info

Body parameter

{
  "required": [
    "appInstanceId",
    "applicationName"
  ],
  "type": "object",
  "properties": {
    "appInstanceId": {
      "description": "Unique user application identifier",
      "type": "string"
    },
    "applicationName": {
      "description": "Name of application which display push notification",
      "type": "string"
    }
  }
}

required:
  - appInstanceId
  - applicationName
type: object
properties:
  appInstanceId:
    description: Unique user application identifier
    type: string
  applicationName:
    description: Name of application which display push notification
    type: string


<?xml version="1.0" encoding="UTF-8" ?>
<MemberPushInfoRequest>
  <required>appInstanceId</required>
  <required>applicationName</required>
  <type>object</type>
  <properties>
    <appInstanceId>
      <description>Unique user application identifier</description>
      <type>string</type>
    </appInstanceId>
    <applicationName>
      <description>Name of application which display push notification</description>
      <type>string</type>
    </applicationName>
  </properties>
</MemberPushInfoRequest>

Parameters

Name In Type Required Description
clubId path string true none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
member-token header string true Token used to authorize a club member.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.
body body MemberPushInfoRequest true Model request

Example responses

422 Response

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "responseCode": {
            "type": "string",
            "readOnly": true
          },
          "message": {
            "type": "string"
          },
          "path": {
            "type": "string"
          }
        }
      }
    }
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<ErrorResponse_MemberResponseCode_>
  <type>object</type>
  <properties>
    <errors>
      <type>array</type>
      <items>
        <type>object</type>
        <properties>
          <responseCode>
            <type>string</type>
            <readOnly>true</readOnly>
          </responseCode>
          <message>
            <type>string</type>
          </message>
          <path>
            <type>string</type>
          </path>
        </properties>
      </items>
    </errors>
  </properties>
</ErrorResponse_MemberResponseCode_>

Responses

Status Meaning Description Schema
200 OK Mobile app push info saved successfully None
422 Unprocessable Entity Model validation error ErrorResponse_MemberResponseCode_

DELETE mobile-push-info

Code samples

DELETE https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/members/mobile-push-info HTTP/1.1
Host: api-frontend2.efitness.com.pl
Content-Type: application/json
Accept: application/json
client-request-id: [object Object]
member-token: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

DELETE /api/clubs/{clubId}/members/mobile-push-info

delete mobile app push notifications info for HttpV1 method

Body parameter

{
  "required": [
    "appInstanceId",
    "applicationName"
  ],
  "type": "object",
  "properties": {
    "appInstanceId": {
      "description": "Unique user application identifier",
      "type": "string"
    },
    "applicationName": {
      "description": "Name of application which display push notification",
      "type": "string"
    }
  }
}

required:
  - appInstanceId
  - applicationName
type: object
properties:
  appInstanceId:
    description: Unique user application identifier
    type: string
  applicationName:
    description: Name of application which display push notification
    type: string


<?xml version="1.0" encoding="UTF-8" ?>
<MemberPushInfoRequest>
  <required>appInstanceId</required>
  <required>applicationName</required>
  <type>object</type>
  <properties>
    <appInstanceId>
      <description>Unique user application identifier</description>
      <type>string</type>
    </appInstanceId>
    <applicationName>
      <description>Name of application which display push notification</description>
      <type>string</type>
    </applicationName>
  </properties>
</MemberPushInfoRequest>

Parameters

Name In Type Required Description
clubId path string true none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
member-token header string true Token used to authorize a club member.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.
body body MemberPushInfoRequest true Model request

Example responses

422 Response

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "responseCode": {
            "type": "string",
            "readOnly": true
          },
          "message": {
            "type": "string"
          },
          "path": {
            "type": "string"
          }
        }
      }
    }
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<ErrorResponse_MemberResponseCode_>
  <type>object</type>
  <properties>
    <errors>
      <type>array</type>
      <items>
        <type>object</type>
        <properties>
          <responseCode>
            <type>string</type>
            <readOnly>true</readOnly>
          </responseCode>
          <message>
            <type>string</type>
          </message>
          <path>
            <type>string</type>
          </path>
        </properties>
      </items>
    </errors>
  </properties>
</ErrorResponse_MemberResponseCode_>

Responses

Status Meaning Description Schema
200 OK Mobile app push info deleted successfully None
422 Unprocessable Entity Model validation error ErrorResponse_MemberResponseCode_

GET push-notifications

Code samples

GET https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/members/notifications/push HTTP/1.1
Host: api-frontend2.efitness.com.pl
Accept: application/json
client-request-id: [object Object]
member-token: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

GET /api/clubs/{clubId}/members/notifications/push

Get a list of push-notifications

Parameters

Name In Type Required Description
clubId path string true none
dateFrom query string(date-time) false none
dateTo query string(date-time) false none
limit query integer(int32) false none
offset query integer(int32) false none
sortBy query string false none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
member-token header string true Token used to authorize a club member.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "content": {
            "description": "Push content",
            "type": "string"
          },
          "date": {
            "format": "date-time",
            "description": "Delivery date",
            "type": "string"
          },
          "clubId": {
            "format": "int32",
            "description": "Sending club id",
            "type": "integer"
          }
        }
      }
    },
    "totalCount": {
      "format": "int32",
      "type": "integer"
    },
    "next": {
      "type": "string"
    },
    "previous": {
      "type": "string"
    }
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<CollectionResponse_NotificationsPushResponse_>
  <type>object</type>
  <properties>
    <results>
      <type>array</type>
      <items>
        <type>object</type>
        <properties>
          <content>
            <description>Push content</description>
            <type>string</type>
          </content>
          <date>
            <format>date-time</format>
            <description>Delivery date</description>
            <type>string</type>
          </date>
          <clubId>
            <format>int32</format>
            <description>Sending club id</description>
            <type>integer</type>
          </clubId>
        </properties>
      </items>
    </results>
    <totalCount>
      <format>int32</format>
      <type>integer</type>
    </totalCount>
    <next>
      <type>string</type>
    </next>
    <previous>
      <type>string</type>
    </previous>
  </properties>
</CollectionResponse_NotificationsPushResponse_>

Responses

Status Meaning Description Schema
200 OK OK CollectionResponse_NotificationsPushResponse_
422 Unprocessable Entity 422 ErrorResponse_ECommonResponseCode_

GET credit-card

Code samples

GET https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/members/payments/credit-cards HTTP/1.1
Host: api-frontend2.efitness.com.pl
Accept: application/json
client-request-id: [object Object]
member-token: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

GET /api/clubs/{clubId}/members/payments/credit-cards

Get a list of member credit card

Parameters

Name In Type Required Description
clubId path string true none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
member-token header string true Token used to authorize a club member.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "status": {
      "format": "int32",
      "description": "Credit card status: <br />  0 - Ok<br />  1 - NotAuthorized<br />  2 - ExpiredCard<br />  3 - InvalidCard<br />  4 - Lost<br />  5 - ExceededUseLimit<br />  6 - NoFundsAvailable<br />  7 - UnexpectedError<br />  8 - VoiceAuthorizationRequired<br />  9 - InvalidCardInformation<br />  10 - Blocked<br />  11 - InvalidTransaction<br />  12 - InvalidAuthorizationMessageInformation<br />  13 - Stolen<br />  14 - FraudSuspicion<br />  15 - NotActivated<br />  16 - InvalidCVV<br />  17 - TryAgainLater<br />  18 - Timeout<br />  19 - CardNotSupported<br />  20 - LimitedByBank<br />  21 - ClientResigned<br />  22 - NoPayment<br />  23 - TransactionCannotBeCompleted<br />  24 - StopPaymentOrder<br />  25 - RevocationOfAuthorization<br />  26 - StrongConsumerAuthenticationRequired<br />  27 - SecureNotAvailable<br />  28 - SecureAuthenticationFailed<br />  29 - BankIssue<br />  30 - AllowablePINExceeded<br />  31 - ProviderIssue<br />  32 - InterruptedRegistration<br />  33 - ClosedAccount",
      "type": "integer"
    },
    "statusDescription": {
      "description": "Card status description",
      "type": "string"
    },
    "valid": {
      "description": "Determines if the card is valid",
      "type": "boolean"
    },
    "validThruMonth": {
      "format": "int32",
      "description": "Card expiry month",
      "type": "integer"
    },
    "validThruYear": {
      "format": "int32",
      "description": "Card expiry year",
      "type": "integer"
    },
    "lastDigits": {
      "description": "Last four digits of the card number",
      "type": "string"
    }
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<CreditCardResponse>
  <type>object</type>
  <properties>
    <status>
      <format>int32</format>
      <description>Credit card status: <br>&nbsp;&nbsp;0 - Ok<br>&nbsp;&nbsp;1 - NotAuthorized<br>&nbsp;&nbsp;2 - ExpiredCard<br>&nbsp;&nbsp;3 - InvalidCard<br>&nbsp;&nbsp;4 - Lost<br>&nbsp;&nbsp;5 - ExceededUseLimit<br>&nbsp;&nbsp;6 - NoFundsAvailable<br>&nbsp;&nbsp;7 - UnexpectedError<br>&nbsp;&nbsp;8 - VoiceAuthorizationRequired<br>&nbsp;&nbsp;9 - InvalidCardInformation<br>&nbsp;&nbsp;10 - Blocked<br>&nbsp;&nbsp;11 - InvalidTransaction<br>&nbsp;&nbsp;12 - InvalidAuthorizationMessageInformation<br>&nbsp;&nbsp;13 - Stolen<br>&nbsp;&nbsp;14 - FraudSuspicion<br>&nbsp;&nbsp;15 - NotActivated<br>&nbsp;&nbsp;16 - InvalidCVV<br>&nbsp;&nbsp;17 - TryAgainLater<br>&nbsp;&nbsp;18 - Timeout<br>&nbsp;&nbsp;19 - CardNotSupported<br>&nbsp;&nbsp;20 - LimitedByBank<br>&nbsp;&nbsp;21 - ClientResigned<br>&nbsp;&nbsp;22 - NoPayment<br>&nbsp;&nbsp;23 - TransactionCannotBeCompleted<br>&nbsp;&nbsp;24 - StopPaymentOrder<br>&nbsp;&nbsp;25 - RevocationOfAuthorization<br>&nbsp;&nbsp;26 - StrongConsumerAuthenticationRequired<br>&nbsp;&nbsp;27 - SecureNotAvailable<br>&nbsp;&nbsp;28 - SecureAuthenticationFailed<br>&nbsp;&nbsp;29 - BankIssue<br>&nbsp;&nbsp;30 - AllowablePINExceeded<br>&nbsp;&nbsp;31 - ProviderIssue<br>&nbsp;&nbsp;32 - InterruptedRegistration<br>&nbsp;&nbsp;33 - ClosedAccount</description>
      <type>integer</type>
    </status>
    <statusDescription>
      <description>Card status description</description>
      <type>string</type>
    </statusDescription>
    <valid>
      <description>Determines if the card is valid</description>
      <type>boolean</type>
    </valid>
    <validThruMonth>
      <format>int32</format>
      <description>Card expiry month</description>
      <type>integer</type>
    </validThruMonth>
    <validThruYear>
      <format>int32</format>
      <description>Card expiry year</description>
      <type>integer</type>
    </validThruYear>
    <lastDigits>
      <description>Last four digits of the card number</description>
      <type>string</type>
    </lastDigits>
  </properties>
</CreditCardResponse>

Responses

Status Meaning Description Schema
200 OK OK CreditCardResponse
422 Unprocessable Entity 422 ErrorResponse_ECommonResponseCode_

PUT credit-card

Code samples

PUT https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/members/payments/credit-cards HTTP/1.1
Host: api-frontend2.efitness.com.pl
Content-Type: application/json
Accept: application/json
client-request-id: [object Object]
member-token: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

PUT /api/clubs/{clubId}/members/payments/credit-cards

Change credit card

Body parameter

{
  "required": [
    "successReturnUrl",
    "errorReturnUrl",
    "neutralReturnUrl"
  ],
  "type": "object",
  "properties": {
    "installmentIds": {
      "description": "IDs of selected installments",
      "type": "array",
      "items": {
        "format": "int32",
        "type": "integer"
      }
    },
    "chargeIds": {
      "description": "IDs of selected charges",
      "type": "array",
      "items": {
        "format": "int32",
        "type": "integer"
      }
    },
    "successReturnUrl": {
      "description": "Return url on success",
      "type": "string"
    },
    "errorReturnUrl": {
      "description": "Return url on failure",
      "type": "string"
    },
    "neutralReturnUrl": {
      "description": "Return url neutral",
      "type": "string"
    }
  }
}

required:
  - successReturnUrl
  - errorReturnUrl
  - neutralReturnUrl
type: object
properties:
  installmentIds:
    description: IDs of selected installments
    type: array
    items:
      format: int32
      type: integer
  chargeIds:
    description: IDs of selected charges
    type: array
    items:
      format: int32
      type: integer
  successReturnUrl:
    description: Return url on success
    type: string
  errorReturnUrl:
    description: Return url on failure
    type: string
  neutralReturnUrl:
    description: Return url neutral
    type: string


<?xml version="1.0" encoding="UTF-8" ?>
<RegisterCreditCardRequest>
  <required>successReturnUrl</required>
  <required>errorReturnUrl</required>
  <required>neutralReturnUrl</required>
  <type>object</type>
  <properties>
    <installmentIds>
      <description>IDs of selected installments</description>
      <type>array</type>
      <items>
        <format>int32</format>
        <type>integer</type>
      </items>
    </installmentIds>
    <chargeIds>
      <description>IDs of selected charges</description>
      <type>array</type>
      <items>
        <format>int32</format>
        <type>integer</type>
      </items>
    </chargeIds>
    <successReturnUrl>
      <description>Return url on success</description>
      <type>string</type>
    </successReturnUrl>
    <errorReturnUrl>
      <description>Return url on failure</description>
      <type>string</type>
    </errorReturnUrl>
    <neutralReturnUrl>
      <description>Return url neutral</description>
      <type>string</type>
    </neutralReturnUrl>
  </properties>
</RegisterCreditCardRequest>

Parameters

Name In Type Required Description
clubId path string true none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
member-token header string true Token used to authorize a club member.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.
body body RegisterCreditCardRequest true none

Example responses

200 Response

{
  "type": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<type>string</type>

Responses

Status Meaning Description Schema
200 OK OK string
422 Unprocessable Entity 422 ErrorResponse_CreditCardPaymentResponseCode_

POST credit-card

Code samples

POST https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/members/payments/credit-cards HTTP/1.1
Host: api-frontend2.efitness.com.pl
Content-Type: application/json
Accept: application/json
client-request-id: [object Object]
member-token: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

POST /api/clubs/{clubId}/members/payments/credit-cards

Add credit card

Body parameter

{
  "required": [
    "successReturnUrl",
    "errorReturnUrl",
    "neutralReturnUrl"
  ],
  "type": "object",
  "properties": {
    "installmentIds": {
      "description": "IDs of selected installments",
      "type": "array",
      "items": {
        "format": "int32",
        "type": "integer"
      }
    },
    "chargeIds": {
      "description": "IDs of selected charges",
      "type": "array",
      "items": {
        "format": "int32",
        "type": "integer"
      }
    },
    "successReturnUrl": {
      "description": "Return url on success",
      "type": "string"
    },
    "errorReturnUrl": {
      "description": "Return url on failure",
      "type": "string"
    },
    "neutralReturnUrl": {
      "description": "Return url neutral",
      "type": "string"
    }
  }
}

required:
  - successReturnUrl
  - errorReturnUrl
  - neutralReturnUrl
type: object
properties:
  installmentIds:
    description: IDs of selected installments
    type: array
    items:
      format: int32
      type: integer
  chargeIds:
    description: IDs of selected charges
    type: array
    items:
      format: int32
      type: integer
  successReturnUrl:
    description: Return url on success
    type: string
  errorReturnUrl:
    description: Return url on failure
    type: string
  neutralReturnUrl:
    description: Return url neutral
    type: string


<?xml version="1.0" encoding="UTF-8" ?>
<RegisterCreditCardRequest>
  <required>successReturnUrl</required>
  <required>errorReturnUrl</required>
  <required>neutralReturnUrl</required>
  <type>object</type>
  <properties>
    <installmentIds>
      <description>IDs of selected installments</description>
      <type>array</type>
      <items>
        <format>int32</format>
        <type>integer</type>
      </items>
    </installmentIds>
    <chargeIds>
      <description>IDs of selected charges</description>
      <type>array</type>
      <items>
        <format>int32</format>
        <type>integer</type>
      </items>
    </chargeIds>
    <successReturnUrl>
      <description>Return url on success</description>
      <type>string</type>
    </successReturnUrl>
    <errorReturnUrl>
      <description>Return url on failure</description>
      <type>string</type>
    </errorReturnUrl>
    <neutralReturnUrl>
      <description>Return url neutral</description>
      <type>string</type>
    </neutralReturnUrl>
  </properties>
</RegisterCreditCardRequest>

Parameters

Name In Type Required Description
clubId path string true none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
member-token header string true Token used to authorize a club member.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.
body body RegisterCreditCardRequest true none

Example responses

200 Response

{
  "type": "string"
}

<?xml version="1.0" encoding="UTF-8" ?>
<type>string</type>

Responses

Status Meaning Description Schema
200 OK OK string
422 Unprocessable Entity 422 ErrorResponse_CreditCardPaymentResponseCode_

DELETE credit-card

Code samples

DELETE https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/members/payments/credit-cards HTTP/1.1
Host: api-frontend2.efitness.com.pl
Accept: application/json
client-request-id: [object Object]
member-token: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

DELETE /api/clubs/{clubId}/members/payments/credit-cards

Delete credit card

Parameters

Name In Type Required Description
clubId path string true none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
member-token header string true Token used to authorize a club member.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.

Example responses

200 Response

{
  "format": "int32",
  "enum": [
    100,
    101,
    200,
    201,
    202,
    203,
    204,
    205,
    206,
    300,
    300,
    301,
    301,
    302,
    302,
    303,
    303,
    304,
    305,
    306,
    307,
    307,
    400,
    401,
    402,
    403,
    404,
    405,
    406,
    407,
    408,
    409,
    410,
    411,
    412,
    413,
    414,
    415,
    416,
    417,
    426,
    500,
    501,
    502,
    503,
    504,
    505
  ],
  "type": "integer"
}

<?xml version="1.0" encoding="UTF-8" ?>
<format>int32</format>
<enum>100</enum>
<enum>101</enum>
<enum>200</enum>
<enum>201</enum>
<enum>202</enum>
<enum>203</enum>
<enum>204</enum>
<enum>205</enum>
<enum>206</enum>
<enum>300</enum>
<enum>300</enum>
<enum>301</enum>
<enum>301</enum>
<enum>302</enum>
<enum>302</enum>
<enum>303</enum>
<enum>303</enum>
<enum>304</enum>
<enum>305</enum>
<enum>306</enum>
<enum>307</enum>
<enum>307</enum>
<enum>400</enum>
<enum>401</enum>
<enum>402</enum>
<enum>403</enum>
<enum>404</enum>
<enum>405</enum>
<enum>406</enum>
<enum>407</enum>
<enum>408</enum>
<enum>409</enum>
<enum>410</enum>
<enum>411</enum>
<enum>412</enum>
<enum>413</enum>
<enum>414</enum>
<enum>415</enum>
<enum>416</enum>
<enum>417</enum>
<enum>426</enum>
<enum>500</enum>
<enum>501</enum>
<enum>502</enum>
<enum>503</enum>
<enum>504</enum>
<enum>505</enum>
<type>integer</type>

Responses

Status Meaning Description Schema
200 OK OK integer
422 Unprocessable Entity 422 ErrorResponse_ECommonResponseCode_

POST credit-card transaction

Code samples

POST https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/members/payments/credit-cards/transactions HTTP/1.1
Host: api-frontend2.efitness.com.pl
Content-Type: application/json
Accept: application/json
client-request-id: [object Object]
member-token: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

POST /api/clubs/{clubId}/members/payments/credit-cards/transactions

Create credit card payment transaction for installments, charges, classes, wallet

Body parameter

{
  "type": "object",
  "properties": {
    "installmentIds": {
      "description": "Installment IDs",
      "type": "array",
      "items": {
        "format": "int32",
        "type": "integer"
      }
    },
    "chargeIds": {
      "description": "Charge Ids",
      "type": "array",
      "items": {
        "format": "int32",
        "type": "integer"
      }
    },
    "classReservationId": {
      "format": "int32",
      "description": "Class reservation Id",
      "type": "integer"
    },
    "walletChargeValue": {
      "format": "double",
      "description": "The value of the wallet charge",
      "type": "number"
    }
  }
}

type: object
properties:
  installmentIds:
    description: Installment IDs
    type: array
    items:
      format: int32
      type: integer
  chargeIds:
    description: Charge Ids
    type: array
    items:
      format: int32
      type: integer
  classReservationId:
    format: int32
    description: Class reservation Id
    type: integer
  walletChargeValue:
    format: double
    description: The value of the wallet charge
    type: number


<?xml version="1.0" encoding="UTF-8" ?>
<CreditCardPaymentRequest>
  <type>object</type>
  <properties>
    <installmentIds>
      <description>Installment IDs</description>
      <type>array</type>
      <items>
        <format>int32</format>
        <type>integer</type>
      </items>
    </installmentIds>
    <chargeIds>
      <description>Charge Ids</description>
      <type>array</type>
      <items>
        <format>int32</format>
        <type>integer</type>
      </items>
    </chargeIds>
    <classReservationId>
      <format>int32</format>
      <description>Class reservation Id</description>
      <type>integer</type>
    </classReservationId>
    <walletChargeValue>
      <format>double</format>
      <description>The value of the wallet charge</description>
      <type>number</type>
    </walletChargeValue>
  </properties>
</CreditCardPaymentRequest>

Parameters

Name In Type Required Description
clubId path string true none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
member-token header string true Token used to authorize a club member.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.
body body CreditCardPaymentRequest true Model request

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "creditCardResponseCode": {
      "format": "int32",
      "description": "Determines whether transaction is success or processed",
      "enum": [
        0,
        1,
        2
      ],
      "type": "integer"
    }
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<CreditCardPaymentOrderResponse>
  <type>object</type>
  <properties>
    <creditCardResponseCode>
      <format>int32</format>
      <description>Determines whether transaction is success or processed</description>
      <enum>0</enum>
      <enum>1</enum>
      <enum>2</enum>
      <type>integer</type>
    </creditCardResponseCode>
  </properties>
</CreditCardPaymentOrderResponse>

Responses

Status Meaning Description Schema
200 OK OK CreditCardPaymentOrderResponse
422 Unprocessable Entity 422 ErrorResponse_CreditCardPaymentResponseCode_

POST online-payments transaction

Code samples

POST https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/members/payments/online-payments/transactions HTTP/1.1
Host: api-frontend2.efitness.com.pl
Content-Type: application/json
Accept: application/json
client-request-id: [object Object]
member-token: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

POST /api/clubs/{clubId}/members/payments/online-payments/transactions

Create online payment order

Body parameter

{
  "type": "object",
  "properties": {
    "installmentIds": {
      "description": "Installment Ids",
      "type": "array",
      "items": {
        "format": "int32",
        "type": "integer"
      }
    },
    "chargeIds": {
      "description": "Charge Ids",
      "type": "array",
      "items": {
        "format": "int32",
        "type": "integer"
      }
    },
    "classReservationId": {
      "format": "int32",
      "description": "Class reservation Id",
      "type": "integer"
    },
    "walletChargeValue": {
      "format": "double",
      "description": "The value of the wallet charge",
      "type": "number"
    },
    "returnUrl": {
      "description": "Redirect url after payment passed",
      "type": "string"
    }
  }
}

type: object
properties:
  installmentIds:
    description: Installment Ids
    type: array
    items:
      format: int32
      type: integer
  chargeIds:
    description: Charge Ids
    type: array
    items:
      format: int32
      type: integer
  classReservationId:
    format: int32
    description: Class reservation Id
    type: integer
  walletChargeValue:
    format: double
    description: The value of the wallet charge
    type: number
  returnUrl:
    description: Redirect url after payment passed
    type: string


<?xml version="1.0" encoding="UTF-8" ?>
<OnlinePaymentRequest>
  <type>object</type>
  <properties>
    <installmentIds>
      <description>Installment Ids</description>
      <type>array</type>
      <items>
        <format>int32</format>
        <type>integer</type>
      </items>
    </installmentIds>
    <chargeIds>
      <description>Charge Ids</description>
      <type>array</type>
      <items>
        <format>int32</format>
        <type>integer</type>
      </items>
    </chargeIds>
    <classReservationId>
      <format>int32</format>
      <description>Class reservation Id</description>
      <type>integer</type>
    </classReservationId>
    <walletChargeValue>
      <format>double</format>
      <description>The value of the wallet charge</description>
      <type>number</type>
    </walletChargeValue>
    <returnUrl>
      <description>Redirect url after payment passed</description>
      <type>string</type>
    </returnUrl>
  </properties>
</OnlinePaymentRequest>

Parameters

Name In Type Required Description
clubId path string true none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
member-token header string true Token used to authorize a club member.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.
body body OnlinePaymentRequest true Model request

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "redirectUrl": {
      "description": "Provider based redirect url",
      "type": "string"
    }
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<OnlinePaymentResponse>
  <type>object</type>
  <properties>
    <redirectUrl>
      <description>Provider based redirect url</description>
      <type>string</type>
    </redirectUrl>
  </properties>
</OnlinePaymentResponse>

Responses

Status Meaning Description Schema
200 OK Payment order create OnlinePaymentResponse
422 Unprocessable Entity Model validation error ErrorResponse_EPaymentResponseCode_

POST photo

Code samples

POST https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/members/personal-photo HTTP/1.1
Host: api-frontend2.efitness.com.pl
Content-Type: application/json
Accept: application/json
client-request-id: [object Object]
member-token: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

POST /api/clubs/{clubId}/members/personal-photo

Uploading personal photo (made by member)

Body parameter

{
  "required": [
    "photoData"
  ],
  "type": "object",
  "properties": {
    "photoData": {
      "description": "Image encoded to Base64",
      "type": "string"
    }
  }
}

required:
  - photoData
type: object
properties:
  photoData:
    description: Image encoded to Base64
    type: string


<?xml version="1.0" encoding="UTF-8" ?>
<PersonalPhotoRequest>
  <required>photoData</required>
  <type>object</type>
  <properties>
    <photoData>
      <description>Image encoded to Base64</description>
      <type>string</type>
    </photoData>
  </properties>
</PersonalPhotoRequest>

Parameters

Name In Type Required Description
clubId path string true none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
member-token header string true Token used to authorize a club member.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.
body body PersonalPhotoRequest true Model request

Example responses

422 Response

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "responseCode": {
            "type": "string",
            "readOnly": true
          },
          "message": {
            "type": "string"
          },
          "path": {
            "type": "string"
          }
        }
      }
    }
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<ErrorResponse_MemberResponseCode_>
  <type>object</type>
  <properties>
    <errors>
      <type>array</type>
      <items>
        <type>object</type>
        <properties>
          <responseCode>
            <type>string</type>
            <readOnly>true</readOnly>
          </responseCode>
          <message>
            <type>string</type>
          </message>
          <path>
            <type>string</type>
          </path>
        </properties>
      </items>
    </errors>
  </properties>
</ErrorResponse_MemberResponseCode_>

Responses

Status Meaning Description Schema
200 OK Member personal photo updated successfully None
422 Unprocessable Entity Model validation error ErrorResponse_MemberResponseCode_

GET push-messages

Code samples

GET https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/members/push-messages HTTP/1.1
Host: api-frontend2.efitness.com.pl
Accept: application/json
client-request-id: [object Object]
member-token: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

GET /api/clubs/{clubId}/members/push-messages

Get a list of push-messages

Parameters

Name In Type Required Description
clubId path string true none
dateFrom query string(date-time) false none
dateTo query string(date-time) false none
limit query integer(int32) false none
offset query integer(int32) false none
sortBy query string false none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
member-token header string true Token used to authorize a club member.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "smsId": {
      "format": "int32",
      "description": "Sms id",
      "type": "integer"
    },
    "content": {
      "description": "Sms content",
      "type": "string"
    },
    "status": {
      "format": "int32",
      "description": "Sms status",
      "type": "integer"
    },
    "sendingDate": {
      "format": "date-time",
      "description": "Sms sending date",
      "type": "string"
    },
    "senderName": {
      "description": "Sms name of sender",
      "type": "string"
    }
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<SmsPushResponse>
  <type>object</type>
  <properties>
    <smsId>
      <format>int32</format>
      <description>Sms id</description>
      <type>integer</type>
    </smsId>
    <content>
      <description>Sms content</description>
      <type>string</type>
    </content>
    <status>
      <format>int32</format>
      <description>Sms status</description>
      <type>integer</type>
    </status>
    <sendingDate>
      <format>date-time</format>
      <description>Sms sending date</description>
      <type>string</type>
    </sendingDate>
    <senderName>
      <description>Sms name of sender</description>
      <type>string</type>
    </senderName>
  </properties>
</SmsPushResponse>

Responses

Status Meaning Description Schema
200 OK OK SmsPushResponse
422 Unprocessable Entity 422 ErrorResponse_ECommonResponseCode_

POST send-push-notification

Code samples

POST https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/members/send-push-notification HTTP/1.1
Host: api-frontend2.efitness.com.pl
Content-Type: application/json
Accept: application/json
client-request-id: [object Object]
member-token: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

POST /api/clubs/{clubId}/members/send-push-notification

send mobile app push notification using HttpV1 method

Body parameter

{
  "required": [
    "applicationName",
    "title",
    "message"
  ],
  "type": "object",
  "properties": {
    "applicationName": {
      "description": "Name of the application to which the notification is to be sent",
      "type": "string"
    },
    "title": {
      "description": "Title of notification",
      "type": "string"
    },
    "message": {
      "description": "Content of notification",
      "type": "string"
    }
  }
}

required:
  - applicationName
  - title
  - message
type: object
properties:
  applicationName:
    description: Name of the application to which the notification is to be sent
    type: string
  title:
    description: Title of notification
    type: string
  message:
    description: Content of notification
    type: string


<?xml version="1.0" encoding="UTF-8" ?>
<SendPushNotificationRequest>
  <required>applicationName</required>
  <required>title</required>
  <required>message</required>
  <type>object</type>
  <properties>
    <applicationName>
      <description>Name of the application to which the notification is to be sent</description>
      <type>string</type>
    </applicationName>
    <title>
      <description>Title of notification</description>
      <type>string</type>
    </title>
    <message>
      <description>Content of notification</description>
      <type>string</type>
    </message>
  </properties>
</SendPushNotificationRequest>

Parameters

Name In Type Required Description
clubId path string true none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
member-token header string true Token used to authorize a club member.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.
body body SendPushNotificationRequest true Model request

Example responses

422 Response

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "responseCode": {
            "type": "string",
            "readOnly": true
          },
          "message": {
            "type": "string"
          },
          "path": {
            "type": "string"
          }
        }
      }
    }
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<ErrorResponse_MemberResponseCode_>
  <type>object</type>
  <properties>
    <errors>
      <type>array</type>
      <items>
        <type>object</type>
        <properties>
          <responseCode>
            <type>string</type>
            <readOnly>true</readOnly>
          </responseCode>
          <message>
            <type>string</type>
          </message>
          <path>
            <type>string</type>
          </path>
        </properties>
      </items>
    </errors>
  </properties>
</ErrorResponse_MemberResponseCode_>

Responses

Status Meaning Description Schema
200 OK Mobile app push notification sent successfully None
422 Unprocessable Entity Model validation error ErrorResponse_MemberResponseCode_

GET, HEAD verify-cellphone

Code samples

HEAD https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/members/verify-cellphone?cellphone=type,string HTTP/1.1
Host: api-frontend2.efitness.com.pl

client-request-id: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

HEAD /api/clubs/{clubId}/members/verify-cellphone

Verify if member with cellphone exist

Parameters

Name In Type Required Description
cellphone query string true cellphone to verify
clubId path string true none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.

Responses

Status Meaning Description Schema
200 OK Verify if member with given cellphone exists None
404 Not Found Member with given cellphone does not exist None

GET, HEAD verify-email

Code samples

HEAD https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/members/verify-email?email=type,string HTTP/1.1
Host: api-frontend2.efitness.com.pl

client-request-id: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

HEAD /api/clubs/{clubId}/members/verify-email

Verify if member with email exist

Parameters

Name In Type Required Description
email query string true Email to verify
clubId path string true none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.

Responses

Status Meaning Description Schema
200 OK Verify if member with given email exists None
404 Not Found Member with given email does not exist None

GET wallet-transactions

Code samples

GET https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/members/wallet-transactions HTTP/1.1
Host: api-frontend2.efitness.com.pl
Accept: application/json
client-request-id: [object Object]
member-token: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

GET /api/clubs/{clubId}/members/wallet-transactions

Get a list of member wallet transactions

Parameters

Name In Type Required Description
clubId path string true none
limit query integer(int32) false none
offset query integer(int32) false none
sortBy query string false none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
member-token header string true Token used to authorize a club member.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "date": {
            "format": "date-time",
            "description": "Transaction date (yyyy-MM-dd HH:mm:ss)",
            "type": "string"
          },
          "description": {
            "description": "Transaction description",
            "type": "string"
          },
          "value": {
            "format": "double",
            "description": "Transaction value",
            "type": "number"
          }
        }
      }
    },
    "totalCount": {
      "format": "int32",
      "type": "integer"
    },
    "next": {
      "type": "string"
    },
    "previous": {
      "type": "string"
    }
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<CollectionResponse_WalletTransactionResponse_>
  <type>object</type>
  <properties>
    <results>
      <type>array</type>
      <items>
        <type>object</type>
        <properties>
          <date>
            <format>date-time</format>
            <description>Transaction date (yyyy-MM-dd HH:mm:ss)</description>
            <type>string</type>
          </date>
          <description>
            <description>Transaction description</description>
            <type>string</type>
          </description>
          <value>
            <format>double</format>
            <description>Transaction value</description>
            <type>number</type>
          </value>
        </properties>
      </items>
    </results>
    <totalCount>
      <format>int32</format>
      <type>integer</type>
    </totalCount>
    <next>
      <type>string</type>
    </next>
    <previous>
      <type>string</type>
    </previous>
  </properties>
</CollectionResponse_WalletTransactionResponse_>

Responses

Status Meaning Description Schema
200 OK OK CollectionResponse_WalletTransactionResponse_
422 Unprocessable Entity 422 ErrorResponse_ECommonResponseCode_

Membership

GET membership is accepted

Code samples

GET https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/members/memberships/{id}/status/accept HTTP/1.1
Host: api-frontend2.efitness.com.pl
Accept: application/json
client-request-id: [object Object]
member-token: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

GET /api/clubs/{clubId}/members/memberships/{id}/status/accept

Get information if membership is accepted by member

Parameters

Name In Type Required Description
id path integer(int32) true Id of membership
clubId path string true none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
member-token header string true Token used to authorize a club member.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "isAcceptedByMember": {
      "description": "Specifies when membership is accepted by member",
      "type": "boolean"
    }
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<AcceptMembershipStatusResponse>
  <type>object</type>
  <properties>
    <isAcceptedByMember>
      <description>Specifies when membership is accepted by member</description>
      <type>boolean</type>
    </isAcceptedByMember>
  </properties>
</AcceptMembershipStatusResponse>

Responses

Status Meaning Description Schema
200 OK OK AcceptMembershipStatusResponse
422 Unprocessable Entity 422 ErrorResponse_EMembershipResponseCode_

POST status

Code samples

POST https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/members/memberships/{id}/status/accept HTTP/1.1
Host: api-frontend2.efitness.com.pl
Content-Type: application/json
Accept: application/json
client-request-id: [object Object]
member-token: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

POST /api/clubs/{clubId}/members/memberships/{id}/status/accept

Change membership status to 'accepted'

Body parameter

{
  "required": [
    "deviceId"
  ],
  "type": "object",
  "properties": {
    "deviceId": {
      "description": "Device Id",
      "type": "string"
    }
  }
}

required:
  - deviceId
type: object
properties:
  deviceId:
    description: Device Id
    type: string


<?xml version="1.0" encoding="UTF-8" ?>
<AcceptMembershipRequest>
  <required>deviceId</required>
  <type>object</type>
  <properties>
    <deviceId>
      <description>Device Id</description>
      <type>string</type>
    </deviceId>
  </properties>
</AcceptMembershipRequest>

Parameters

Name In Type Required Description
id path integer(int32) true Membership ID
clubId path string true none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
member-token header string true Token used to authorize a club member.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.
body body AcceptMembershipRequest true Model request

Example responses

200 Response

{
  "format": "int32",
  "enum": [
    100,
    101,
    200,
    201,
    202,
    203,
    204,
    205,
    206,
    300,
    300,
    301,
    301,
    302,
    302,
    303,
    303,
    304,
    305,
    306,
    307,
    307,
    400,
    401,
    402,
    403,
    404,
    405,
    406,
    407,
    408,
    409,
    410,
    411,
    412,
    413,
    414,
    415,
    416,
    417,
    426,
    500,
    501,
    502,
    503,
    504,
    505
  ],
  "type": "integer"
}

<?xml version="1.0" encoding="UTF-8" ?>
<format>int32</format>
<enum>100</enum>
<enum>101</enum>
<enum>200</enum>
<enum>201</enum>
<enum>202</enum>
<enum>203</enum>
<enum>204</enum>
<enum>205</enum>
<enum>206</enum>
<enum>300</enum>
<enum>300</enum>
<enum>301</enum>
<enum>301</enum>
<enum>302</enum>
<enum>302</enum>
<enum>303</enum>
<enum>303</enum>
<enum>304</enum>
<enum>305</enum>
<enum>306</enum>
<enum>307</enum>
<enum>307</enum>
<enum>400</enum>
<enum>401</enum>
<enum>402</enum>
<enum>403</enum>
<enum>404</enum>
<enum>405</enum>
<enum>406</enum>
<enum>407</enum>
<enum>408</enum>
<enum>409</enum>
<enum>410</enum>
<enum>411</enum>
<enum>412</enum>
<enum>413</enum>
<enum>414</enum>
<enum>415</enum>
<enum>416</enum>
<enum>417</enum>
<enum>426</enum>
<enum>500</enum>
<enum>501</enum>
<enum>502</enum>
<enum>503</enum>
<enum>504</enum>
<enum>505</enum>
<type>integer</type>

Responses

Status Meaning Description Schema
200 OK Status changed successfully integer
422 Unprocessable Entity 422 ErrorResponse_EMembershipResponseCode_

GET memberships

Code samples

GET https://api-frontend2.efitness.com.pl/api/clubs/{clubId}/members/memberships HTTP/1.1
Host: api-frontend2.efitness.com.pl
Accept: application/json
client-request-id: [object Object]
member-token: [object Object]
api-access-token: [object Object]
accept-language: [object Object]

GET /api/clubs/{clubId}/members/memberships

Get a list of memberships

Parameters

Name In Type Required Description
clubId path string true none
toRangeStart query string(date-time) false 'membership.to' range start (yyyy-MM-dd HH:mm:ss)
toRangeEnd query string(date-time) false 'membership.to' range end (yyyy-MM-dd HH:mm:ss)
limit query integer(int32) false none
offset query integer(int32) false none
sortBy query string false none
client-request-id header string false Request id assigned by the client, specifying this value allows to obtain this value in the response header.
member-token header string true Token used to authorize a club member.
api-access-token header string true Token authorizing access to the API.
accept-language header string false Sets request culture, specifies messages language where supported.

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "membershipId": {
            "format": "int32",
            "description": "Id of membership",
            "type": "integer"
          },
          "membershipDefinitionID": {
            "format": "int32",
            "description": "Id of linked membership definition",
            "type": "integer"
          },
          "name": {
            "description": "Name of the membership definition",
            "type": "string"
          },
          "memberId": {
            "format": "int32",
            "description": "Id of member",
            "type": "integer"
          },
          "clubId": {
            "format": "int32",
            "description": "Id of club",
            "type": "integer"
          },
          "signed": {
            "format": "date-time",
            "description": "Signed date of the membership (yyyy-MM-dd HH:mm:ss)",
            "type": "string"
          },
          "from": {
            "format": "date-time",
            "description": "Start date of the membership (yyyy-MM-dd HH:mm:ss)",
            "type": "string"
          },
          "to": {
            "format": "date-time",
            "description": "End date of the membership (yyyy-MM-dd HH:mm:ss)",
            "type": "string",
            "readOnly": true
          },
          "isFrozen": {
            "description": "Specifies when membership is frozen",
            "type": "boolean"
          },
          "canFreeze": {
            "description": "Specifies when membership can be freeze",
            "type": "boolean"
          },
          "isRenunciated": {
            "description": "Specifies when membership is renunciated",
            "type": "boolean"
          },
          "isVindicated": {
            "description": "Specifies when membership is in vindication",
            "type": "boolean"
          },
          "canRenunciate": {
            "description": "Specifies when membership can be renunciated",
            "type": "boolean"
          },
          "canRenew": {
            "description": "Specifies when membership can be renewed",
            "type": "boolean"
          },
          "canCancelRenew": {
            "description": "Specifies when membership renewal can be canceled",
            "type": "boolean"
          },
          "hasServices": {
            "description": "Specifies when membership has services",
            "type": "boolean"
          },
          "isValid": {
            "description": "Determines if membership is valid",
            "type": "boolean"
          },
          "bankName": {
            "description": "Name of the bank supporting the payment",
            "type": "string"
          },
          "iban": {
            "description": "International bank account number IBAN",
            "type": "string"
          },
          "bic": {
            "description": "International code identifying the financial institution BIC",
            "type": "string"
          },
          "paymentForm": {
            "format": "int32",
            "description": "Name of the payment form: <br />  0 - cash<br />  1 - wallet<br />  2 - card<br />  3 - transfer<br />  4 - credit card<br />  6 - coupon<br />  7 - bonus points<br />  8 - online payment<br />  9 - direct debit<br />  10 - outer system<br />  11 - free pass<br />  12 - terminal recursion<br />  13 - mixed<br />  14 - vindication<br />  15 - amazon pay",
            "type": "integer"
          },
          "timeToRenew": {
            "format": "int32",
            "description": "Number of time periods to renew",
            "type": "integer"
          },
          "timeToRenewType": {
            "format": "int32",
            "description": "Period type: <br />  0 - Day<br />  1 - Week<br />  2 - Month<br />  3 - All<br />  4 - FourWeeks<br />  5 - Two