Logs the user in using its credentials

Info

icon	false

Status


colour	Green
title	POST

/login

Request

Expand

Request

Endpoint: /login

Method:

Status


colour	Green
title	POST

Only logged in:

Status


colour	Red
title	NO

Account privilege restriction: No restriction

Headers:

Expand

Header name	Value
X-Requested-With	XMLHttpRequest

Parameters:

Expand

Parameter

Required

Type

Description

username

Status


subtle	true
colour	Green
title	YES

String

Username or email of the user

password

Status


subtle	true
colour	Green
title	YES

String

Password of the account

Response

Expand

Response

Http Code

Response

Description

Status

colour	Blue
title	200

Expand

title	Success response

Code Block

title	Success response
linenumbers	true

 {
    "success": 1,
    "message": "xxxxxxxx-1111-2222-3333-xxxxxxxxxxxx",
    "user_data": {
        "id": 4,
        "full_name": "John Doe",
        "username": "johndoe",
        "date_of_birth": "1988-12-05",
        "email": "johndoe@glitch.ro",
        "address": "-",
        "phone": "0700000000",
        "privilege": 5,
        "locale": "ro",
        "activation_token": null,
        "id_card_number": "1234",
        "club_id": null,
        "strikes": 2,
        "locked": null,
        "eula_accepted": "2018-05-17 18:01:04",
        "created_at": "2017-12-06 17:28:02",
        "updated_at": "2018-05-17 18:01:04",
        "banned_at": null,
        "sex": 1,
        "unique_number": "-",
        "id_document_serie": "-",
        "id_document_number": "-",
        "account_creation_by": 1,
        "trainer_id": 10,
        "is_trainer": 0,
		"has_scale_active": true
    }
}

Expand

title	Error response

Code Block

title	Success response
linenumbers	true

{
    "success": 0,
    "message": "Username / password invalid!"
}

Success response

Expand

title	Object Description

Base object:

Object property	Description
success	Represents if the login was successful
message	Login token used for logged in API calls / error message
user_data	User data object

User data object:

Object property	Description
id	Internal ID of the user
full_name	User full name
username	User username
date_of_birth	User date of birth (Y-m-d format)
email	User email
address	User address
phone	User phone number
privilege	User privilege: 1 - Root 2 - Club manager 3 - Administrator / reception 4 - Trainer 5 - Member
locale	User locale: ro - Romanian en - English
activation_token	Internal usage - will ALWAYS be null
id_card_number	Check-in number for gatekeeper
club_id	Used for club managers and administrators to indicate the club they belong to. Otherwise it will be null
strikes	How many no shows it has at that moment that will be counted towards ban
locked	Indicates if the account was banned or not - will always be null
eula_accepted	Indicates the date and time when the user accepted the license agreement.
created_at	Date and time when the user was created at
updated_at	Date and time when the user was last updated at
banned_at	Date and time when the user was banned due to too many no-shows. Null if not banned.
sex	User sex: 1 - Male 2 - Female 3 - Other
unique_number	User ID number from personal citizenship ID card
id_document_serie	User personal citizenship ID card document serie
id_document_number	User personal citizenship ID card document number
account_creation_by	The way the account was created: 1 - Admin 2 - Self signup 3 - Invite 4 - CSV Import
trainer_id	Trainer assigned to the user
is_trainer	Indicates if the user is a trainer (used to override manager and admin privilege in case they are also trainers)
has_scale_active	Indicates if the current user has an active scale / survey. If true, the Get scale endpoint should be called.

Status

colour	Red
title	422

Expand

Code Block

title	Error response
linenumbers	true

{
  "success": 0
}

Error

Get user data

Returns user data of the logged in user..

Info

icon	false

Status


colour	Yellow
title	GET

/user

Warning
Account privilege restriction: Any logged in account

Request

Expand

Request

Endpoint: /user

Method:

Status


colour	Yellow
title	GET

Only logged in:

Status

colour	Green
title	YES

Account privilege restriction: Any privilege

Headers:

Expand

Header name	Value
X-Requested-With	XMLHttpRequest
X-Auth-Token	Token obtained from Login endpoint

Response

Expand

Response

Http Code

Response

Description

Status

colour	Blue
title	200

Expand

title	Success response

Code Block

title	Success response
linenumbers	true

{
    "success": 1,
    "user_data": {
        "id": 4,
        "full_name": "John Deux",
        "username": "johnd",
        "date_of_birth": "2017-12-05",
        "email": "johndeux@acme.com",
        "address": "-",
        "phone": "0712345678",
        "privilege": 5,
        "locale": "ro",
        "id_card_number": "7194",
        "club_id": null,
        "strikes": 2,
        "locked": null,
        "eula_accepted": "2018-05-17 18:01:04",
        "created_at": "2017-12-06 17:28:02",
        "updated_at": "2018-05-17 18:33:07",
        "banned_at": null,
        "sex": 1,
        "unique_number": "-",
        "id_document_serie": "-",
        "id_document_number": "-",
        "account_creation_by": 1,
        "trainer_id": 10,
        "is_trainer": 0,
		"has_scale_active": true
    }
}

Success response

Expand

title	Base Object

Base object:

Object property	Description
success	Represents if the call was successful
user_data	Represents the user data

Expand

title	User_data object

User_data object:

Object property	Description
id	Internal ID of the user
full_name	Full name of the user
username	Username
date_of_birth	Date of birth
Email	Email
address	Address of the user
phone	Phone of the user
privilege	User privilege: 1 - Root 2 - Club manager 3 - Club administrator / reception 4 - Trainer 5 - Member
locale	User current locale
id_card_number	User unique card number (or gatekeeper key)
club_id	User for club manager / club administrator to see to which club he belongs to
strikes	How many no shows he has
locked	Shows if the account is locked by an admin
eula_accepted	Date and time for when the user accepted the club license agreement
created_at	Date and time for when the user was created
updated_at	Date and time for when the user was last updated
banned_at	Date and time for when the user was banned for noshows
sex	Gender of the user 1 - Male 2 - Female 3 - Other
unique_number	User unique citizenship / passport number
id_document_serie	User unique citizenship / passport document serie
id_document_number	User unique citizenship / passport document number
account_creation_by	Shows by whom the account was created: 1 - Admin 2 - Self signup 3 - Invite 4 - CSV import
trainer_id	The ID of the trainer which is assigned to him
is_trainer	Flag showing if the user has access to trainer tools or not
has_scale_active	Indicates if the current user has an active scale / survey. If true, the Get scale endpoint should be called.

Status


colour	Red
title	403

Code Block
Forbidden

User cannot access the resource

Change email address

Changes the logged in users' email address

Info

icon	false

Status


colour	Green
title	POST

/user/email

Warning
Account privilege restriction: Any logged in account

Request

Expand

Request

Endpoint: /user/email

Method:

Status


colour	Green
title	POST

Only logged in:

Status

colour	Green
title	YES

Account privilege restriction: Any privilege

Headers:

Expand

Header name	Value
X-Requested-With	XMLHttpRequest
X-Auth-Token	Token obtained from Login endpoint

Parameters:

Expand

Parameter

Required

Type

Description

email

Status


subtle	true
colour	Green
title	YES

String

New email

Response

Expand

Response

Http Code

Response

Description

Status

colour	Blue
title	200

Expand

title	Success response

Code Block

title	Success response
linenumbers	true

{
    "success": 1
}

Success response

Expand

title	Object Description

Base object:

Object property	Description
success	Represents if the call was successful

Status


colour	Red
title	403

Code Block
Forbidden

User cannot access the resource

Status

colour	Red
title	422

Expand

Code Block

title	Error response
linenumbers	true

{
    "message": "The given data was invalid.",
    "errors": {
        "email": [
            "The email has already been taken."
        ]
    }
}

Error

Change address

Changes the logged in users' address

Info

icon	false

Status


colour	Green
title	POST

/user/address

Warning
Account privilege restriction: Any logged in account

Request

Expand

Request

Endpoint: /user/address

Method:

Status


colour	Green
title	POST

Only logged in:

Status

colour	Green
title	YES

Account privilege restriction: Any privilege

Headers:

Expand

Header name	Value
X-Requested-With	XMLHttpRequest
X-Auth-Token	Token obtained from Login endpoint

Parameters:

Expand

Parameter

Required

Type

Description

address

Status


subtle	true
colour	Green
title	YES

String

New address

Response

Expand

Response

Http Code

Response

Description

Status

colour	Blue
title	200

Expand

title	Success response

Code Block

title	Success response
linenumbers	true

{
    "success": 1
}

Success response

Expand

title	Object Description

Base object:

Object property	Description
success	Represents if the call was successful

Status


colour	Red
title	403

Code Block
Forbidden

User cannot access the resource

Status

colour	Red
title	422

Expand

Code Block

title	Error response
linenumbers	true

{
    "message": "The given data was invalid.",
    "errors": {
        ...
    }
}

Error

Change phone number

Changes the logged in users' phone number

Info

icon	false

Status


colour	Green
title	POST

/user/phone

Warning
Account privilege restriction: Any logged in account

Request

Expand

Request

Endpoint: /user/phone

Method:

Status


colour	Green
title	POST

Only logged in:

Status

colour	Green
title	YES

Account privilege restriction: Any privilege

Headers:

Expand

Header name	Value
X-Requested-With	XMLHttpRequest
X-Auth-Token	Token obtained from Login endpoint

Parameters:

Expand

Parameter

Required

Type

Description

phone

Status


subtle	true
colour	Green
title	YES

String

New phone number

Response

Expand

Response

Http Code

Response

Description

Status

colour	Blue
title	200

Expand

title	Success response

Code Block

title	Success response
linenumbers	true

{
    "success": 1
}

Success response

Expand

title	Object Description

Base object:

Object property	Description
success	Represents if the call was successful

Status


colour	Red
title	403

Code Block
Forbidden

User cannot access the resource

Status

colour	Red
title	422

Expand

Code Block

title	Error response
linenumbers	true

{
    "message": "The given data was invalid.",
    "errors": {
        ...
    }
}

Error

Change password

Changes the logged in users' phone number

Info

icon	false

Status


colour	Green
title	POST

/user/password

Warning
Account privilege restriction: Any logged in account

Request

Expand

Request

Endpoint: /user/password

Method:

Status


colour	Green
title	POST

Only logged in:

Status

colour	Green
title	YES

Account privilege restriction: Any privilege

Headers:

Expand

Header name	Value
X-Requested-With	XMLHttpRequest
X-Auth-Token	Token obtained from Login endpoint

Parameters:

Expand

Parameter

Required

Type

Description

password

Status


subtle	true
colour	Green
title	YES

String

New password

password_confirmation

Status


subtle	true
colour	Green
title	YES

String

New password confirmation

Response

Expand

Response

Http Code

Response

Description

Status

colour	Blue
title	200

Expand

title	Success response

Code Block

title	Success response
linenumbers	true

{
    "success": 1
}

Success response

Expand

title	Object Description

Base object:

Object property	Description
success	Represents if the call was successful

Status


colour	Red
title	403

Code Block
Forbidden

User cannot access the resource

Status

colour	Red
title	422

Expand

Code Block

title	Error response
linenumbers	true

{
    "message": "The given data was invalid.",
    "errors": {
        ...
    }
}

Error

Change user check-in key

Changes the users check-in key with a new randomly generated one.

Warning
Gatekeeper enabled instances, only!

Info

icon	false

Status


colour	Green
title	POST

/user/id_card

Warning
Account privilege restriction: Any logged in account

Request

Expand

Request

Endpoint: /user/id_card

Method:

Status


colour	Green
title	POST

Only logged in:

Status

colour	Green
title	YES

Account privilege restriction: Any privilege

Headers:

Expand

Header name	Value
X-Requested-With	XMLHttpRequest
X-Auth-Token	Token obtained from Login endpoint

Parameters:

Expand

Parameter

Required

Type

Description

id

Status


subtle	true
colour	Green
title	YES

Integer

ID of the user for which to change the ID card number

Warning
This parameter is only taken in account if the current user is admin or above

Response

Expand

Response

Http Code

Response

Description

Status

colour	Blue
title	200

Expand

title	Success response

Code Block

title	Success response
linenumbers	true

{
    "success": 1,
    "key": 1300
}

Success response

Expand

title	Object Description

Base object:

Object property	Description
success	Represents if the call was successful
key	Represents the new check-in key

Status

colour	Blue
title	200

Expand

title	Success response

Code Block

title	Success response
linenumbers	true

{
    "success": 0
}

The instance is not Gatekeeper enabled

Status


colour	Red
title	403

Code Block
Forbidden

User cannot access the resource

Status

colour	Red
title	422

Expand

Code Block

title	Error response
linenumbers	true

{
    "message": "The given data was invalid.",
    "errors": {
        ...
    }
}

Error

Reset password

Sends the reset password link to the user email

Info

icon	false

Status


colour	Green
title	POST

/reset_password

Request

Expand

Request

Endpoint: /reset_password

Method:

Status


colour	Green
title	POST

Only logged in:

Status


colour	Red
title	NO

Account privilege restriction: No restriction

Headers:

Expand

Header name	Value
X-Requested-With	XMLHttpRequest

Parameters:

Expand

Parameter

Required

Type

Description

email

Status


subtle	true
colour	Green
title	YES

String

User registered email

site_integration

Status


subtle	true
colour	Red
title	NO

Integer

Sets if the link sent to reset the password should be on the gym's site or not.

Possible values:

0 - Normal email
1 - Email link sends to personalized web page on gym website

Info
The link to the custom page can be set by the root privileged user in the application settings page under the integrations tab.

Response

Expand

Response

Http Code

Response

Description

Status

colour	Blue
title	200

Expand

title	Success response

Code Block

title	Success response
linenumbers	true

{
    "success": 1
}

Success response

Expand

title	Object Description

Base object:

Object property	Description
success	Represents if the call was successful

Status


colour	Red
title	403

Code Block
Forbidden

User cannot access the resource

Status

colour	Red
title	422

Expand

Code Block

title	Error response
linenumbers	true

{
    "message": "The given data was invalid.",
    "errors": {
        ...
    }
}

Error

Reset password change (via token)

Changes the user password via the token gotten from email

Info

icon	false

Status


colour	Green
title	POST

/reset_password_change

Request

Expand

Request

Endpoint: /reset_password_change

Method:

Status


colour	Green
title	POST

Only logged in:

Status


colour	Red
title	NO

Account privilege restriction: No restriction

Headers:

Expand

Header name	Value
X-Requested-With	XMLHttpRequest

Parameters:

Expand

Parameter

Required

Type

Description

key

Status


subtle	true
colour	Green
title	YES

String

Token got via email

password

Status


subtle	true
colour	Green
title	YES

String

New password

password_confirmation

Status


subtle	true
colour	Green
title	YES

String

New password confirmation

Response

Expand

Response

Http Code

Response

Description

Status

colour	Blue
title	200

Expand

title	Success response

Code Block

title	Success response
linenumbers	true

{
    "success": 1
}

Success response

Expand

title	Object Description

Base object:

Object property	Description
success	Represents if the call was successful

Status


colour	Red
title	403

Code Block
Forbidden

User cannot access the resource

Status

colour	Red
title	422

Expand

Code Block

title	Error response
linenumbers	true

{
    "message": "The given data was invalid.",
    "errors": {
        ...
    }
}

Error

Version	Old Version 18	New Version 19
Changes made by	Flaviu Porutiu	Flaviu Porutiu
Saved on	Jul 25, 2018	Jul 25, 2018

Versions Compared

Key

Request

Response

Get user data

Request

Response

Change email address

Request

Response

Change address

Request

Response

Change phone number

Request

Response

Change password

Request

Response

Change user check-in key

Request

Response

Reset password

Request

Response

Reset password change (via token)

Request

Response

Page Comparison

Versions Compared

Key

Log in

Request

Response

Get user data

Request

Response

Change email address

Request

Response

Change address

Request

Response

Change phone number

Request

Response

Change password

Request

Response

Change user check-in key

Request

Response

Reset password

Request

Response

Reset password change (via token)

Request

Response