मेंबरशिप एंडपॉइंट्स
मेंबरशिप मॉड्यूल लोगों, चर्चों, समूहों, परिवारों, भूमिकाओं, अनुमतियों, फ़ॉर्मों और सेटिंग्स का प्रबंधन करता है। यह सबसे बड़ा मॉड्यूल है और बाकी सभी मॉड्यूलों के लिए मुख्य पहचान और प्राधिकरण की परत प्रदान करता है।
बेस पाथ: /membership
लोग
बेस पाथ: /membership/people
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | / | JWT | People.View या Member | चर्च के सभी लोगों की सूची लौटाएँ |
| GET | /:id | JWT | People.View या स्वयं का रिकॉर्ड | ID से व्यक्ति प्राप्त करें (फ़ॉर्म सबमिशन सहित) |
| GET | /ids?ids= | JWT | People.View, Member, या People.ViewNames | अल्पविराम से अलग की गई IDs से कई लोग प्राप्त करें। People.View के बिना People.ViewNames वाले कॉलर्स को बुनियादी मॉडल मिलता है, जिसमें opt-out किए गए लोग छोड़ दिए जाते हैं (कॉलर को छोड़कर) |
| GET | /basic?ids= | JWT | — | कई लोगों की बुनियादी जानकारी (केवल नाम) प्राप्त करें |
| GET | /names?ids= | JWT | कोई भी चर्च अनुमति | [{ id, name: { display, first, last }, photo }], अल्पविराम से अलग की गई उन IDs के लिए जिन पर कॉलर की पहुँच है, अंतिम नाम और फिर पहले नाम के अनुसार क्रमबद्ध। इससे बिना People.View वाली भूमिकाएँ (दान, उपस्थिति) लोगों को लेबल कर सकती हैं। कोई खोज या डायरेक्टरी फ़िल्टर नहीं |
| POST | /names | JWT | कोई भी चर्च अनुमति | GET /names के समान। बॉडी: { peopleIds } (या { ids }) |
| GET | /recent | JWT | People.View, Member, या People.ViewNames | हाल ही में जोड़े गए लोग। People.View के बिना People.ViewNames वाले कॉलर्स (डायरेक्टरी एक्सेस वाले सदस्यों सहित) को बुनियादी मॉडल (id, name.display, photo, membershipStatus) मिलता है, जिसमें opt-out किए गए लोग छोड़ दिए जाते हैं |
| GET | /guest-register/options?churchId= | Public | — | QR अतिथि साइन-अप चेकलिस्ट: { email, phone, address, birthDate, gender, maritalStatus, grade, comments } लौटाता है, जिनमें से हर एक "off", "optional", या "required" होता है (सार्वजनिक guestRegistrationFields सेटिंग से पार्स किया गया; अनुपस्थित या गलत मान ईमेल/फ़ोन को वैकल्पिक और बाकी को off पर डिफ़ॉल्ट करते हैं)। अनुरोध में मेल खाता साइट/चर्च टोकन न हो तो enableQRGuestRegistration आवश्यक है; दर-सीमित (429) |
| GET | /search?term=&email= | JWT | People.View, Member, या People.ViewNames | नाम या ईमेल से लोग खोजें (अधिकतम 100, अंतिम नाम और फिर पहले नाम के अनुसार क्रमबद्ध)। People.View के बिना People.ViewNames वाले कॉलर्स (डायरेक्टरी एक्सेस वाले सदस्यों सहित) को बुनियादी मॉडल लौटाने वाली नाम खोज मिलती है; email खोज [] लौटाती है |
| GET | /search/phone?number= | JWT | People.View या Member | फ़ोन नंबर से खोजें |
| GET | /search/group?groupId= | JWT | People.View या Member | किसी विशेष समूह के लोग प्राप्त करें |
| GET | /household/:householdId | JWT | — | किसी परिवार के सभी लोग प्राप्त करें |
| GET | /attendance | JWT | People.Edit | फ़िल्टर (campusId, serviceId, serviceTimeId, groupId, categoryName, startDate, endDate) के साथ उपस्थित लोग लोड करें |
| GET | /timeline?personIds=&groupIds= | JWT | — | लोगों और समूहों के लिए टाइमलाइन डेटा लोड करें |
| GET | /directory/:id | JWT | — | डायरेक्टरी दृश्य के लिए व्यक्ति प्राप्त करें (दृश्यता प्राथमिकताओं का पालन करता है) |
| GET | /claim/:churchId | JWT | — | किसी चर्च में वर्तमान उपयोगकर्ता के लिए व्यक्ति रिकॉर्ड का दावा करें |
| POST | / | JWT | People.Edit या EditSelf | लोग बनाएँ या अपडेट करें (बैच) |
| POST | /search | JWT | People.View, Member, या People.ViewNames | लोग खोजें (POST संस्करण)। बॉडी: { term } या { email }; GET /search के समान केवल-नाम नियम लागू होते हैं |
| POST | /advancedSearch | JWT | People.View या Member | कई शर्तों वाली खोज (आयु, birthMonth, membershipStatus आदि)। बॉडी शर्तों की एक ऐरे है; खाली बॉडी का अर्थ है कोई शर्त नहीं, और कोई भी अन्य गैर-ऐरे बॉडी 400 लौटाती है |
| POST | /loadOrCreate | Public | — | ईमेल से व्यक्ति खोजें या बनाएँ। बॉडी: { churchId, email, firstName, lastName } |
| POST | /guest-register | Public | — | QR अतिथि साइन-अप। बॉडी: { churchId, members: [{ firstName, lastName, email?, phone?, birthDate?, gender?, grade? }], address?, maritalStatus?, comments? } (1–10 सदस्य; email/phone/maritalStatus केवल पहले सदस्य पर लागू होते हैं)। चर्च द्वारा बंद किए गए फ़ील्ड हटा दिए जाते हैं; आवश्यक फ़ील्ड गायब होने या अमान्य मान होने पर 400 लौटता है। पहले मौजूदा लोगों का पुन: उपयोग होता है: कोई सदस्य तब मेल खाता है जब ठीक एक गैर-हटाया गया व्यक्ति समान पहला नाम (केस-इनसेंसिटिव) और समान ईमेल या फ़ोन अंक (घर, कार्यस्थल या मोबाइल) रखता हो; जिस सदस्य के पास ईमेल या फ़ोन नहीं है, वह मेल खाए परिवार के भीतर पहले नाम से मेल खाता है। मेल खाने वाले लोगों को कभी संपादित नहीं किया जाता। बिना मेल वाले सदस्य मेल खाए परिवार में शामिल होते हैं, या फिर एक नया परिवार बनता है (पहले सदस्य के अंतिम नाम पर), जिसमें membershipStatus: "Visitor" और साझा address होता है। comments पहले सदस्य पर नोट के रूप में सहेजे जाते हैं, सेट होने पर सभी को निजी guestRegistrationGroupId समूह में जोड़ा जाता है, और जब guestRegistrationRecordAttendance "true" हो तो उस समूह के उन निर्धारित सेवा समयों के लिए उपस्थिति दर्ज होती है जिनकी चेक-इन विंडो अभी खुली है। लौटाता है { householdId, people: [{ id, name }] }, जिसमें सहेजे गए नामों के बजाय भेजे गए नाम दोहराए जाते हैं। वही opt-in/टोकन और दर-सीमा नियम जो options कॉल पर लागू होते हैं |
| POST | /household/:householdId | JWT | People.Edit | परिवार के सदस्यों की असाइनमेंट अपडेट करें |
| POST | /public/email | Public | — | किसी व्यक्ति को ईमेल भेजें। बॉडी: { churchId, personId, subject, body, appName } |
| POST | /apiEmails | Internal | — | IDs द्वारा व्यक्ति के ईमेल लोड करें (सर्वर-से-सर्वर, jwtSecret आवश्यक) |
| DELETE | /:id | JWT | People.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"
}
]
उदाहरण: एक व्यक्ति बनाएँ
POST /membership/people
Authorization: Bearer <token>
[{ "firstName": "Jane", "lastName": "Doe", "contactInfo": { "email": "jane@example.com" } }]
उपयोगकर्ता
बेस पाथ: /membership/users
लॉगिन, रजिस्ट्रेशन और पासवर्ड प्रबंधन एंडपॉइंट्स के लिए प्रमाणीकरण और अनुमतियाँ देखें।
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| POST | /login | Public | — | लॉग इन करें (ईमेल/पासवर्ड, JWT रीफ़्रेश, या authGuid) |
| POST | /register | Public | — | नया उपयोगकर्ता रजिस्टर करें |
| POST | /forgot | Public | — | पासवर्ड रीसेट ईमेल भेजें |
| POST | /setPasswordGuid | Public | — | ईमेल लिंक से मिले auth GUID का उपयोग करके पासवर्ड सेट करें |
| POST | /verifyCredentials | Public | — | ईमेल/पासवर्ड सत्यापित करें और संबंधित चर्च लौटाएँ |
| POST | /loadOrCreate | JWT | — | ईमेल/userId से उपयोगकर्ता खोजें या बनाएँ |
| POST | /setDisplayName | JWT | — | उपयोगकर्ता का पहला और अंतिम नाम अपडेट करें |
| POST | /updateEmail | JWT | — | उपयोगकर्ता का ईमेल पता बदलें |
| POST | /updatePassword | JWT | — | उपयोगकर्ता का पासवर्ड बदलें (न्यूनतम 6 अक्षर) |
| POST | /updateOptedOut | JWT | — | किसी व्यक्ति की opted-out स्थिति सेट करें |
| POST | /sendInviteEmail | JWT | People.Edit | इस चर्च के किसी व्यक्ति को आमंत्रण ईमेल भेजें (email, personName, contextName)। बटन पर खाते के बिना व्यक्ति के लिए Sign Up और मौजूदा उपयोगकर्ता के लिए Log In लिखा होता है। जिस उपयोगकर्ता ने कभी लॉग इन नहीं किया, उसे इसके बजाय 7 दिनों में समाप्त होने वाला Set Your Password लिंक मिलता है। यह एक निश्चित टेम्पलेट है, इसलिए यह चर्च की दैनिक ईमेल सीमा में नहीं गिना जाता |
| GET | /search?term= | JWT | Server.Admin | नाम/ईमेल से सभी उपयोगकर्ता खोजें |
| DELETE | / | JWT | — | वर्तमान उपयोगकर्ता खाता हटाएँ |
चर्च
बेस पाथ: /membership/churches
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | / | JWT | — | वर्तमान उपयोगकर्ता के सभी चर्च लोड करें |
| GET | /:id | JWT | — | ID से चर्च प्राप्त करें |
| GET | /:id/getDomainAdmin | JWT | — | किसी चर्च का डोमेन एडमिन उपयोगकर्ता प्राप्त करें |
| GET | /:id/impersonate | JWT | Server.Admin | किसी चर्च का इम्पर्सोनेशन करें (केवल सर्वर एडमिन) |
| GET | /all?term= | JWT | Server.Admin | सभी चर्च खोजें (एडमिन) |
| GET | /search/?name= | Public | — | नाम से चर्च खोजें |
| GET | /lookup/?subDomain=&id= | Public | — | सबडोमेन या ID से चर्च खोजें |
| POST | / | JWT | Settings.Edit | चर्च का विवरण अपडेट करें |
| POST | /add | JWT | — | नया चर्च रजिस्टर करें। आवश्यक फ़ील्ड: name, address1, city, state, zip, country |
| POST | /search | Public | — | नाम से चर्च खोजें (POST संस्करण) |
| POST | /select | JWT | — | चर्च चुनें/बदलें। बॉडी: { churchId } या { subDomain } |
| POST | /:id/archive | JWT | Server.Admin | चर्च को आर्काइव या अनआर्काइव करें |
| POST | /byIds | Public | — | IDs द्वारा कई चर्च लोड करें |
| DELETE | /deleteAbandoned | JWT | Server.Admin | 7+ दिनों से छोड़े गए चर्च हटाएँ |
समूह
बेस पाथ: /membership/groups
मानक CRUD का विस्तार (बेस क्लास से GET /, GET /:id)।
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | / | JWT | — | सभी समूहों की सूची |
| GET | /:id | JWT | — | ID से समूह प्राप्त करें |
| GET | /search?campusId=&serviceId=&serviceTimeId= | JWT | — | सेवा फ़िल्टर से समूह खोजें |
| GET | /my | JWT | — | वर्तमान उपयोगकर्ता के समूह प्राप्त करें |
| GET | /my/:tag | JWT | — | वर्तमान उपयोगकर्ता के समूह, टैग से फ़िल्टर किए हुए, प्राप्त करें |
| GET | /tag/:tag | JWT | — | किसी विशेष टैग वाले सभी समूह प्राप्त करें |
| GET | /public/:churchId/:id | Public | — | चर्च और ID से सार्वजनिक समूह प्राप्त करें |
| GET | /public/:churchId/tag/:tag | Public | — | टैग से सार्वजनिक समूह प्राप्त करें |
| GET | /public/:churchId/label?label= | Public | — | लेबल से सार्वजनिक समूह प्राप्त करें |
| GET | /public/:churchId/slug/:slug | Public | — | slug से सार्वजनिक समूह प्राप्त करें |
| POST | / | JWT | Groups.Edit | समूह बनाएँ या अपडेट करें (slug स्वतः बनता है) |
| DELETE | /:id | JWT | Groups.Edit | समूह हटाएँ (सेवकाई समूहों के बाल टीम भी हटाता है) |
समूह के सदस्य
बेस पाथ: /membership/groupmembers
मानक CRUD का विस्तार (बेस क्लास से GET /:id, DELETE /:id)।
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | /:id | JWT | GroupMembers.View | ID से समूह सदस्य प्राप्त करें |
| GET | / | JWT | GroupMembers.View* | समूह के सदस्यों की सूची। ?groupId=, ?groupIds=, या ?personId= से फ़िल्टर करें। *यदि उपयोगकर्ता समूह में है या अपना personId खोज रहा है, तो भी अनुमति है, और Attendance.View या Attendance.Edit होने पर किसी भी गैर-गोपनीय समूह के ?groupId= के लिए भी (उनके लिए 13 वर्ष से कम आयु के सदस्य शामिल होते हैं) |
| GET | /my | JWT | — | वर्तमान उपयोगकर्ता की समूह सदस्यताएँ प्राप्त करें |
| GET | /basic/:groupId | JWT | — | किसी समूह की बुनियादी सदस्य सूची प्राप्त करें |
| GET | /public/leaders/:churchId/:groupId | Public | — | समूह के नेता प्राप्त करें (सार्वजनिक) |
| GET | /public/:churchId/:groupId | Public | — | समूह की सार्वजनिक रोस्टर प्राप्त करें (न्यूनतम फ़ील्ड: personId, displayName, leader, photo)। केवल तब जब समूह publicRoster के माध्यम से opt-in करे; वेबसाइट बिल्डर के staffGrid एलिमेंट को शक्ति देता है |
| POST | / | JWT | GroupMembers.Edit | समूह सदस्य जोड़ें या अपडेट करें |
| DELETE | /:id | JWT | GroupMembers.View | समूह सदस्य हटाएँ |
परिवार
बेस पाथ: /membership/households
मानक CRUD कंट्रोलर।
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | / | JWT | — | सभी परिवारों की सूची |
| GET | /:id | JWT | — | ID से परिवार प्राप्त करें |
| POST | / | JWT | People.Edit | परिवार बनाएँ या अपडेट करें |
| DELETE | /:id | JWT | People.Edit | परिवार हटाएँ |
भूमिकाएँ
बेस पाथ: /membership/roles
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | /:id | JWT | Roles.View | ID से भूमिका प्राप्त करें |
| GET | /church/:churchId | JWT | Roles.View | किसी चर्च की सभी भूमिकाएँ प्राप्त करें। हर भूमिका में memberCount शामिल है, यानी उसमें मौजूद अलग-अलग उपयोगकर्ताओं की संख्या |
| POST | / | JWT | Roles.Edit | भूमिकाएँ बनाएँ या अपडेट करें |
| DELETE | /:id | JWT | Roles.Edit | भूमिका हटाएँ (उसकी अनुमतियाँ और सदस्य भी हटाता है) |
भूमिका के सदस्य
बेस पाथ: /membership/rolemembers
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | /roles/:id | JWT | Roles.View | किसी भूमिका के सदस्य प्राप्त करें। उपयोगकर्ता विवरण शामिल करने के लिए ?include=users जोड़ें |
| POST | / | JWT | Roles.Edit | भूमिका में सदस्य जोड़ें (ईमेल मौजूद न हो तो उपयोगकर्ता बनाता है) |
| DELETE | /:id | JWT | Roles.View | भूमिका का सदस्य हटाएँ |
| DELETE | /self/:churchId/:userId | JWT | — | स्वयं को चर्च से हटाएँ |
भूमिका की अनुमतियाँ
बेस पाथ: /membership/rolepermissions
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | /roles/:id | JWT | Roles.View | किसी भूमिका की अनुमतियाँ प्राप्त करें ("Everyone" भूमिका के लिए ID के रूप में null का उपयोग करें) |
| POST | / | JWT | Roles.Edit | भूमिका अनुमतियाँ बनाएँ या अपडेट करें |
| DELETE | /:id | JWT | Roles.Edit | भूमिका अनुमति हटाएँ |
अनुमतियाँ
बेस पाथ: /membership/permissions
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | / | JWT | — | उपलब्ध अनुमतियों की पूरी सूची प्राप्त करें |
हर प्रविष्टि में apiName, section (सामग्री प्रकार), action, और displaySection / displayAction लेबल होते हैं, जो B1Admin का भूमिका संपादक दिखाता है। हाल की जोड़ें: MembershipApi / People / View Names (View People Names Only, People and Groups के अंतर्गत) और GivingApi / Donations / Enter (Enter Donations, Donations के अंतर्गत; देखें दान बैच)।
फ़ॉर्म
बेस पाथ: /membership/forms
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | / | JWT | Forms.Admin या Forms.Edit | सभी फ़ॉर्म की सूची (एडमिन सब देखता है; एडिटर को असाइन किए गए और गैर-सदस्य फ़ॉर्म दिखते हैं) |
| GET | /:id | JWT | फ़ॉर्म एक्सेस | ID से फ़ॉर्म प्राप्त करें |
| GET | /archived | JWT | Forms.Admin या Forms.Edit | आर्काइव किए गए फ़ॉर्म की सूची |
| GET | /group/:groupId | JWT | समूह सदस्य, समूह नेता, या Forms.Admin | समूह से जुड़े स्टैंड-अलोन फ़ॉर्म (forms.groupId), आर्काइव किए हुए को छोड़कर, नाम के अनुसार क्रमबद्ध। id, name, description, और open (उपलब्धता अवधि के भीतर) लौटाता है। सदस्यों को केवल खुले फ़ॉर्म मिलते हैं; नेताओं और फ़ॉर्म एडमिन को बंद फ़ॉर्म भी मिलते हैं। समूह पृष्ठ के जुड़े फ़ॉर्म इसी पर चलते हैं |
| GET | /standalone/:id?churchId= | JWT | — | स्टैंड-अलोन फ़ॉर्म प्राप्त करें (प्रतिबंधित फ़ॉर्म के लिए प्रमाणीकरण आवश्यक) |
| POST | / | JWT | Forms.Admin या Forms.Edit | फ़ॉर्म बनाएँ या अपडेट करें। स्टैंड-अलोन फ़ॉर्म वैकल्पिक photoUrl (फ़ॉर्म के ऊपर दिखने वाली हेडर फ़ोटो) और groupId (जुड़ा समूह) स्वीकार करते हैं |
| DELETE | /:id | JWT | फ़ॉर्म एक्सेस | फ़ॉर्म हटाएँ |
फ़ॉर्म सबमिशन
बेस पाथ: /membership/formsubmissions
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | / | JWT | Forms.Admin या Forms.Edit | सबमिशन की सूची। ?personId= या ?formId= से फ़िल्टर करें |
| GET | /my?include=questions,answers | JWT | — | स्व-सीमित: साइन-इन किए गए सदस्य द्वारा सबमिट किए गए या उनके व्यक्ति रिकॉर्ड से जुड़े अधिकतम 50 स्टैंड-अलोन फ़ॉर्म सबमिशन (व्यक्ति फ़ॉर्म नहीं), सबसे नए पहले, हर एक के साथ form.name (contentType person, contentId = उनका person id -- जैसे किसी एडमिन के person बदलने के बाद)। include हर फ़ॉर्म के प्रश्न और सबमिशन के उत्तर जोड़ता है। यदि उपयोगकर्ता किसी व्यक्ति से लिंक नहीं है तो 401 लौटता है। B1 Me पृष्ठ के My Forms अनुभाग को शक्ति देता है |
| GET | /group/:groupId | JWT | समूह का नेता | समूह के नेताओं के लिए उत्तर: हर जुड़े फ़ॉर्म और पंजीकरण फ़ॉर्म वाले हर समूह इवेंट के लिए एक प्रविष्टि, जिसमें form, event (id, title, start; केवल इवेंट प्रविष्टियों के लिए), questions, और submissions (answers और personName के साथ, गुमनाम होने पर null) हों |
| GET | /:id | JWT | Forms.Admin, Forms.Edit, या view एक्सेस | ID से सबमिशन प्राप्त करें। ?include=form,questions,answers जोड़ें। फ़ॉर्म के जुड़े समूह के नेता, और जिस समूह से इवेंट पंजीकरण जुड़ा है उसके नेता, इसे भी पढ़ सकते हैं |
| GET | /formId/:formId | JWT | फ़ॉर्म एक्सेस (view) | किसी फ़ॉर्म के सभी सबमिशन प्राप्त करें (फ़ॉर्म, प्रश्न, उत्तर शामिल)। फ़ॉर्म के जुड़े समूह के नेताओं को view एक्सेस है |
| POST | / | JWT | — | फ़ॉर्म उत्तर सबमिट करें (प्रतिबंधित/अप्रतिबंधित फ़ॉर्म संभालता है, ईमेल सूचनाएँ भेजता है)। जब फ़ॉर्म में autoCreatePerson हो, तो ईमेल से Guest व्यक्ति खोजता या बनाता है और सबमिशन को जोड़ता है; जब फ़ॉर्म में groupId भी हो, तो उस व्यक्ति को समूह में जोड़ता है; जब followUpSubject/followUpBody सेट हों, तो सबमिट करने वाले को टेम्पलेट वाला फ़ॉलो-अप ईमेल भेजता है। जब तक कॉलर फ़ॉर्म प्रबंधित न कर सके, submittedBy हमेशा साइन-इन किए सदस्य के व्यक्ति पर सेट होता है (गुमनाम सबमिशन के लिए खाली छोड़ा जाता है) |
| DELETE | /:id | JWT | Forms.Admin या Forms.Edit | सबमिशन और उसके उत्तर हटाएँ |
प्रश्न
बेस पाथ: /membership/questions
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | / | JWT | फ़ॉर्म एक्सेस | किसी फ़ॉर्म के प्रश्नों की सूची। ?formId= आवश्यक |
| GET | /:id | JWT | फ़ॉर्म एक्सेस | ID से प्रश्न प्राप्त करें |
| GET | /unrestricted?formId= | JWT | — | अप्रतिबंधित फ़ॉर्म के प्रश्न प्राप्त करें |
| GET | /sort/:id/up | JWT | — | प्रश्न को क्रम में ऊपर ले जाएँ |
| GET | /sort/:id/down | JWT | — | प्रश्न को क्रम में नीचे ले जाएँ |
| POST | / | JWT | फ़ॉर्म एक्सेस | प्रश्न बनाएँ या अपडेट करें (क्रम स्वतः तय होता है) |
| DELETE | /:id?formId= | JWT | फ़ॉर्म एक्सेस | प्रश्न हटाएँ |
उत्तर
बेस पाथ: /membership/answers
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | / | JWT | Forms.Admin या Forms.Edit | उत्तरों की सूची। ?formSubmissionId= से फ़िल्टर करें |
| POST | / | JWT | Forms.Admin या Forms.Edit | उत्तर बनाएँ या अपडेट करें |
सदस्य अनुमतियाँ
बेस पाथ: /membership/memberpermissions
हर सदस्य की विशेष फ़ॉर्म तक पहुँच को नियंत्रित करता है।
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | /:id | JWT | फ़ॉर्म एक्सेस | ID से सदस्य अनुमति प्राप्त करें |
| GET | /member/:id | JWT | फ़ॉर्म एक्सेस | किसी सदस्य की सभी फ़ॉर्म अनुमतियाँ प्राप्त करें |
| GET | /form/:id | JWT | फ़ॉर्म एक्सेस | किसी फ़ॉर्म की सभी सदस्य अनुमतियाँ प्राप्त करें |
| GET | /form/:id/my | JWT | फ़ॉर्म एक्सेस | किसी फ़ॉर्म के लिए वर्तमान उपयोगकर्ता की अनुमति प्राप्त करें |
| POST | / | JWT | फ़ॉर्म एक्सेस | सदस्य अनुमतियाँ बनाएँ या अपडेट करें |
| DELETE | /:id?formId= | JWT | फ़ॉर्म एक्सेस | सदस्य अनुमति हटाएँ |
| DELETE | /member/:id?formId= | JWT | फ़ॉर्म एक्सेस | किसी फ़ॉर्म पर किसी सदस्य की सभी अनुमतियाँ हटाएँ |
सेटिंग्स
बेस पाथ: /membership/settings
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | / | JWT | Settings.Edit | चर्च की सभी सेटिंग्स प्राप्त करें |
| GET | /public/:churchId | Public | — | किसी चर्च की सार्वजनिक सेटिंग्स प्राप्त करें |
| POST | / | JWT | Settings.Edit | सेटिंग्स सहेजें (base64 छवि अपलोड समर्थित) |
डोमेन
बेस पाथ: /membership/domains
मानक CRUD का विस्तार (बेस क्लास से GET /:id, GET /, DELETE /:id)।
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | / | JWT | — | सभी डोमेन की सूची |
| GET | /:id | JWT | — | ID से डोमेन प्राप्त करें |
| GET | /lookup/:domainName | JWT | — | नाम से डोमेन खोजें |
| GET | /public/lookup/:domainName | Public | — | नाम से सार्वजनिक डोमेन खोज |
| GET | /health/check | Public | — | बिना जाँचे गए डोमेन पर हेल्थ चेक चलाएँ |
| POST | / | JWT | Settings.Edit | डोमेन बनाएँ या अपडेट करें (Caddy अपडेट शुरू करता है) |
| DELETE | /:id | JWT | Settings.Edit | डोमेन हटाएँ |
उपयोगकर्ता-चर्च
बेस पाथ: /membership/userchurch
उपयोगकर्ताओं और चर्चों के बीच के संबंध का प्रबंधन करता है।
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | /userid/:userId | JWT | — | userId से उपयोगकर्ता-चर्च रिकॉर्ड प्राप्त करें |
| GET | /personid/:personId | JWT | — | किसी व्यक्ति से जुड़े उपयोगकर्ता का ईमेल प्राप्त करें |
| GET | /user/:userId | JWT | Server.Admin | किसी उपयोगकर्ता के सभी चर्च लोड करें |
| POST | / | JWT | — | उपयोगकर्ता-चर्च संबंध बनाएँ |
| PATCH | /:userId | JWT | — | अंतिम एक्सेस समय अपडेट करें और एक्सेस लॉग करें |
| DELETE | /record/:userId/:churchId/:personId | JWT | — | उपयोगकर्ता-चर्च रिकॉर्ड हटाएँ |
दृश्यता प्राथमिकताएँ
बेस पाथ: /membership/visibilityPreferences
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | /my | JWT | — | वर्तमान उपयोगकर्ता की दृश्यता प्राथमिकताएँ प्राप्त करें |
| POST | / | JWT | — | दृश्यता प्राथमिकताएँ सहेजें (पता, फ़ोन, ईमेल की दृश्यता) |
क्वेरी
बेस पाथ: /membership/query
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| POST | /members | JWT | — | AI का उपयोग करके प्राकृतिक भाषा में सदस्य खोज। बॉडी: { text, subDomain, siteUrl } |
क्लाइंट त्रुटियाँ
बेस पाथ: /membership/clientErrors
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| POST | / | JWT | — | क्लाइंट-साइड त्रुटि लॉग करें |
संबंधित पृष्ठ
- प्रमाणीकरण और अनुमतियाँ — लॉगिन फ़्लो, JWT, OAuth, अनुमति मॉडल
- उपस्थिति एंडपॉइंट्स — सेवा और विज़िट ट्रैकिंग
- मॉड्यूल संरचना — कोड संगठन के पैटर्न