मुख्य सामग्री पर जाएं

सदस्यता एंडपॉइंट

Membership मॉड्यूल लोगों, चर्चों, समूहों, परिवारों, भूमिकाओं, अनुमतियों, फ़ॉर्म और सेटिंग्स का प्रबंधन करता है। यह सबसे बड़ा मॉड्यूल है और सभी अन्य मॉड्यूल के लिए मुख्य पहचान और प्राधिकरण परत प्रदान करता है।

बेस पथ: /membership

लोग

बेस पथ: /membership/people

MethodPathAuthPermissionविवरण
GET/JWTPeople.View या Memberचर्च के सभी लोग सूचीबद्ध करें
GET/:idJWTPeople.View या अपना रिकॉर्डID द्वारा व्यक्ति प्राप्त करें (फ़ॉर्म सबमिशन सहित)
GET/ids?ids=JWTPeople.View या Memberकॉमा-सेपरेटेड ID द्वारा कई लोग प्राप्त करें
GET/basic?ids=JWTकई लोगों की बुनियादी जानकारी (केवल नाम) प्राप्त करें
GET/recentJWTPeople.View या Memberहाल ही में जोड़े गए लोग
GET/search?term=&email=JWTPeople.View या Memberनाम या ईमेल द्वारा लोग खोजें
GET/search/phone?number=JWTPeople.View या Memberफ़ोन नंबर द्वारा खोजें
GET/search/group?groupId=JWTPeople.View या Memberविशिष्ट समूह में लोग प्राप्त करें
GET/household/:householdIdJWTपरिवार के सभी लोग प्राप्त करें
GET/attendanceJWTPeople.Editफ़िल्टर के साथ उपस्थित लोग लोड करें (campusId, serviceId, serviceTimeId, groupId, categoryName, startDate, endDate)
GET/timeline?personIds=&groupIds=JWTलोगों और समूहों के लिए टाइमलाइन डेटा लोड करें
GET/directory/:idJWTडायरेक्टरी दृश्य के लिए व्यक्ति प्राप्त करें (दृश्यता प्राथमिकताओं का सम्मान करता है)
GET/claim/:churchIdJWTचर्च पर वर्तमान उपयोगकर्ता के लिए व्यक्ति रिकॉर्ड दावा करें
POST/JWTPeople.Edit या EditSelfलोग बनाएँ या अपडेट करें (बैच)
POST/searchJWTPeople.View या Memberलोग खोजें (POST वेरिएंट)
POST/advancedSearchJWTPeople.View या Memberबहु-शर्त खोज (आयु, जन्म माह, सदस्यता स्थिति, आदि)
POST/loadOrCreatePublicईमेल द्वारा व्यक्ति खोजें या बनाएँ। बॉडी: { churchId, email, firstName, lastName }
POST/household/:householdIdJWTPeople.Editपरिवार सदस्य असाइनमेंट अपडेट करें
POST/public/emailPublicव्यक्ति को ईमेल भेजें। बॉडी: { churchId, personId, subject, body, appName }
POST/apiEmailsInternalID द्वारा व्यक्ति ईमेल लोड करें (सर्वर-टू-सर्वर, jwtSecret आवश्यक)
DELETE/:idJWTPeople.Editव्यक्ति हटाएँ

उदाहरण: लोग खोजें

GET /membership/people/search?term=John
Authorization: Bearer <token>
[
{
"id": "abc-123",
"name": { "first": "John", "last": "Smith" },
"contactInfo": { "email": "john@example.com" },
"membershipStatus": "Member"
}
]

उपयोगकर्ता

बेस पथ: /membership/users

लॉगिन, पंजीकरण और पासवर्ड प्रबंधन एंडपॉइंट के लिए प्रमाणीकरण और अनुमतियाँ देखें।

MethodPathAuthPermissionविवरण
POST/loginPublicलॉग इन करें (ईमेल/पासवर्ड, JWT रिफ्रेश, या authGuid)
POST/registerPublicनया उपयोगकर्ता पंजीकृत करें
POST/forgotPublicपासवर्ड रीसेट ईमेल भेजें
POST/setPasswordGuidPublicईमेल लिंक से प्रमाणीकरण GUID का उपयोग करके पासवर्ड सेट करें
POST/verifyCredentialsPublicईमेल/पासवर्ड सत्यापित करें और संबंधित चर्च लौटाएँ
POST/loadOrCreateJWTईमेल/userId द्वारा उपयोगकर्ता खोजें या बनाएँ
POST/setDisplayNameJWTउपयोगकर्ता का पहला और अंतिम नाम अपडेट करें
POST/updateEmailJWTउपयोगकर्ता का ईमेल पता बदलें
POST/updatePasswordJWTउपयोगकर्ता का पासवर्ड बदलें (न्यूनतम 6 अक्षर)
POST/updateOptedOutJWTव्यक्ति की ऑप्ट-आउट स्थिति सेट करें
GET/search?term=JWTServer.Adminनाम/ईमेल द्वारा सभी उपयोगकर्ता खोजें
DELETE/JWTवर्तमान उपयोगकर्ता खाता हटाएँ

चर्च

बेस पथ: /membership/churches

MethodPathAuthPermissionविवरण
GET/JWTवर्तमान उपयोगकर्ता के सभी चर्च लोड करें
GET/:idJWTID द्वारा चर्च प्राप्त करें
GET/:id/getDomainAdminJWTचर्च के डोमेन एडमिन उपयोगकर्ता प्राप्त करें
GET/:id/impersonateJWTServer.Adminचर्च का प्रतिरूपण करें (केवल सर्वर एडमिन)
GET/all?term=JWTServer.Adminसभी चर्च खोजें (एडमिन)
GET/search/?name=Publicनाम द्वारा चर्च खोजें
GET/lookup/?subDomain=&id=Publicसबडोमेन या ID द्वारा चर्च लुकअप करें
POST/JWTSettings.Editचर्च विवरण अपडेट करें
POST/addJWTनया चर्च पंजीकृत करें। आवश्यक फ़ील्ड: name, address1, city, state, zip, country
POST/searchPublicनाम द्वारा चर्च खोजें (POST वेरिएंट)
POST/selectJWTचर्च चुनें/स्विच करें। बॉडी: { churchId } या { subDomain }
POST/:id/archiveJWTServer.Adminचर्च को आर्काइव या अनार्काइव करें
POST/byIdsPublicID द्वारा कई चर्च लोड करें
DELETE/deleteAbandonedJWTServer.Admin7+ दिनों से छोड़े गए चर्च हटाएँ

समूह

बेस पथ: /membership/groups

मानक CRUD विस्तारित (बेस क्लास से GET /, GET /:id)।

MethodPathAuthPermissionविवरण
GET/JWTसभी समूह सूचीबद्ध करें
GET/:idJWTID द्वारा समूह प्राप्त करें
GET/search?campusId=&serviceId=&serviceTimeId=JWTसेवा फ़िल्टर द्वारा समूह खोजें
GET/myJWTवर्तमान उपयोगकर्ता के समूह प्राप्त करें
GET/my/:tagJWTटैग द्वारा फ़िल्टर किए गए वर्तमान उपयोगकर्ता के समूह प्राप्त करें
GET/tag/:tagJWTविशिष्ट टैग वाले सभी समूह प्राप्त करें
GET/public/:churchId/:idPublicचर्च और ID द्वारा सार्वजनिक समूह प्राप्त करें
GET/public/:churchId/tag/:tagPublicटैग द्वारा सार्वजनिक समूह प्राप्त करें
GET/public/:churchId/label?label=Publicलेबल द्वारा सार्वजनिक समूह प्राप्त करें
GET/public/:churchId/slug/:slugPublicस्लग द्वारा सार्वजनिक समूह प्राप्त करें
POST/JWTGroups.Editसमूह बनाएँ या अपडेट करें (स्वचालित स्लग जनरेट)
DELETE/:idJWTGroups.Editसमूह हटाएँ (मंत्रालय समूहों के लिए चाइल्ड टीम भी हटाता है)

समूह सदस्य

बेस पथ: /membership/groupmembers

मानक CRUD विस्तारित (बेस क्लास से GET /:id, DELETE /:id)।

MethodPathAuthPermissionविवरण
GET/:idJWTGroupMembers.ViewID द्वारा समूह सदस्य प्राप्त करें
GET/JWTGroupMembers.View*समूह सदस्य सूचीबद्ध करें। ?groupId=, ?groupIds=, या ?personId= से फ़िल्टर करें। *उपयोगकर्ता समूह में होने या अपना personId क्वेरी करने पर भी अनुमत
GET/myJWTवर्तमान उपयोगकर्ता की समूह सदस्यताएँ प्राप्त करें
GET/basic/:groupIdJWTसमूह की बुनियादी सदस्य सूची प्राप्त करें
GET/public/leaders/:churchId/:groupIdPublicसमूह नेता प्राप्त करें (सार्वजनिक)
POST/JWTGroupMembers.Editसमूह सदस्य जोड़ें या अपडेट करें
DELETE/:idJWTGroupMembers.Viewसमूह सदस्य हटाएँ

परिवार

बेस पथ: /membership/households

मानक CRUD कंट्रोलर।

MethodPathAuthPermissionविवरण
GET/JWTसभी परिवार सूचीबद्ध करें
GET/:idJWTID द्वारा परिवार प्राप्त करें
POST/JWTPeople.Editपरिवार बनाएँ या अपडेट करें
DELETE/:idJWTPeople.Editपरिवार हटाएँ

भूमिकाएँ

बेस पथ: /membership/roles

MethodPathAuthPermissionविवरण
GET/:idJWTRoles.ViewID द्वारा भूमिका प्राप्त करें
GET/church/:churchIdJWTRoles.Viewचर्च की सभी भूमिकाएँ प्राप्त करें
POST/JWTRoles.Editभूमिकाएँ बनाएँ या अपडेट करें
DELETE/:idJWTRoles.Editभूमिका हटाएँ (इसकी अनुमतियाँ और सदस्य भी हटाता है)

भूमिका सदस्य

बेस पथ: /membership/rolemembers

MethodPathAuthPermissionविवरण
GET/roles/:idJWTRoles.Viewभूमिका के सदस्य प्राप्त करें। उपयोगकर्ता विवरण शामिल करने के लिए ?include=users जोड़ें
POST/JWTRoles.Editभूमिका में सदस्य जोड़ें (ईमेल मौजूद न होने पर उपयोगकर्ता बनाता है)
DELETE/:idJWTRoles.Viewभूमिका सदस्य हटाएँ
DELETE/self/:churchId/:userIdJWTअपने आप को चर्च से हटाएँ

भूमिका अनुमतियाँ

बेस पथ: /membership/rolepermissions

MethodPathAuthPermissionविवरण
GET/roles/:idJWTRoles.Viewभूमिका की अनुमतियाँ प्राप्त करें ("सभी" भूमिका के लिए ID के रूप में null उपयोग करें)
POST/JWTRoles.Editभूमिका अनुमतियाँ बनाएँ या अपडेट करें
DELETE/:idJWTRoles.Editभूमिका अनुमति हटाएँ

अनुमतियाँ

बेस पथ: /membership/permissions

MethodPathAuthPermissionविवरण
GET/JWTउपलब्ध अनुमतियों की पूर्ण सूची प्राप्त करें

फ़ॉर्म

बेस पथ: /membership/forms

MethodPathAuthPermissionविवरण
GET/JWTForms.Admin या Forms.Editसभी फ़ॉर्म सूचीबद्ध करें (एडमिन सभी देखता है; संपादक असाइन + गैर-सदस्य फ़ॉर्म देखते हैं)
GET/:idJWTफ़ॉर्म एक्सेसID द्वारा फ़ॉर्म प्राप्त करें
GET/archivedJWTForms.Admin या Forms.Editआर्काइव किए गए फ़ॉर्म सूचीबद्ध करें
GET/standalone/:id?churchId=JWTस्टैंडअलोन फ़ॉर्म प्राप्त करें (प्रतिबंधित फ़ॉर्म के लिए प्रमाणीकरण आवश्यक)
POST/JWTForms.Admin या Forms.Editफ़ॉर्म बनाएँ या अपडेट करें
DELETE/:idJWTफ़ॉर्म एक्सेसफ़ॉर्म हटाएँ

फ़ॉर्म सबमिशन

बेस पथ: /membership/formsubmissions

MethodPathAuthPermissionविवरण
GET/JWTForms.Admin या Forms.Editसबमिशन सूचीबद्ध करें। ?personId= या ?formId= से फ़िल्टर करें
GET/:idJWTForms.Admin या Forms.EditID द्वारा सबमिशन प्राप्त करें। ?include=form,questions,answers जोड़ें
GET/formId/:formIdJWTफ़ॉर्म एक्सेसफ़ॉर्म के सभी सबमिशन प्राप्त करें (फ़ॉर्म, प्रश्न, उत्तर सहित)
POST/JWTफ़ॉर्म उत्तर सबमिट करें (प्रतिबंधित/अप्रतिबंधित फ़ॉर्म संभालता है, ईमेल सूचनाएँ भेजता है)
DELETE/:idJWTForms.Admin या Forms.Editसबमिशन और उसके उत्तर हटाएँ

प्रश्न

बेस पथ: /membership/questions

MethodPathAuthPermissionविवरण
GET/JWTफ़ॉर्म एक्सेसफ़ॉर्म के लिए प्रश्न सूचीबद्ध करें। ?formId= आवश्यक
GET/:idJWTफ़ॉर्म एक्सेसID द्वारा प्रश्न प्राप्त करें
GET/unrestricted?formId=JWTअप्रतिबंधित फ़ॉर्म के प्रश्न प्राप्त करें
GET/sort/:id/upJWTक्रम में प्रश्न ऊपर ले जाएँ
GET/sort/:id/downJWTक्रम में प्रश्न नीचे ले जाएँ
POST/JWTफ़ॉर्म एक्सेसप्रश्न बनाएँ या अपडेट करें (स्वचालित क्रम असाइन करता है)
DELETE/:id?formId=JWTफ़ॉर्म एक्सेसप्रश्न हटाएँ

उत्तर

बेस पथ: /membership/answers

MethodPathAuthPermissionविवरण
GET/JWTForms.Admin या Forms.Editउत्तर सूचीबद्ध करें। ?formSubmissionId= से फ़िल्टर करें
POST/JWTForms.Admin या Forms.Editउत्तर बनाएँ या अपडेट करें

सदस्य अनुमतियाँ

बेस पथ: /membership/memberpermissions

विशिष्ट फ़ॉर्म के लिए प्रति-सदस्य एक्सेस नियंत्रित करता है।

MethodPathAuthPermissionविवरण
GET/:idJWTफ़ॉर्म एक्सेसID द्वारा सदस्य अनुमति प्राप्त करें
GET/member/:idJWTफ़ॉर्म एक्सेससदस्य की सभी फ़ॉर्म अनुमतियाँ प्राप्त करें
GET/form/:idJWTफ़ॉर्म एक्सेसफ़ॉर्म की सभी सदस्य अनुमतियाँ प्राप्त करें
GET/form/:id/myJWTफ़ॉर्म एक्सेसफ़ॉर्म के लिए वर्तमान उपयोगकर्ता की अनुमति प्राप्त करें
POST/JWTफ़ॉर्म एक्सेससदस्य अनुमतियाँ बनाएँ या अपडेट करें
DELETE/:id?formId=JWTफ़ॉर्म एक्सेससदस्य अनुमति हटाएँ
DELETE/member/:id?formId=JWTफ़ॉर्म एक्सेसफ़ॉर्म पर सदस्य की सभी अनुमतियाँ हटाएँ

सेटिंग्स

बेस पथ: /membership/settings

MethodPathAuthPermissionविवरण
GET/JWTSettings.Editचर्च की सभी सेटिंग्स प्राप्त करें
GET/public/:churchIdPublicचर्च की सार्वजनिक सेटिंग्स प्राप्त करें
POST/JWTSettings.Editसेटिंग्स सहेजें (base64 छवि अपलोड समर्थित)

डोमेन

बेस पथ: /membership/domains

मानक CRUD विस्तारित (बेस क्लास से GET /:id, GET /, DELETE /:id)।

MethodPathAuthPermissionविवरण
GET/JWTसभी डोमेन सूचीबद्ध करें
GET/:idJWTID द्वारा डोमेन प्राप्त करें
GET/lookup/:domainNameJWTनाम द्वारा डोमेन लुकअप करें
GET/public/lookup/:domainNamePublicनाम द्वारा सार्वजनिक डोमेन लुकअप
GET/health/checkPublicअनजाँचे डोमेन पर हेल्थ चेक चलाएँ
POST/JWTSettings.Editडोमेन बनाएँ या अपडेट करें (Caddy अपडेट ट्रिगर करता है)
DELETE/:idJWTSettings.Editडोमेन हटाएँ

उपयोगकर्ता चर्च

बेस पथ: /membership/userchurch

उपयोगकर्ताओं और चर्चों के बीच संबंध प्रबंधित करता है।

MethodPathAuthPermissionविवरण
GET/userid/:userIdJWTउपयोगकर्ता ID द्वारा उपयोगकर्ता-चर्च रिकॉर्ड प्राप्त करें
GET/personid/:personIdJWTव्यक्ति के लिंक किए गए उपयोगकर्ता का ईमेल प्राप्त करें
GET/user/:userIdJWTServer.Adminउपयोगकर्ता के सभी चर्च लोड करें
POST/JWTउपयोगकर्ता-चर्च संबंध बनाएँ
PATCH/:userIdJWTअंतिम एक्सेस समय अपडेट करें और एक्सेस लॉग करें
DELETE/record/:userId/:churchId/:personIdJWTउपयोगकर्ता-चर्च रिकॉर्ड हटाएँ

दृश्यता प्राथमिकताएँ

बेस पथ: /membership/visibilityPreferences

MethodPathAuthPermissionविवरण
GET/myJWTवर्तमान उपयोगकर्ता की दृश्यता प्राथमिकताएँ प्राप्त करें
POST/JWTदृश्यता प्राथमिकताएँ सहेजें (पता, फ़ोन, ईमेल दृश्यता)

क्वेरी

बेस पथ: /membership/query

MethodPathAuthPermissionविवरण
POST/membersJWTAI का उपयोग करके प्राकृतिक भाषा सदस्य खोज। बॉडी: { text, subDomain, siteUrl }

क्लाइंट त्रुटियाँ

बेस पथ: /membership/clientErrors

MethodPathAuthPermissionविवरण
POST/JWTक्लाइंट-साइड त्रुटि लॉग करें

संबंधित पृष्ठ