Sign in

v1

latestOpenAPI 3.0.02026-07-24226294602.4 KB
Class Sign-ins

Sign a Client into Class

Signs a Client into a specified Class

post/classes/{class_id}/clients/{client_id}/sign-in

Path parameters

class_idinteger required

Id of the Class to sign the client into

client_idinteger required

Id of the Client to sign into Class

Headers

x-api-keystring required

A valid api key. If you don't have one, please request one through the Web Integration screen.

Response

Created Class Sign-in

idinteger

Id of the Class Sign-in

client_idinteger

Id of the Signed-in Client

clientstring

Name of the signed-in Client

lead_idinteger

Id of the Signed-in Lead

leadstring

Name of the signed-in Lead

dropin_idinteger

Id of the Signed-in DropIn

dropinstring

Name of the signed-in DropIn

emailstring

Email of the signed-in Client/Lead

gender_idinteger

Gender Id of the signed-in Client/Lead

genderstring

Gender of the client/lead signed-in

class_idinteger

Id of the Class that the Sign-in is for

classstring

Name of the Class the Sign-in is for

sign_in_date_timestring date-time

Datetime of the sign-in

sign_in_source_idinteger

Source Id of the sign-in

sign_in_sourcestring

Source of the sign in

utc_class_start_datetimestring date-time

Date Time that the Class Starts (UTC)

local_class_start_datetimestring date-time

Date Time that the Class Starts (Local)

utc_class_end_datetimestring date-time

Date Time that the Class Ends (UTC)

local_class_end_datetimestring date-time

Date Time that the Class Ends (Local)

program_idinteger

Program Id of the Class

programstring

Program of the Class

location_idinteger

Location Id of the Class

locationstring

Location of the Class

membership_idinteger

Id of the Membership of the Client/Lead that applies to the Class Sign-in

membershipstring

Membership of the Client/Lead that applies to the Class Sign-in

online_membership_sale_idinteger

Id of the OnlineSale related to the sign-in. Only applicable if a free trial/drop-in booked from the Online Sales Portal.

is_drop_inboolean

Indicates if the Class Sign-in was for a drop-in

is_auto_sign_inboolean

Indicates if the sign-in occurred automatically

counts_towards_attendance_limitsboolean

Indicates if the sign-in counts towards the Memberships attendance limit

is_membership_enforcement_enabledboolean

Indicates if Membership enforcement is enabled at time of sign-in

limited_plan_enforcement_type_idinteger

Id of the enforcement type for Limited Class Plans at the time of sign-in

limited_plan_enforcement_typestring

Enforcement type for Limited Class Plans at the time of sign-in

class_pack_enforcement_type_idinteger

Id of the enforcement type for Class Packs at the time of sign-in

class_pack_enforcement_typestring

Enforcement type for Class Packs at the time of sign-in

is_attended_email_sentboolean

Indicates if the attended email was sent

wodify_validation_resultstring

The purpose of this attribute is to save any UserException message, that is, and user friendly message that should be shown to the end user. All methods should have, just like service actions:

  • an UserException with Abort Transaction = Yes, and a Log Error = No
  • an AllExceptions with Abort Transaction = Yes, and a Log Error = Yes With this, any known issue that we don't consider an error log, like a business validation, we raise it to be catch in the UserException and we don't log it. Then, in the OnResponse of the full REST service, the Build_Response_JSON action will take care on the output json format. An Exception will have the default formatted error message. If its an AllException, it will log the error so that we can fix it. If its a UserException, it will deliver as an error but it won't log it as an error. A success output will not have this attribute, the Build_Response_JSON will remove it from the final output.

Example response

{
  "id": 1234567891234567,
  "client_id": 1234567891234567,
  "lead_id": 1234567891234567,
  "dropin_id": 1234567891234567,
  "gender_id": 1234567891234567,
  "class_id": 1234567891234567,
  "sign_in_date_time": "2014-12-31T23:59:59.938Z",
  "sign_in_source_id": 1234567891234567,
  "utc_class_start_datetime": "2014-12-31T23:59:59.938Z",
  "local_class_start_datetime": "2014-12-31T23:59:59.938Z",
  "utc_class_end_datetime": "2014-12-31T23:59:59.938Z",
  "local_class_end_datetime": "2014-12-31T23:59:59.938Z",
  "program_id": 1234567891234567,
  "location_id": 1234567891234567,
  "coaches": {
    "coach_id": 1234567891234567,
    "payroll_position_id": 1234567891234567
  },
  "membership_id": 1234567891234567,
  "online_membership_sale_id": 1234567891234567,
  "limited_plan_enforcement_type_id": 1234567891234567,
  "class_pack_enforcement_type_id": 1234567891234567,
  "created": {
    "created_by_id": 1234567891234567,
    "created_on_datetime": "2014-12-31T23:59:59.938Z"
  },
  "updated": {
    "updated_by_id": 1234567891234567,
    "updated_on_datetime": "2014-12-31T23:59:59.938Z"
  }
}