האובייקט Member

מאפיינים

  • member_id string חובה

    מזהה ייחודי של החבר.

  • facility_id string אחד מהשנייםספקו את סוג מזהה המתקן שהוגדר לאינטגרציה שלכם: השתמשו ב-facility_id לאינטגרציות מסוג direct-link, או ב-linking_identifier לאינטגרציות מסוג linking-identifier. אל תשלחו את שניהם; ה-API משתמש בסוג המזהה שהוגדר לחשבון השותף שלכם ומתעלם מהסוג האחר. מידע נוסף

    המזהה הייחודי של המתקן מ-Performance Hub.

  • linking_identifier string אחד מהשנייםספקו את סוג מזהה המתקן שהוגדר לאינטגרציה שלכם: השתמשו ב-facility_id לאינטגרציות מסוג direct-link, או ב-linking_identifier לאינטגרציות מסוג linking-identifier. אל תשלחו את שניהם; ה-API משתמש בסוג המזהה שהוגדר לחשבון השותף שלכם ומתעלם מהסוג האחר. מידע נוסף

    ערך המזהה הייחודי שהשותף משתמש בו לכל מיקום (לדוגמה, "Branch ID", "Location Code", "Store Number"). מידע נוסף

  • first_name string חובה

    השם הפרטי של החבר.

  • last_name string חובה

    שם המשפחה של החבר.

  • email string אופציונלי

    כתובת דוא"ל.

  • mobile_phone string אופציונלי

    מספר טלפון נייד בפורמט E.123 (לדוגמה, "+1 415 555 2671").

  • address object אופציונלי

    אובייקט כתובת פיזית עם המאפיינים הבאים:

    • address_line_1 (string) - כתובת הרחוב הראשית
    • address_line_2 (string, optional) - שורת כתובת משנית
    • city (string) - שם העיר
    • state (string) - קוד המדינה/המחוז
    • postal_code (string) - מיקוד
    • country (string) - קוד מדינה לפי ISO 3166-1 alpha-2 (לדוגמה, "AU", "US")
    • country_name (string, optional) - שם המדינה המלא
  • date_of_birth string אופציונלי

    תאריך לידה בפורמט YYYY-MM-DD.

  • gender string אופציונלי

    אחד מהערכים male, female, non_binary, prefer_not_to_say או unknown.

  • type string אופציונלי

    סוג החבר (לדוגמה, staff, member, prospect).

  • tags array אופציונלי

    מחרוזות או טקסטים קצרים לסיווג וזיהוי של חברים מסוימים (לדוגמה, ["vip", "personal-training", "student"]).

  • membership_status string אופציונלי

    סטטוס החברות הנוכחי (לדוגמה, active, expired, on_hold).

  • membership_plans array אופציונלי

    מערך של תוכניות החברות המשויכות לחבר.

  • profile_picture string אופציונלי

    תמונת פרופיל בקידוד Base64 (אופציונלי).

  • created string אופציונלי

    חותמת זמן בפורמט ISO 8601 של מועד יצירת החבר.

  • updated string אופציונלי

    חותמת זמן בפורמט ISO 8601 של מועד העדכון האחרון של החבר.

  • access_time_windows array אופציונלי

    תמונת מצב מלאה, ששייכת למקור, של Access Time Windows מוחלטים ו/או שבועיים חוזרים. השמיטו את השדה כדי להשאיר את תמונת המצב ללא שינוי; שלחו מערך ריק עם גרסה חדשה יותר כדי לשלול אותה. למבנים, לאימות, למיפוי הטווחים ולסמנטיקת ההחלפה, ראו Access Time Windows.

  • access_time_windows_revision integer חובה עם access_time_windows

    מספר שלם אי-שלילי, בטוח לשימוש ב-JSON, שעולה באופן מונוטוני בזרם של החבר/המקור הזה. חובה בכל פעם ש-access_time_windows קיים.

האובייקט Member

{
  "member_id": "member_11111",
  "facility_id": "550e8400-e29b-41d4-a716-446655440000",
  // "linking_identifier": "branch_downtown",  // If using linking identifier
  "first_name": "John",
  "last_name": "Smith",
  "email": "john.smith@example.com",
  "mobile_phone": "+61 412 345 678",
  "date_of_birth": "1985-06-15",
  "gender": "male",
  "type": "member",
  "tags": ["vip", "personal-training"],
  "profile_picture": "/9j/4AAQSkZJRgABAQAAAQ...",
  "membership_status": "current",
  "created": "2024-01-15T10:30:00Z",
  "updated": "2024-01-20T14:45:00Z",
  "access_time_windows_revision": 1842,
  "access_time_windows": [
    {
      "external_id": "access-4b1782",
      "kind": "absolute",
      "from": 1792053000,
      "to": 1792058400,
      "timezone": "Australia/Perth",
      "scope_key": "after_hours_entry",
      "label": "Temporary site access"
    }
  ],
  "address": {
    "address_line_1": "456 Bourke Street",
    "address_line_2": "Apt 12",
    "city": "Melbourne",
    "state": "VIC",
    "postal_code": "3000",
    "country": "AU",
    "country_name": "Australia"
  },
  "membership_plans": [
    {
      "membership_plan_id": "plan_99999",
      "name": "Unlimited Monthly",
      "start_date": "2024-01-01T00:00:00Z",
      "status": "current",
      "is_current": true,
      "end_date": null
    }
  ]
}