האובייקט 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
}
]
}