Đối tượng Member
Thuộc tính
-
member_id
stringbắt buộcMã định danh duy nhất của hội viên.
-
facility_id
stringmột trong haiCung cấp loại mã định danh cơ sở được cấu hình cho tích hợp của bạn: dùng facility_id cho tích hợp liên kết trực tiếp, hoặc linking_identifier cho tích hợp dùng mã định danh liên kết. Không gửi cả hai; API sử dụng loại mã định danh được cấu hình cho tài khoản đối tác của bạn và bỏ qua loại còn lại. Tìm hiểu thêmMã định danh duy nhất của cơ sở trong Performance Hub.
-
linking_identifier
stringmột trong haiCung cấp loại mã định danh cơ sở được cấu hình cho tích hợp của bạn: dùng facility_id cho tích hợp liên kết trực tiếp, hoặc linking_identifier cho tích hợp dùng mã định danh liên kết. Không gửi cả hai; API sử dụng loại mã định danh được cấu hình cho tài khoản đối tác của bạn và bỏ qua loại còn lại. Tìm hiểu thêmGiá trị mã định danh duy nhất mà đối tác dùng cho từng địa điểm (ví dụ: "Branch ID", "Location Code", "Store Number"). Tìm hiểu thêm
-
first_name
stringbắt buộcTên của hội viên.
-
last_name
stringbắt buộcHọ của hội viên.
-
email
stringtùy chọnĐịa chỉ email.
-
mobile_phone
stringtùy chọnSố điện thoại di động theo định dạng E.123 (ví dụ:
"+1 415 555 2671"). -
address
objecttùy chọnĐối tượng địa chỉ thực tế với các thuộc tính sau:
address_line_1(string) - Địa chỉ đường phố chínhaddress_line_2(string, optional) - Dòng địa chỉ phụcity(string) - Tên thành phốstate(string) - Mã bang/tỉnhpostal_code(string) - Mã bưu chính/ZIPcountry(string) - Mã quốc gia ISO 3166-1 alpha-2 (ví dụ: "AU", "US")country_name(string, optional) - Tên quốc gia đầy đủ
-
date_of_birth
stringtùy chọnNgày sinh theo định dạng
YYYY-MM-DD. -
gender
stringtùy chọnMột trong các giá trị
male,female,non_binary,prefer_not_to_sayhoặcunknown. -
type
stringtùy chọnLoại hội viên (ví dụ:
staff,member,prospect). -
tags
arraytùy chọnCác chuỗi hoặc văn bản hỗ trợ nhanh để phân loại và nhận diện các hội viên cụ thể (ví dụ:
["vip", "personal-training", "student"]). -
membership_status
stringtùy chọnTrạng thái hội viên hiện tại (ví dụ:
active,expired,on_hold). -
membership_plans
arraytùy chọnMảng các gói hội viên gắn với hội viên.
-
profile_picture
stringtùy chọnẢnh hồ sơ được mã hóa Base64 (không bắt buộc).
-
created
stringtùy chọnDấu thời gian ISO 8601 khi hội viên được tạo.
-
updated
stringtùy chọnDấu thời gian ISO 8601 khi hội viên được cập nhật lần gần nhất.
-
access_time_windows
arraytùy chọnẢnh chụp nhanh đầy đủ thuộc nguồn, gồm các Access Time Windows tuyệt đối và/hoặc lặp lại hằng tuần. Bỏ qua trường này để giữ nguyên ảnh chụp nhanh; gửi một mảng rỗng với phiên bản mới hơn để thu hồi. Xem Access Time Windows để biết về cấu trúc, kiểm tra dữ liệu, ánh xạ phạm vi và ngữ nghĩa thay thế.
-
access_time_windows_revision
integerbắt buộc khi có access_time_windowsSố nguyên không âm, tăng đơn điệu, an toàn với JSON cho chuỗi của hội viên/nguồn này. Bắt buộc bất cứ khi nào có
access_time_windows.
Đối tượng 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
}
]
}