Пријавите се на главни садржај

Крајње тачке модула Чланство

Модул Чланство управља особама, црквама, групама, домаћинствима, улогама, дозволама, обрасцима и подешавањима. То је најобимнији модул и пружа основни слој идентитета и овлашћења за све остале модуле.

Основна путања: /membership

Особе​

Основна путања: /membership/people

МетодаПутањаАутентификацијаДозволаОпис
GET/JWTPeople.View или MemberСписак свих особа за цркву
GET/:idJWTPeople.View или сопствени записПриказ особе по ID-у (укључује слања образаца)
GET/ids?ids=JWTPeople.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/namesJWTБило која дозвола црквеИсто као GET /names. Тело: { peopleIds } (или { ids })
GET/recentJWTPeople.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=JWTPeople.View, Member или People.ViewNamesПретрага особа по имену или имејлу (до 100, сортирано по презимену, па по имену). Позиваоци са People.ViewNames без People.View (чак и чланови са приступом директоријуму) добијају претрагу по имену која враћа основни модел; претрага по email враћа []
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 или People.ViewNamesПретрага особа (POST варијанта). Тело: { term } или { email }; важе иста правила као за GET /search када је реч о имену
POST/advancedSearchJWTPeople.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/:householdIdJWTPeople.EditАжурирање додела чланова домаћинства
POST/public/emailЈавно—Слање имејла особи. Тело: { churchId, personId, subject, body, appName }
POST/apiEmailsИнтерно—Учитавање имејлова особа по ID-има (серверска комуникација, захтева 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"
}
]

Пример: креирање особе​

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/loadOrCreateJWT—Пронађи или креирај корисника по имејлу или userId-у
POST/setDisplayNameJWT—Ажурирање имена и презимена корисника
POST/updateEmailJWT—Промена имејл адресе корисника
POST/updatePasswordJWT—Промена лозинке корисника (најмање 6 знакова)
POST/updateOptedOutJWT—Постављање статуса искљученог из комуникације за особу
POST/sendInviteEmailJWTPeople.EditСлање позивнице особи у овој цркви (email, personName, contextName). Дугме гласи Sign Up за особу без налога, а Log In за постојећег корисника. Корисник који се никада није пријавио добија везу Set Your Password која истиче за 7 дана. Ово је фиксни шаблон, па се не урачунава у дневни лимит имејлова цркве
GET/search?term=JWTServer.AdminПретрага свих корисника по имену или имејлу
DELETE/JWT—Брисање налога тренутног корисника

Цркве​

Основна путања: /membership/churches

МетодаПутањаАутентификацијаДозволаОпис
GET/JWT—Учитавање свих цркава за тренутног корисника
GET/:idJWT—Преузимање цркве по ID-у
GET/:id/getDomainAdminJWT—Преузимање администратора домена за цркву
GET/:id/impersonateJWTServer.AdminПријава као црква (само серверски администратор)
GET/all?term=JWTServer.AdminПретрага свих цркава (администратор)
GET/search/?name=Јавно—Претрага цркава по имену
GET/lookup/?subDomain=&id=Јавно—Претрага цркве по поддомену или ID-у
POST/JWTSettings.EditАжурирање података о цркви
POST/addJWT—Регистрација нове цркве. Обавезна поља: name, address1, city, state, zip, country
POST/searchЈавно—Претрага цркава по имену (POST варијанта)
POST/selectJWT—Избор или прелазак на цркву. Тело: { churchId } или { subDomain }
POST/:id/archiveJWTServer.AdminАрхивирање или враћање цркве из архиве
POST/byIdsЈавно—Учитавање више цркава по ID-има
DELETE/deleteAbandonedJWTServer.AdminБрисање цркава напуштених 7 и више дана

Групе​

Основна путања: /membership/groups

Проширује стандардни CRUD (GET /, GET /:id из основне класе).

МетодаПутањаАутентификацијаДозволаОпис
GET/JWT—Списак свих група
GET/:idJWT—Преузимање групе по ID-у
GET/search?campusId=&serviceId=&serviceTimeId=JWT—Претрага група по филтерима услуга
GET/myJWT—Преузимање група за тренутног корисника
GET/my/:tagJWT—Групе тренутног корисника филтриране по ознаци
GET/tag/:tagJWT—Све групе са одређеном ознаком
GET/public/:churchId/:idЈавно—Преузимање јавне групе по цркви и ID-у
GET/public/:churchId/tag/:tagЈавно—Јавне групе по ознаци
GET/public/:churchId/label?label=Јавно—Јавне групе по ознаци (label)
GET/public/:churchId/slug/:slugЈавно—Преузимање јавне групе по slug-у
POST/JWTGroups.EditКреирање или ажурирање група (slug се генерише аутоматски)
DELETE/:idJWTGroups.EditБрисање групе (брише и подређене тимове за службе)

Чланови групе​

Основна путања: /membership/groupmembers

Проширује стандардни CRUD (GET /:id, DELETE /:id из основне класе).

МетодаПутањаАутентификацијаДозволаОпис
GET/:idJWTGroupMembers.ViewПреузимање члана групе по ID-у
GET/JWTGroupMembers.View*Списак чланова групе. Филтрирање помоћу ?groupId=, ?groupIds= или ?personId=. *Такође је дозвољено ако је корисник у групи или тражи свој personId, као и за ?groupId= било које групе која није поверљива када корисник има Attendance.View или Attendance.Edit (чланови млађи од 13 година су за њих укључени)
GET/myJWT—Преузимање чланстава у групама за тренутног корисника
GET/basic/:groupIdJWT—Преузимање основног списка чланова групе
GET/public/leaders/:churchId/:groupIdЈавно—Преузимање вођа групе (јавно)
GET/public/:churchId/:groupIdЈавно—Преузимање јавног списка групе (минимална поља: personId, displayName, leader, фотографија). Само када група укључи publicRoster; користи се за елемент staffGrid у градитељу веб-сајта
POST/JWTGroupMembers.EditДодавање или ажурирање чланова групе
DELETE/:idJWTGroupMembers.ViewУклањање члана групе

Домаћинства​

Основна путања: /membership/households

Стандардни CRUD контролер.

МетодаПутањаАутентификацијаДозволаОпис
GET/JWT—Списак свих домаћинстава
GET/:idJWT—Преузимање домаћинства по ID-у
POST/JWTPeople.EditКреирање или ажурирање домаћинстава
DELETE/:idJWTPeople.EditБрисање домаћинства

Улоге​

Основна путања: /membership/roles

МетодаПутањаАутентификацијаДозволаОпис
GET/:idJWTRoles.ViewПреузимање улоге по ID-у
GET/church/:churchIdJWTRoles.ViewПреузимање свих улога за цркву. Свака улога садржи memberCount, односно број различитих корисника у њој
POST/JWTRoles.EditКреирање или ажурирање улога
DELETE/:idJWTRoles.EditБрисање улоге (уклања и њене дозволе и чланове)

Чланови улоге​

Основна путања: /membership/rolemembers

МетодаПутањаАутентификацијаДозволаОпис
GET/roles/:idJWTRoles.ViewПреузимање чланова улоге. Додајте ?include=users да бисте укључили податке о корисницима
POST/JWTRoles.EditДодавање чланова у улогу (креира корисника ако имејл не постоји)
DELETE/:idJWTRoles.ViewУклањање члана улоге
DELETE/self/:churchId/:userIdJWT—Уклањање себе из цркве

Дозволе улога​

Основна путања: /membership/rolepermissions

МетодаПутањаАутентификацијаДозволаОпис
GET/roles/:idJWTRoles.ViewПреузимање дозвола за улогу (null као ID за улогу „Everyone“)
POST/JWTRoles.EditКреирање или ажурирање дозвола за улоге
DELETE/:idJWTRoles.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/JWTForms.Admin или Forms.EditСписак свих образаца (администратор види све; уредници виде додељене и обрасце који нису за чланове)
GET/:idJWTПриступ обрасцуПреузимање обрасца по ID-у
GET/archivedJWTForms.Admin или Forms.EditСписак архивираних образаца
GET/group/:groupIdJWTЧлан групе, вођа групе или Forms.AdminСамостални обрасци повезани са групом (forms.groupId), без архивираних, сортирани по називу. Враћа id, name, description и open (у оквиру периода доступности). Чланови добијају само отворене обрасце; вође и администратори образаца добијају и затворене. Користи се за обрасце повезане на страници групе
GET/standalone/:id?churchId=JWT—Преузимање самосталног обрасца (ограничени обрасци захтевају пријаву)
POST/JWTForms.Admin или Forms.EditКреирање или ажурирање образаца. Самостални обрасци прихватају опционо photoUrl (фотографију у заглављу изнад обрасца) и groupId (повезану групу)
DELETE/:idJWTПриступ обрасцуБрисање обрасца

Слања образаца​

Основна путања: /membership/formsubmissions

МетодаПутањаАутентификацијаДозволаОпис
GET/JWTForms.Admin или Forms.EditСписак слања. Филтрирање помоћу ?personId= или ?formId=
GET/my?include=questions,answersJWT—Само за себе: до 50 самосталних слања образаца (не образаца за особе) која је пријављени члан послао или која су повезана са његовом особом (contentType person, contentId = ID његове особе, на пример након измене коју је направио администратор), од најновијег, а свако са form.name. include додаје питања за сваки образац и одговоре на слање. Враћа 401 ако корисник није повезан са особом. Користи се за одељак My Forms на страници B1 Me
GET/group/:groupIdJWTВођа групеОдговори за вође групе: један унос по повезаном обрасцу и по догађају групе са обрасцем за пријаву, сваки са form, event (id, title, start; само за уносе догађаја), questions и submissions (са answers и personName, null ако је анонимно)
GET/:idJWTForms.Admin, Forms.Edit или приступ за приказПреузимање слања по ID-у. Додајте ?include=form,questions,answers. Вође групе повезане са обрасцем и вође групе којој припада пријава на догађај такође га могу читати
GET/formId/:formIdJWTПриступ обрасцу (приказ)Преузимање свих слања за образац (укључује form, questions, answers). Вође групе повезане са обрасцем имају приступ за приказ
POST/JWT—Слање одговора на образац (обрађује ограничене и неограничене обрасце, шаље обавештења имејлом). Када образац има autoCreatePerson, пронађи или креирај особу типа Guest по имејлу и повежи слање; када образац има и groupId, додај ту особу у групу; када су постављени followUpSubject или followUpBody, пошаљи пошиљаоцу имејл за праћење по шаблону. Ако позивалац не може да управља обрасцем, submittedBy се увек поставља на особу пријављеног члана (или остаје празно за анонимна слања)
DELETE/:idJWTForms.Admin или Forms.EditБрисање слања и његових одговора

Питања​

Основна путања: /membership/questions

МетодаПутањаАутентификацијаДозволаОпис
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

МетодаПутањаАутентификацијаДозволаОпис
GET/JWTForms.Admin или Forms.EditСписак одговора. Филтрирање помоћу ?formSubmissionId=
POST/JWTForms.Admin или Forms.EditКреирање или ажурирање одговора

Дозволе чланова​

Основна путања: /membership/memberpermissions

Управља приступом појединачних чланова одређеним обрасцима.

МетодаПутањаАутентификацијаДозволаОпис
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

МетодаПутањаАутентификацијаДозволаОпис
GET/JWTSettings.EditПреузимање свих подешавања за цркву
GET/public/:churchIdЈавно—Преузимање јавних подешавања за цркву
POST/JWTSettings.EditЧување подешавања (подржава отпремање слика у base64 формату)

Домени​

Основна путања: /membership/domains

Проширује стандардни CRUD (GET /:id, GET /, DELETE /:id из основне класе).

МетодаПутањаАутентификацијаДозволаОпис
GET/JWT—Списак свих домена
GET/:idJWT—Преузимање домена по ID-у
GET/lookup/:domainNameJWT—Претрага домена по називу
GET/public/lookup/:domainNameЈавно—Јавна претрага домена по називу
GET/health/checkЈавно—Покретање провере исправности за непроверене домене
POST/JWTSettings.EditКреирање или ажурирање домена (покреће ажурирање Caddy-ја)
DELETE/:idJWTSettings.EditБрисање домена

Веза корисник–црква​

Основна путања: /membership/userchurch

Управља везом између корисника и цркава.

МетодаПутањаАутентификацијаДозволаОпис
GET/userid/:userIdJWT—Преузимање записа о вези корисника и цркве по userId-у
GET/personid/:personIdJWT—Преузимање имејла повезаног корисника за особу
GET/user/:userIdJWTServer.AdminУчитавање свих цркава за корисника
POST/JWT—Креирање везе корисника и цркве
PATCH/:userIdJWT—Ажурирање времена последњег приступа и бележење приступа
DELETE/record/:userId/:churchId/:personIdJWT—Брисање записа о вези корисника и цркве

Подешавања видљивости​

Основна путања: /membership/visibilityPreferences

МетодаПутањаАутентификацијаДозволаОпис
GET/myJWT—Преузимање подешавања видљивости тренутног корисника
POST/JWT—Чување подешавања видљивости (видљивост адресе, телефона и имејла)

Упит​

Основна путања: /membership/query

МетодаПутањаАутентификацијаДозволаОпис
POST/membersJWT—Претрага чланова на природном језику помоћу вештачке интелигенције. Тело: { text, subDomain, siteUrl }

Грешке клијента​

Основна путања: /membership/clientErrors

МетодаПутањаАутентификацијаДозволаОпис
POST/JWT—Бележење грешке на страни клијента

Повезане странице​