Doing Endpoints
Doing मॉड्यूल सेवा योजना, स्वयंसेवक शेड्यूलिंग, कार्य प्रबंधन और स्वचालन का प्रबंधन करता है। यह समय और पदों के साथ सेवा योजनाएँ बनाने, स्वयंसेवकों को असाइन करने, ब्लॉकआउट तारीखें प्रबंधित करने, सेवा क्रम आइटम बनाने, बाहरी सामग्री प्रदाताओं से जुड़ने, और शर्तों व क्रियाओं के साथ स्वचालित वर्कफ़्लो कॉन्फ़िगर करने के लिए उपकरण देता है।
Base path: /doing
योजनाएँ (Plans)
Base path: /doing/plans
| विधि | पथ | Auth | अनुमति | विवरण |
|---|---|---|---|---|
| GET | / | JWT | — | चर्च की सभी योजनाएँ सूचीबद्ध करें |
| GET | /:id | JWT | — | ID से योजना प्राप्त करें |
| GET | /ids?ids= | JWT | — | अल्पविराम से अलग IDs द्वारा कई योजनाएँ प्राप्त करें |
| GET | /types/:planTypeId | JWT | — | योजना प्रकार के अनुसार योजनाएँ प्राप्त करें |
| GET | /textRange?startDate=&endDate=&ministryId=&planTypeId= | JWT | texting.send + ministry edit | सेवा अवलोकन Text Volunteers के भेजने से पहले का पूर्वावलोकन: { totalMembers, eligibleCount, optedOutCount, noPhoneCount, capped } सीमा में असाइन स्वयंसेवकों के लिए (हर व्यक्ति के लिए एक, opted-out और बिना नंबर वाले छोड़े गए, साझा नंबर एक बार गिने गए, 200 तक सीमित) |
| GET | /presenter | JWT | — | अगले 7 दिनों की योजनाएँ प्राप्त करें (presenter दृश्य) |
| GET | /confirmationWorkflows?ministryId= | JWT | Ministry edit | सक्रिय सेवा असाइनमेंट पुष्टि वर्कफ़्लो (workflowType = "assignmentConfirmation") जिन्हें योजना चुन सकती है: [{ id, name }] |
| GET | /public/current/:planTypeId | Public | — | योजना प्रकार के लिए वर्तमान योजना प्राप्त करें |
| GET | /public/signup/:churchId | Public | — | स्व-साइनअप के लिए खुली योजनाएँ, सबसे पहले वाली पहले, हर एक अपने स्व-साइनअप पदों सहित (categoryName, फिर name के अनुसार क्रमबद्ध, साथ में Accepted/Unconfirmed असाइनमेंट की filledCount) और समय। स्वयंसेवकों के नाम नहीं। जब चर्च सेटिंग volunteerSignupNextOnly "true" हो, तो हर योजना प्रकार की केवल पहली योजना लौटाई जाती है। हर plan में एक गणना की गई signupDeadline (ISO instant, या null) होती है: योजना के सबसे पहले service-प्रकार समय से signupDeadlineHours पहले (यदि कोई service समय नहीं है तो कोई भी समय वाली प्रविष्टि; यदि योजना में कोई समय नहीं है तो serviceDate पर चर्च के समय क्षेत्र में 9:00) |
| GET | /signup/:planId/volunteers | JWT | — | योजना के स्व-साइनअप पदों के लिए [{ positionId, names }] (Accepted/Unconfirmed असाइनी के प्रदर्शित नाम)। तब तक [] लौटाता है जब तक योजना का showVolunteerNames चालू न हो |
| POST | / | JWT | — | योजनाएँ बनाएँ या अपडेट करें (एकल ऑब्जेक्ट या सरणी स्वीकार)। योजना को किसी सेवा पुष्टि वर्कफ़्लो में शामिल करने के लिए confirmationWorkflowId सेट करें, या भविष्य के अनुरोधों के लिए बाहर रहने हेतु null। समय-सीमा हटाने के लिए signupDeadlineHours: null भेजें; फ़ील्ड छोड़ने पर सहेजा गया मान बना रहता है |
| POST | /copy/:id | JWT | Ministry edit | पदों, समयों, असाइनमेंट और सेवा क्रम आइटमों सहित योजना कॉपी करें। बॉडी में ministryId, serviceDate, copyMode ("none", "positions", "all") और copyServiceOrder (boolean) होते हैं। targetPlanId के बिना एक नई योजना बनती है, और notes, signupDeadlineHours, showVolunteerNames, और autoReplaceOnDecline स्रोत योजना से आते हैं जब तक बॉडी उन्हें न दे। targetPlanId के साथ, कॉपी उस मौजूदा योजना को भरती है (कॉलर को उसे संपादित करने योग्य होना चाहिए)। B1Admin का Repeat weekly विकल्प हर सप्ताह के लिए इसे एक बार कॉल करता है, हर बार पिछले सप्ताह बनी योजना से कॉपी करते हुए |
| POST | /textRange | JWT | texting.send + ministry edit | चर्च के टेक्स्टिंग प्रदाता के माध्यम से तारीख सीमा में असाइन हर स्वयंसेवक को टेक्स्ट करें। बॉडी: { startDate, endDate, ministryId, planTypeId?, message } (संदेश 1600 अक्षर तक; मर्ज फ़ील्ड प्रति प्राप्तकर्ता हल होते हैं)। पूर्वावलोकन गिनती के साथ recipientCount, successCount, failCount, और भेजना जल्दी रुकने पर error (no_provider या insufficient_credits) लौटाता है |
| POST | /:id/issueRequests | JWT | Plan edit | योजना के नए Unconfirmed, अभी तक सूचित न किए गए असाइनमेंट को उसके पुष्टि वर्कफ़्लो से जारी करें: हर एक को सूचित चिह्नित करता है और प्रति असाइनमेंट एक वर्कफ़्लो कार्ड शुरू करता है। खाली बॉडी; { issued } लौटाता है। तब तक विफल होता है जब तक योजना प्रकाशित न हो (prepared नहीं), उसका सक्रिय confirmationWorkflowId कम से कम एक चरण के साथ न हो, और उसकी उत्तर समय-सीमा न बीती हो |
| POST | /autofill/:id | JWT | — | योजना के लिए स्वयंसेवक असाइनमेंट स्वतः भरें। बॉडी: { teams: [{ positionId, personIds }] } |
| DELETE | /:id | JWT | — | योजना और उससे जुड़े सभी समय, असाइनमेंट, पद और योजना आइटम हटाएँ |
उदाहरण: योजना कॉपी करना
POST /doing/plans/copy/abc-123
Authorization: Bearer <token>
{
"serviceDate": "2026-03-01T10:00:00.000Z",
"copyMode": "all",
"copyServiceOrder": true
}
{
"id": "def-456",
"churchId": "church-1",
"serviceDate": "2026-03-01T10:00:00.000Z"
}
योजना प्रकार (Plan Types)
Base path: /doing/planTypes
CRUD बेस क्लास का विस्तार (GET /, GET /:id, POST /, DELETE /:id — कोई अनुमति जाँच नहीं)।
| विधि | पथ | Auth | अनुमति | विवरण |
|---|---|---|---|---|
| GET | / | JWT | — | सभी योजना प्रकार सूचीबद्ध करें |
| GET | /:id | JWT | — | ID से योजना प्रकार प्राप्त करें |
| GET | /ids?ids= | JWT | — | अल्पविराम से अलग IDs द्वारा कई योजना प्रकार प्राप्त करें |
| GET | /ministryId/:ministryId | JWT | — | किसी सेवकाई के योजना प्रकार प्राप्त करें |
| POST | / | JWT | — | योजना प्रकार बनाएँ या अपडेट करें |
| DELETE | /:id | JWT | — | योजना प्रकार हटाएँ |
योजना आइटम (Plan Items)
Base path: /doing/planItems
सेवा क्रम आइटम (हेडर, सेक्शन, गीत, आदि) प्रबंधित करता है, जो एक पैरेंट-चाइल्ड ट्री संरचना में व्यवस्थित होते हैं।
| विधि | पथ | Auth | अनुमति | विवरण |
|---|---|---|---|---|
| GET | /:id | JWT | — | ID से योजना आइटम प्राप्त करें |
| GET | /ids?ids= | JWT | — | अल्पविराम से अलग IDs द्वारा कई योजना आइटम प्राप्त करें |
| GET | /plan/:planId | JWT | — | किसी योजना के सभी योजना आइटम प्राप्त करें (ट्री संरचना लौटाता है) |
| GET | /presenter/:churchId/:planId | Public | — | presenter दृश्य के लिए योजना आइटम प्राप्त करें (ट्री संरचना लौटाता है) |
| POST | / | JWT | — | योजना आइटम बनाएँ या अपडेट करें |
| POST | /sort | JWT | — | योजना आइटम का सॉर्ट क्रम अपडेट करें (भाई-बहनों को पुनः क्रमबद्ध करता है) |
| DELETE | /:id | JWT | — | योजना आइटम हटाएँ |
योजना फ़ीड (Plan Feed)
Base path: /doing/planFeed
presenter के लिए योजना आइटम फ़ीड प्रदान करता है। यदि कोई योजना आइटम मौजूद नहीं हैं, तो योजना के contentId का उपयोग करके Lessons.church venue फ़ीड से अपने आप भरता है।
| विधि | पथ | Auth | अनुमति | विवरण |
|---|---|---|---|---|
| GET | /presenter/:churchId/:planId | Public | — | presenter के लिए योजना फ़ीड प्राप्त करें (खाली होने पर venue फ़ीड से अपने आप भरता है) |
पद (Positions)
Base path: /doing/positions
CRUD बेस क्लास का विस्तार (GET /:id, POST /, DELETE /:id — कोई अनुमति जाँच नहीं)।
| विधि | पथ | Auth | अनुमति | विवरण |
|---|---|---|---|---|
| GET | /:id | JWT | — | ID से पद प्राप्त करें |
| GET | /ids?ids= | JWT | — | अल्पविराम से अलग IDs द्वारा कई पद प्राप्त करें |
| GET | /plan/ids?planIds= | JWT | — | अल्पविराम से अलग योजना IDs द्वारा कई योजनाओं के पद प्राप्त करें |
| GET | /plan/:planId | JWT | — | किसी योजना के सभी पद प्राप्त करें |
| POST | / | JWT | — | पद बनाएँ या अपडेट करें |
| DELETE | /:id | JWT | — | पद हटाएँ |
समय (Times)
Base path: /doing/times
| विधि | पथ | Auth | अनुमति | विवरण |
|---|---|---|---|---|
| GET | /all | JWT | — | चर्च के सभी समय सूचीबद्ध करें |
| GET | /:id | JWT | — | ID से समय प्राप्त करें |
| GET | /plans?planIds= | JWT | — | अल्पविराम से अलग योजना IDs द्वारा कई योजनाओं के समय प्राप्त करें |
| GET | /plan/:planId | JWT | — | किसी योजना के सभी समय प्राप्त करें |
| POST | / | JWT | — | समय बनाएँ या अपडेट करें |
| DELETE | /:id | JWT | — | समय हटाएँ |
असाइनमेंट (Assignments)
Base path: /doing/assignments
| विधि | पथ | Auth | अनुमति | विवरण |
|---|---|---|---|---|
| GET | /my | JWT | — | वर्तमान उपयोगकर्ता के असाइनमेंट प्राप्त करें |
| GET | /my/upcoming | JWT | — | वर्तमान उपयोगकर्ता के कल से आगे की तारीख वाली योजनाओं के अधिकतम 20 असाइनमेंट (penciled-in, या prepared, योजनाएँ छोड़ी जाती हैं), सबसे पहले वाले पहले: { assignmentId, status, positionName, planId, planName, serviceDate }। सदस्य होम पृष्ठ पर सेवा पूर्वावलोकन का समर्थन करता है |
| GET | /:id | JWT | — | ID से असाइनमेंट प्राप्त करें |
| GET | /plan/ids?planIds= | JWT | — | अल्पविराम से अलग योजना IDs द्वारा कई योजनाओं के असाइनमेंट प्राप्त करें |
| GET | /plan/:planId | JWT | — | किसी योजना के सभी असाइनमेंट प्राप्त करें |
| POST | / | JWT | — | असाइनमेंट बनाएँ या अपडेट करें (स्थिति डिफ़ॉल्ट रूप से "Unconfirmed") |
| POST | /accept/:id | JWT | — | असाइनमेंट स्वीकार करें (असाइन किया गया व्यक्ति ही होना चाहिए) |
| POST | /decline/:id | JWT | — | असाइनमेंट अस्वीकार करें (असाइन किया गया व्यक्ति ही होना चाहिए) |
| POST | /signup | JWT | — | किसी पद के लिए स्व-साइनअप। बॉडी: { positionId }। पद को स्व-साइनअप की अनुमति और जगह होनी चाहिए; एक Accepted असाइनमेंट बनता है। योजना की साइनअप समय-सीमा (ऊपर की तरह उसके पहले सेवा समय से पीछे गिनी गई) बीत जाने पर "Signup deadline has passed" के साथ अस्वीकार |
| DELETE | /signup/:id | JWT | — | अपना स्व-साइनअप हटाएँ। योजना की साइनअप समय-सीमा के बाद "Removal deadline has passed" के साथ अस्वीकार |
| DELETE | /:id | JWT | — | असाइनमेंट हटाएँ |
उदाहरण: असाइनमेंट स्वीकार करना
POST /doing/assignments/accept/assign-123
Authorization: Bearer <token>
{
"id": "assign-123",
"personId": "person-456",
"positionId": "pos-789",
"planId": "plan-abc",
"status": "Accepted"
}
ब्लॉकआउट तारीखें (Blockout Dates)
Base path: /doing/blockoutDates
CRUD बेस क्लास का विस्तार (GET /:id, DELETE /:id — कोई अनुमति जाँच नहीं)।
| विधि | पथ | Auth | अनुमति | विवरण |
|---|---|---|---|---|
| GET | /:id | JWT | — | ID से ब्लॉकआउट तारीख प्राप्त करें |
| GET | /ids?ids= | JWT | — | अल्पविराम से अलग IDs द्वारा कई ब्लॉकआउट तारीखें प्राप्त करें |
| GET | /my | JWT | — | वर्तमान उपयोगकर्ता की ब्लॉकआउट तारीखें प्राप्त करें |
| GET | /upcoming | JWT | — | चर्च की सभी आगामी ब्लॉकआउट तारीखें प्राप्त करें |
| POST | / | JWT | — | ब्लॉकआउट तारीखें बनाएँ या अपडेट करें (personId न मिलने पर डिफ़ॉल्ट रूप से वर्तमान उपयोगकर्ता) |
| DELETE | /:id | JWT | — | ब्लॉकआउट तारीख हटाएँ |
कार्य (Tasks)
Base path: /doing/tasks
| विधि | पथ | Auth | अनुमति | विवरण |
|---|---|---|---|---|
| GET | / | JWT | — | वर्तमान उपयोगकर्ता के लिए खुले कार्य प्राप्त करें |
| GET | /:id | JWT | — | ID से कार्य प्राप्त करें |
| GET | /:id/contact | JWT | कार्ड देख सकने वाला | जिस व्यक्ति के बारे में वर्कफ़्लो कार्ड है उसकी संपर्क जानकारी: { personId, displayName, mobilePhone, email }। असाइन किए गए कॉलर को, जिसके पास People पहुँच नहीं है, व्यक्ति से संपर्क करने देता है |
| GET | /closed | JWT | — | वर्तमान उपयोगकर्ता के बंद कार्य प्राप्त करें |
| GET | /timeline?taskIds= | JWT | — | अल्पविराम से अलग कार्य IDs द्वारा कार्यों का टाइमलाइन डेटा प्राप्त करें |
| GET | /directoryUpdate/:personId | JWT | — | किसी व्यक्ति का डायरेक्टरी अपडेट कार्य प्राप्त करें |
| POST | / | JWT | — | कार्य बनाएँ या अपडेट करें। डायरेक्टरी अपडेट कार्यों को संभालने के लिए ?type=directoryUpdate जोड़ें (फ़ोटो अपने आप अपलोड होती हैं) |
| POST | /:id/conversation | JWT | tasks.edit या कार्ड असाइनी | कार्ड से नोट्स बातचीत जोड़ें। बॉडी: { conversationId }। पहली जुड़ी बातचीत मान्य होती है; बाद की कॉल कार्ड को बिना बदले लौटाती हैं |
| POST | /loadForGroups | JWT | — | विशिष्ट समूहों के लिए कार्य लोड करें। बॉडी: { groupIds: [], status: "Open" } |
स्वचालन (Automations)
Base path: /doing/automations
| विधि | पथ | Auth | अनुमति | विवरण |
|---|---|---|---|---|
| GET | / | JWT | — | चर्च के सभी स्वचालन सूचीबद्ध करें |
| GET | /:id | JWT | — | ID से स्वचालन प्राप्त करें |
| GET | /check | Public | — | सभी स्वचालनों की जाँच शुरू करें |
| POST | / | JWT | — | स्वचालन बनाएँ या अपडेट करें |
| DELETE | /:id | JWT | — | स्वचालन हटाएँ |
क्रियाएँ (Actions)
Base path: /doing/actions
क्रियाएँ परिभाषित करती हैं कि स्वचालन ट्रिगर होने पर क्या होता है।
| विधि | पथ | Auth | अनुमति | विवरण |
|---|---|---|---|---|
| GET | /:id | JWT | — | ID से क्रिया प्राप्त करें |
| GET | /automation/:id | JWT | — | किसी स्वचालन की सभी क्रियाएँ प्राप्त करें |
| POST | / | JWT | — | क्रियाएँ बनाएँ या अपडेट करें |
| DELETE | /:id | JWT | — | क्रिया हटाएँ |
शर्तें (Conditions)
Base path: /doing/conditions
शर्तें वे मानदंड परिभाषित करती हैं जो स्वचालन को ट्रिगर करते हैं।
| विधि | पथ | Auth | अनुमति | विवरण |
|---|---|---|---|---|
| GET | /:id | JWT | — | ID से शर्त प्राप्त करें |
| GET | /automation/:id | JWT | — | किसी स्वचालन की सभी शर्तें प्राप्त करें |
| POST | / | JWT | — | शर्तें बनाएँ या अपडेट करें |
| DELETE | /:id | JWT | — | शर्त हटाएँ |
संयोजन (Conjunctions)
Base path: /doing/conjunctions
संयोजन किसी स्वचालन में कई शर्तों को जोड़ते हैं (AND/OR तर्क)।
| विधि | पथ | Auth | अनुमति | विवरण |
|---|---|---|---|---|
| GET | /:id | JWT | — | ID से संयोजन प्राप्त करें |
| GET | /automation/:id | JWT | — | किसी स्वचालन के सभी संयोजन प्राप्त करें |
| POST | / | JWT | — | संयोजन बनाएँ या अपडेट करें |
| DELETE | /:id | JWT | — | संयोजन हटाएँ |
सामग्री प्रदाता प्रमाणीकरण (Content Provider Auths)
Base path: /doing/contentProviderAuths
CRUD बेस क्लास का विस्तार (GET /, GET /:id, POST /, DELETE /:id — कोई अनुमति जाँच नहीं)।
बाहरी सामग्री प्रदाताओं (जैसे प्रेज़ेंटेशन सॉफ़्टवेयर एकीकरण) के लिए OAuth प्रमाणीकरण रिकॉर्ड प्रबंधित करता है।
accessToken और refreshToken को EncryptionHelper से संग्रह में एन्क्रिप्ट किया जाता है और पढ़ते समय डिक्रिप्ट किया जाता है, इसलिए API अब भी सादे टोकन लौटाता है। एन्क्रिप्शन से पहले सहेजी गई पंक्तियों में सादा टेक्स्ट है (जिसमें कभी | नहीं होता); वे जैसी हैं वैसी लौटाई जाती हैं, और अगली बार सहेजे जाने पर एन्क्रिप्ट हो जाती हैं।
| विधि | पथ | Auth | अनुमति | विवरण |
|---|---|---|---|---|
| GET | / | JWT | — | सभी सामग्री प्रदाता प्रमाणीकरण सूचीबद्ध करें |
| GET | /:id | JWT | — | ID से सामग्री प्रदाता प्रमाणीकरण प्राप्त करें |
| GET | /ids?ids= | JWT | — | अल्पविराम से अलग IDs द्वारा कई सामग्री प्रदाता प्रमाणीकरण प्राप्त करें |
| GET | /ministry/:ministryId | JWT | — | किसी सेवकाई के सभी सामग्री प्रदाता प्रमाणीकरण प्राप्त करें |
| GET | /ministry/:ministryId/:providerId | JWT | — | किसी विशिष्ट सेवकाई और प्रदाता के लिए प्रमाणीकरण रिकॉर्ड प्राप्त करें |
| POST | / | JWT | — | सामग्री प्रदाता प्रमाणीकरण बनाएँ या अपडेट करें |
| DELETE | /:id | JWT | — | सामग्री प्रदाता प्रमाणीकरण हटाएँ |
प्रदाता प्रॉक्सी (Provider Proxy)
Base path: /doing/providerProxy
बाहरी सामग्री प्रदाताओं (जैसे ProPresenter, EasyWorship) के लिए अनुरोधों को आगे भेजता है। टोकन समाप्त होने पर टोकन रिफ़्रेश अपने आप संभालता है।
| विधि | पथ | Auth | अनुमति | विवरण |
|---|---|---|---|---|
| POST | /browse | JWT | — | सामग्री प्रदाता फ़ाइलें ब्राउज़ करें। बॉडी: { ministryId, providerId, path } |
| POST | /getPresentations | JWT | — | सामग्री प्रदाता से प्रेज़ेंटेशन प्राप्त करें। बॉडी: { ministryId, providerId, path } |
| POST | /getPlaylist | JWT | — | सामग्री प्रदाता से प्लेलिस्ट प्राप्त करें। बॉडी: { ministryId, providerId, path, resolution } |
| POST | /getInstructions | JWT | — | किसी सामग्री आइटम के निर्देश प्राप्त करें। बॉडी: { ministryId, providerId, path } |
| POST | /getExpandedInstructions | JWT | — | किसी सामग्री आइटम के विस्तृत निर्देश प्राप्त करें। बॉडी: { ministryId, providerId, path } |
संबंधित पृष्ठ
- Membership Endpoints — लोग, समूह, भूमिकाएँ और अनुमतियाँ
- Attendance Endpoints — सेवा और विज़िट ट्रैकिंग
- Module Structure — कोड संगठन के पैटर्न