Крајње тачке модула Чланство
Модул Чланство управља особама, црквама, групама, домаћинствима, улогама, дозволама, обрасцима и подешавањима. То је најобимнији модул и пружа основни слој идентитета и овлашћења за све остале модуле.
Основна путања: /membership
Особе
Основна путања: /membership/people
| Метода | Путања | Аутентификација | Дозвола | Опис |
|---|---|---|---|---|
| GET | / | JWT | People.View или Member | Списак свих особа за цркву |
| GET | /:id | JWT | People.View или сопствени запис | Приказ особе по ID-у (укључује слања образаца) |
| GET | /ids?ids= | JWT | People.View, Member или People.ViewNames | Преузимање више особа по ID-има раздвојеним зарезом. Позиваоци са People.ViewNames без People.View добијају основни модел, а особе које су се искључиле изостављају се (осим позиваоца) |
| GET | /basic?ids= | JWT | — | Основни подаци (само име) за више особа |
| GET | /names?ids= | JWT | Било која дозвола цркве | [{ id, name: { display, first, last }, photo }], сортирано по презимену, па по имену, за ID-ове раздвојене зарезом које позивалац већ има, тако да улоге без People.View (донације, присуство) могу да прикажу имена особа. Без претраге и без филтера директоријума |
| POST | /names | JWT | Било која дозвола цркве | Исто као GET /names. Тело: { peopleIds } (или { ids }) |
| GET | /recent | JWT | People.View, Member или People.ViewNames | Недавно додате особе. Позиваоци са People.ViewNames без People.View (чак и чланови са приступом директоријуму) добијају основни модел (id, name.display, photo, membershipStatus), а особе које су се искључиле изостављају се |
| GET | /guest-register/options?churchId= | Јавно | — | Контролна листа за пријаву гостију путем QR кода: враћа { email, phone, address, birthDate, gender, maritalStatus, grade, comments }, при чему је свако поље "off", "optional" или "required" (чита се из јавног подешавања guestRegistrationFields; непостојеће или неисправне вредности враћају имејл и телефон као опционе, а остало као искључено). Захтева enableQRGuestRegistration, осим ако захтев садржи одговарајући токен сајта или цркве; ограничено по броју захтева (429) |
| GET | /search?term=&email= | JWT | People.View, Member или People.ViewNames | Претрага особа по имену или имејлу (до 100, сортирано по презимену, па по имену). Позиваоци са People.ViewNames без People.View (чак и чланови са приступом директоријуму) добијају претрагу по имену која враћа основни модел; претрага по 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 | Јавно | — | Пронађи или креирај особу по имејлу. Тело: { churchId, email, firstName, lastName } |
| POST | /guest-register | Јавно | — | Пријава гостију путем 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 }] }, понављајући послата имена, а не сачуvana. Иста правила о пристанку, токену и ограничењу броја захтева као за позив опција |
| POST | /household/:householdId | JWT | People.Edit | Ажурирање додела чланова домаћинства |
| POST | /public/email | Јавно | — | Слање имејла особи. Тело: { churchId, personId, subject, body, appName } |
| POST | /apiEmails | Интерно | — | Учитавање имејлова особа по ID-има (серверска комуникација, захтева 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 | Јавно | — | Пријава (имејл и лозинка, освежавање JWT-а или authGuid) |
| POST | /register | Јавно | — | Регистрација новог корисника |
| POST | /forgot | Јавно | — | Слање имејла за поновно постављање лозинке |
| POST | /setPasswordGuid | Јавно | — | Постављање лозинке помоћу auth GUID-а из везе у имејлу |
| POST | /verifyCredentials | Јавно | — | Провера имејла и лозинке и враћање повезаних цркава |
| POST | /loadOrCreate | JWT | — | Пронађи или креирај корисника по имејлу или userId-у |
| POST | /setDisplayName | JWT | — | Ажурирање имена и презимена корисника |
| POST | /updateEmail | JWT | — | Промена имејл адресе корисника |
| POST | /updatePassword | JWT | — | Промена лозинке корисника (најмање 6 знакова) |
| POST | /updateOptedOut | JWT | — | Постављање статуса искљученог из комуникације за особу |
| POST | /sendInviteEmail | JWT | People.Edit | Слање позивнице особи у овој цркви (email, personName, contextName). Дугме гласи Sign Up за особу без налога, а Log In за постојећег корисника. Корисник који се никада није пријавио добија везу Set Your Password која истиче за 7 дана. Ово је фиксни шаблон, па се не урачунава у дневни лимит имејлова цркве |
| 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= | Јавно | — | Претрага цркава по имену |
| GET | /lookup/?subDomain=&id= | Јавно | — | Претрага цркве по поддомену или ID-у |
| POST | / | JWT | Settings.Edit | Ажурирање података о цркви |
| POST | /add | JWT | — | Регистрација нове цркве. Обавезна поља: name, address1, city, state, zip, country |
| POST | /search | Јавно | — | Претрага цркава по имену (POST варијанта) |
| POST | /select | JWT | — | Избор или прелазак на цркву. Тело: { churchId } или { subDomain } |
| POST | /:id/archive | JWT | Server.Admin | Архивирање или враћање цркве из архиве |
| POST | /byIds | Јавно | — | Учитавање више цркава по ID-има |
| 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 | Јавно | — | Преузимање јавне групе по цркви и ID-у |
| GET | /public/:churchId/tag/:tag | Јавно | — | Јавне групе по ознаци |
| GET | /public/:churchId/label?label= | Јавно | — | Јавне групе по ознаци (label) |
| GET | /public/:churchId/slug/:slug | Јавно | — | Преузимање јавне групе по 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, као и за ?groupId= било које групе која није поверљива када корисник има Attendance.View или Attendance.Edit (чланови млађи од 13 година су за њих укључени) |
| GET | /my | JWT | — | Преузимање чланстава у групама за тренутног корисника |
| GET | /basic/:groupId | JWT | — | Преузимање основног списка чланова групе |
| GET | /public/leaders/:churchId/:groupId | Јавно | — | Преузимање вођа групе (јавно) |
| GET | /public/:churchId/:groupId | Јавно | — | Преузимање јавног списка групе (минимална поља: personId, displayName, leader, фотографија). Само када група укључи publicRoster; користи се за елемент 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 | Преузимање дозвола за улогу (null као ID за улогу „Everyone“) |
| 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 самосталних слања образаца (не образаца за особе) која је пријављени члан послао или која су повезана са његовом особом (contentType person, contentId = ID његове особе, на пример након измене коју је направио администратор), од најновијег, а свако са form.name. include додаје питања за сваки образац и одговоре на слање. Враћа 401 ако корисник није повезан са особом. Користи се за одељак My Forms на страници B1 Me |
| GET | /group/:groupId | JWT | Вођа групе | Одговори за вође групе: један унос по повезаном обрасцу и по догађају групе са обрасцем за пријаву, сваки са form, event (id, title, start; само за уносе догађаја), questions и submissions (са answers и personName, null ако је анонимно) |
| GET | /:id | JWT | Forms.Admin, Forms.Edit или приступ за приказ | Преузимање слања по ID-у. Додајте ?include=form,questions,answers. Вође групе повезане са обрасцем и вође групе којој припада пријава на догађај такође га могу читати |
| GET | /formId/:formId | JWT | Приступ обрасцу (приказ) | Преузимање свих слања за образац (укључује form, questions, answers). Вође групе повезане са обрасцем имају приступ за приказ |
| 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 | Јавно | — | Преузимање јавних подешавања за цркву |
| 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 | Јавно | — | Јавна претрага домена по називу |
| GET | /health/check | Јавно | — | Покретање провере исправности за непроверене домене |
| 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 | — | Претрага чланова на природном језику помоћу вештачке интелигенције. Тело: { text, subDomain, siteUrl } |
Грешке клијента
Основна путања: /membership/clientErrors
| Метода | Путања | Аутентификација | Дозвола | Опис |
|---|---|---|---|---|
| POST | / | JWT | — | Бележење грешке на страни клијента |
Повезане странице
- Аутентификација и дозволе — ток пријаве, JWT, OAuth, модел дозвола
- Крајње тачке присуства — праћење услуга и посета
- Структура модула — обрасци организације кода