church_of_jesus_christ_api package¶
Submodules¶
church_of_jesus_christ_api.church_of_jesus_christ_api module¶
The module that implements ChurchOfJesusChristAPI. This module allows the user to get data from churchofjesuschrist.org.
-
class
church_of_jesus_christ_api.church_of_jesus_christ_api.ChurchOfJesusChristAPI¶ Bases:
objectA class used to interact with features found on churchofjesuschrist.org, such as getting member data, calling information, reports, etc.
-
convert_date_to_string_using_default_date_if_none(val, default)¶
-
get_action_and_interviews()¶ Returns the unit action and interview list
Parameters
- unit : int
- Number of the church unit for which to retrieve the report
- timeout_sec : int
- Number of seconds to wait for a response when making a request
Returns
[ { description: str, key: str, list: [ { accountable: bool, action: str, actualAge: int, actualAgeInMonths: int, address: str, age: int, ailActionType: str, birthDate: str, birthDateFormatted: str, birthDateSort: str, birthDayFormatted: str, birthDaySort: str, calling: NoneType, confirmationDate: NoneType, confirmationDateFormatted: NoneType, email: NoneType, formattedMrn: NoneType, gender: str, genderCode: int, genderLabelShort: str, householdEmail: NoneType, householdPhone: str, id: int, interviewComplete: bool, interviewDate: NoneType, mrn: NoneType, name: str, nameOrder: int, nonMember: bool, notAccountable: bool, outOfUnitMember: bool, phone: str, priesthood: NoneType, priesthoodCode: NoneType, priesthoodType: NoneType, setApart: bool, spokenName: str, status: str, sustainedDate: NoneType, unitName: str, unitNumber: int, visible: NoneType } ], tab: str, title: str, type: str } ]
-
get_assigned_missionaries()¶ Returns a list of the missionaries currently assigned to serve in the unit
Parameters unit : int
Number of the church unit for which to retrieve the report- timeout_sec : int
- Number of seconds to wait for a response when making a request
Returns
[ { accountable: bool, actualAge: NoneType, actualAgeInMonths: NoneType, age: NoneType, birthDate: NoneType, birthDateFormatted: str, birthDateSort: NoneType, birthDayFormatted: NoneType, birthDaySort: NoneType, email: str, formattedMrn: NoneType, gender: NoneType, genderCode: NoneType, genderLabelShort: str, householdEmail: NoneType, householdPhone: NoneType, id: int, missionOfficeAddress: NoneType, missionUnitName: str, missionUnitNumber: int, mrn: NoneType, name: str, nameOrder: NoneType, nonMember: bool, notAccountable: bool, outOfUnitMember: bool, phone: str, priesthood: NoneType, priesthoodCode: NoneType, priesthoodType: NoneType, setApart: bool, spokenName: NoneType, sustainedDate: NoneType, unitName: NoneType, unitNumber: NoneType, urlAddressSearch: NoneType, visible: NoneType } ]
-
get_attendance()¶ Returns the attendance list for the last 5 weeks
Parameters
- unit : int
- Number of the church unit for which to retrieve the report
- timeout_sec : int
- Number of seconds to wait for a response when making a request
Returns
{ allAvailableDates: [ { epochSeconds: int, isoYearMonthDay: str, loaded: bool, localeMonthDay: str } ], attendanceData: { attendees: [ { cmisId: int, displayName: str, entries: [ { date: { epochSeconds: int, isoYearMonthDay: str, loaded: bool, localeMonthDay: str }, isMarkedAttended: bool, markedAttended: bool } ], gender: str, sortName: str, unitOrgsCombined: [ str ], uuid: str } ], visitorCategories: [ { countsByDate: { 2023-06-18: int, 2023-06-25: int, 2023-07-02: int, 2023-07-09: int, 2023-07-16: int }, displayName: str, name: str } ] }, dates: [ { epochSeconds: int, isoYearMonthDay: str, loaded: bool, localeMonthDay: str } ] }
-
get_attendance_date_range()¶ Returns the attendance list for a given date range (default 1 year ago to today)
Parameters
- start_date: datetime.date
- The start date after which attendance will be retrieved
- end_date: datetime.date
- The end date after which attendance will no longer be retrieved
- unit : int
- Number of the church unit for which to retrieve the report
- timeout_sec : int
- Number of seconds to wait for a response when making a request
Returns
{ allAvailableDates: NoneType, attendanceData: { attendees: [ { cmisId: NoneType, displayName: NoneType, entries: [ { date: { epochSeconds: int, isoYearMonthDay: str, loaded: bool, localeMonthDay: str }, isMarkedAttended: bool, markedAttended: bool } ], gender: NoneType, sortName: NoneType, unitOrgsCombined: NoneType, uuid: str } ], visitorCategories: [ { countsByDate: { 2022-07-10: int, 2022-07-17: int, 2022-07-24: int, 2022-07-31: int, 2022-08-07: int, 2022-08-14: int, 2022-08-21: int, 2022-08-28: int, 2022-09-04: int, 2022-09-11: int, 2022-09-18: int, 2022-09-25: int, 2022-10-02: int, 2022-10-09: int, 2022-10-16: int, 2022-10-23: int, 2022-10-30: int, 2022-11-06: int, 2022-11-13: int, 2022-11-20: int, 2022-11-27: int, 2022-12-04: int, 2022-12-11: int, 2022-12-18: int, 2022-12-25: int, 2023-01-01: int, 2023-01-08: int, 2023-01-15: int, 2023-01-22: int, 2023-01-29: int, 2023-02-05: int, 2023-02-12: int, 2023-02-19: int, 2023-02-26: int, 2023-03-05: int, 2023-03-12: int, 2023-03-19: int, 2023-03-26: int, 2023-04-02: int, 2023-04-09: int, 2023-04-16: int, 2023-04-23: int, 2023-04-30: int, 2023-05-07: int, 2023-05-14: int, 2023-05-21: int, 2023-05-28: int, 2023-06-04: int, 2023-06-11: int, 2023-06-18: int, 2023-06-25: int, 2023-07-02: int, 2023-07-09: int, 2023-07-16: int }, displayName: str, name: str } ] }, dates: NoneType }
-
get_birthdays()¶ Returns the unit birthday list
Parameters
- unit : int
- Number of the church unit for which to retrieve the report
- timeout_sec : int
- Number of seconds to wait for a response when making a request
Returns
[ { birthdays: [ { accountable: bool, actualAge: int, actualAgeInMonths: int, address: str, age: int, birthDate: str, birthDateFormatted: str, birthDateSort: str, birthDayAge: int, birthDayFormatted: str, birthDaySort: str, dayInteger: int, displayBirthdate: str, email: NoneType, formattedMrn: NoneType, gender: str, genderCode: int, genderLabelShort: str, householdEmail: NoneType, householdPhone: str, id: int, monthInteger: int, mrn: NoneType, name: str, nameOrder: NoneType, nonMember: bool, notAccountable: bool, outOfUnitMember: bool, phone: str, priesthood: NoneType, priesthoodCode: NoneType, priesthoodType: NoneType, setApart: bool, spokenName: str, sustainedDate: NoneType, unitName: str, unitNumber: int, visible: NoneType } ] } ]
-
get_directory()¶ Returns the unit directory of households
Parameters
- unit : int
- Number of the church unit for which to retrieve the report
- timeout_sec : int
- Number of seconds to wait for a response when making a request
Returns
[ { address: str, coordinates: { lat: float, long: float }, displayName: str, email: str, familyName: str, members: [ { displayName: str, email: str, familyName: str, givenName: str, head: bool, householdUuid: str, individualId: int, permissions: [ str ], phone: str, positions: [ { name: str, setApart: bool, type: str, unitName: str, unitNumber: int, uuid: str } ], preferredName: str, uuid: str } ], permissions: [ str ], phone: str, unitNumber: int, uuid: str, verified: bool } ]
-
get_family_history_report()¶ Returns the unit family history report
Parameters
- unit : int
- Number of the church unit for which to retrieve the report
- timeout_sec : int
- Number of seconds to wait for a response when making a request
Returns
{ error: bool, participationReports: { addedAncestor: [ { label: NoneType, membersAddingAncestor: int, monthEndDate: str, monthEndDisplayLabel: str, title: str } ], addedMemory: [ { label: NoneType, membersAddingMemory: int, monthEndDate: str, monthEndDisplayLabel: str, title: str } ], loggingIn: [ { label: NoneType, membersLoggingIn: int, monthEndDate: str, monthEndDisplayLabel: str, title: NoneType } ], membersWhoIndexed: [ { label: NoneType, membersIndexing: int, monthEndDate: str, monthEndDisplayLabel: str, title: str } ], percentageFourGen: [ { label: NoneType, monthEndDate: str, monthEndDisplayLabel: str, percent: float, title: NoneType } ], yearsInReport: [ str ] }, reportDate: str, submitterTrendReport: { trendData: [ { label: str, months: [ { month: int, submitters: int } ], year: int } ], ytdDiffYearOverYear: int }, ytdSubmittersReports: { monthEndDate: str, summary: { adultPercentage: str, adultSubmitters: int, convertPercentage: str, convertSubmitters: int, percentSubmitting: float, totalAdults: int, totalConverts: int, totalMembersSubmitting: int, totalPercentage: str, totalPotentialSubmitters: int, totalYouth: int, totalYsa: int, unitName: str, unitNumber: int, youthPercentage: str, youthSubmitters: int, ysaSubmitters: int, ysasPercentage: str }, unitTotals: [ { adultPercentage: str, adultSubmitters: int, convertPercentage: str, convertSubmitters: int, percentSubmitting: float, totalAdults: int, totalConverts: int, totalMembersSubmitting: int, totalPercentage: str, totalPotentialSubmitters: int, totalYouth: int, totalYsa: int, unitName: str, unitNumber: int, youthPercentage: str, youthSubmitters: int, ysaSubmitters: int, ysasPercentage: str } ] } }
-
get_full_time_missionaries()¶ Returns a list of the members from the unit currently serving missions
Parameters unit : int
Number of the church unit for which to retrieve the report- timeout_sec : int
- Number of seconds to wait for a response when making a request
Returns
[ { email: str, endDate: str, member: { accountable: bool, actualAge: int, actualAgeInMonths: int, age: int, birthDate: str, birthDateFormatted: str, birthDateSort: str, birthDayFormatted: str, birthDaySort: str, email: str, formattedMrn: NoneType, gender: str, genderCode: int, genderLabelShort: str, householdEmail: NoneType, householdPhone: NoneType, id: int, missionOfficeAddress: NoneType, missionUnitName: NoneType, missionUnitNumber: NoneType, mrn: NoneType, name: str, nameOrder: NoneType, nonMember: bool, notAccountable: bool, outOfUnitMember: bool, phone: str, priesthood: NoneType, priesthoodCode: NoneType, priesthoodType: NoneType, setApart: bool, spokenName: NoneType, sustainedDate: NoneType, unitName: NoneType, unitNumber: NoneType, urlAddressSearch: NoneType, visible: NoneType }, missionName: str, missionOfficeAddress: NoneType, missionUnitNumber: int, missionaryHomeUnitName: str, missionaryHomeUnitNumber: int, missionaryIndividualId: int, missionaryName: str, myPlanComplete: NoneType, myPlanSharing: NoneType, myPlanUrl: NoneType, seniorMissionary: bool, startDate: str, status: str, urlAddressSearch: NoneType } ]
-
get_key_indicators()¶ Returns the unit key indicators
Parameters
- unit : int
- Number of the church unit for which to retrieve the report
- timeout_sec : int
- Number of seconds to wait for a response when making a request
Returns
{ quarters: [ str ], statistics: [ { label: str, name: str, stats: [ int ] } ] }
-
get_member_callings_and_classes()¶ Returns the callings and class assignments for the given member
Parameters
- member_id : int
- ID of the member for which to retrieve information
- timeout_sec : int
- Number of seconds to wait for a response when making a request
Returns
{ authorizedToEditCallings: bool, authorizedToEditClassAssignments: bool, classAssignments: [ { adultClass: bool, classId: int, className: str, classTypeId: int, defaultClass: bool, defaultClassTypeId: int, group: str, individualId: int, organization: str } ], householdCallings: list, individualCallings: [ { activeDate: str, allowApprove: bool, allowMultiple: bool, allowNew: bool, allowVacant: bool, approvalRequest: bool, autoReleasedPositionTypeIds: NoneType, canHaveResponsibilities: bool, contactEmail: str, contactInfoEditable: bool, contactMailingAddr: NoneType, contactMobilePhone: NoneType, contactWorkPhone: NoneType, custom: bool, customNameChanged: bool, dualAuthPass: NoneType, dualAuthUser: NoneType, editable: bool, errors: {}, expectedEndDate: NoneType, hasContactInfo: bool, hidden: bool, memberEmail: str, memberId: int, memberName: str, memberNameOrder: int, memberPhone: NoneType, memberUnitName: NoneType, memberUnitNumber: NoneType, missionName: NoneType, missionUnitNumber: NoneType, missionary: bool, missionaryHomeUnitName: NoneType, mrn: NoneType, nameVerificationForMrn: NoneType, newSubOrgId: NoneType, ordainDate: NoneType, ordainedByPersonId: NoneType, ordainedByPersonMrn: NoneType, ordainedByPersonName: NoneType, organization: str, otherAllowedSubOrgs: [ { children: list, classGroup: NoneType, defaultOrgTypeIds: [ int ], firstTypeId: int, gender: NoneType, isClass: bool, isCombined: bool, isRealClass: bool, isSplit: bool, name: str, orgTypeIds: [ int ], parentName: str, subOrgId: int, unitNumber: int, userCanEditCallings: bool } ], parentOrganization: NoneType, pendingCalling: bool, pendingDelete: bool, pendingDualAuth: bool, position: str, positionDisplayOrder: int, positionId: int, positionTypeEnum: str, positionTypeId: int, previouslyOrdained: bool, releaseDate: NoneType, releasePositionIds: NoneType, requiresBishopOrdination: bool, requiresDualAuthorization: bool, requiresSetApartDateAndPerson: bool, responsibilities: NoneType, sequence: int, setApart: bool, setApartByPersonId: NoneType, setApartByPersonMrn: NoneType, setApartByPersonName: NoneType, setApartDate: NoneType, showUnitCard: bool, subOrgId: int, subOrgTypeId: int, unitName: str, unitNumber: int, unpublished: bool, userCanEdit: bool, userCanEditContactInfoOnly: bool, userCannotEditPreviousOrdination: bool, vacant: bool } ], subOrgsForPotentialNewCallings: [ { children: list, classGroup: NoneType, defaultOrgTypeIds: [ int ], firstTypeId: int, gender: NoneType, isClass: bool, isCombined: bool, isRealClass: bool, isSplit: bool, name: str, orgTypeIds: [ int ], parentName: str, subOrgId: int, unitNumber: int, userCanEditCallings: bool } ] }
-
get_member_list()¶ Returns the unit member list
Parameters
- unit : int
- Number of the church unit for which to retrieve the report
- timeout_sec : int
- Number of seconds to wait for a response when making a request
Returns
[ { address: { addressLines: [ str ], formatted1: NoneType, formatted2: NoneType, formatted3: NoneType, formatted4: NoneType, formatted5: NoneType, formatted6: NoneType, formattedAll: list, formattedLine1: str, formattedLine2: str, formattedLine3: NoneType, formattedLine4: NoneType, useType: NoneType }, age: int, birth: { country: NoneType, date: { calc: str, date: str, display: str }, monthDay: { calc: str, date: str, display: str }, place: NoneType }, convert: bool, email: str, emails: [ { email: str, ownerType: NoneType, useType: NoneType } ], formattedAddress: str, houseHoldMemberNameForList: str, householdAnchorPersonUuid: str, householdEmail: NoneType, householdMember: { household: { address: { addressLines: [ str ], formatted1: NoneType, formatted2: NoneType, formatted3: NoneType, formatted4: NoneType, formatted5: NoneType, formatted6: NoneType, formattedAll: list, formattedLine1: str, formattedLine2: str, formattedLine3: NoneType, formattedLine4: NoneType, useType: NoneType }, anchorPerson: { legacyCmisId: int, uuid: str }, directoryPreferredLocal: str, emails: NoneType, familyNameLocal: str, phones: [ { internationalFormat: NoneType, number: str, ownerType: NoneType, useType: NoneType } ], unit: { addressUnknown: NoneType, adminUnit: NoneType, cdolLink: NoneType, children: NoneType, nameLatin: NoneType, nameLocal: str, parentUnit: NoneType, positions: NoneType, unitNumber: int, unitType: NoneType, uuid: NoneType }, uuid: str }, householdRole: str, membershipUnitFlag: bool }, householdNameDirectoryLocal: str, householdNameFamilyLocal: str, householdPhoneNumber: str, householdRole: str, householdUuid: str, households: NoneType, isAdult: bool, isHead: bool, isMember: bool, isOutOfUnitMember: bool, isProspectiveElder: bool, isSingleAdult: bool, isSpouse: bool, isYoungSingleAdult: bool, legacyCmisId: int, member: bool, membershipUnit: NoneType, mrn: NoneType, nameFamilyPreferredLocal: str, nameFormats: { certificateChurchOfficerLocal: NoneType, familyPreferredLocal: str, givenPreferredLocal: str, listOfficial: NoneType, listPreferred: NoneType, listPreferredLocal: str, spokenPreferredLocal: NoneType }, nameGivenPreferredLocal: str, nameListPreferredLocal: str, nameOrder: int, outOfUnitMember: bool, personStatusFlags: { adult: bool, convert: bool, deceased: bool, hasPatriarchalBlessing: bool, member: bool, prospectiveElder: bool, singleAdult: bool, youngSingleAdult: bool }, personUuid: str, phoneNumber: str, phones: [ { internationalFormat: NoneType, number: str, ownerType: NoneType, useType: NoneType } ], positions: NoneType, priesthoodOffice: str, priesthoodTeacherOrAbove: bool, sex: str, unitName: str, unitNumber: int, unitOrgsCombined: [ str ], uuid: str, wamPolicy: NoneType, youthBasedOnAge: bool } ]
-
get_member_service()¶ Returns member’s service assignments
Parameters
- member_id : int
- ID of the member for which to retrieve information
- timeout_sec : int
- Number of seconds to wait for a response when making a request
Returns
{ authorizedToAddEndowment: bool, authorizedToEditMelchizedekPriesthood: bool, authorizedToPrintCertificates: bool, authorizedToPrintMelchizedekPriesthood: bool, authorizedToUpdateContactInfo: bool, authorizedToUpdateRecord: bool, authorizedToViewAnnotations: bool, authorizedToViewHTVT: bool, authorizedToViewRecord: bool, authorizedToViewReportBasic: bool, canChangeMoveRestriction: bool, consentFormId: NoneType, consentFormMediaType: NoneType, family: { children: list, hohMrn: NoneType, marriage: { authorizedToViewNonMemberSpouse: bool, country: NoneType, countryId: NoneType, date: NoneType, errors: {}, individualId: int, legalNameGroup: NoneType, madeHeadOfHousehold: bool, marriageId: str, marriageTerminated: bool, marriageTerminationCause: NoneType, memberStatus: NoneType, memberType: NoneType, mrn: str, nonMemberSpouseNameBirthdateNotEditable: bool, place: NoneType, preferredNameGroup: NoneType, restorationOfBlessingsRequired: bool, sealedToPriorSpouse: bool, sealingDate: NoneType, sealingTemple: NoneType, showTempleInfo: bool, spouse: { age: int, allPriesthoodOrdinations: NoneType, birthDate: str, deathDate: NoneType, deceased: bool, displayBirthDate: str, gender: str, headOfHousehold: bool, id: int, inAuthorizedUnit: bool, inHousehold: bool, linkedRecord: bool, listName: str, maidenName: str, maidenOrLegalName: str, member: bool, mrn: NoneType, name: str, nameGroup: NoneType, noMrnInitiated: bool, pendingId: NoneType, preferredOrLegalName: str, priesthood: NoneType, priesthoodCode: NoneType, priesthoodType: NoneType, relationship: str, relationshipDisplay: str, spokenName: NoneType, unitNumber: int, unknown: bool }, spouseDeceased: bool, spouseEditable: bool, spouseId: int, spouseInDifferentWardBranch: bool, spouseMember: bool, spouseMrn: NoneType, spouseUnitNumber: int, templeId: NoneType, terminationDate: NoneType, updateName: NoneType, updateRequests: NoneType, warnings: {} }, parents: NoneType }, household: { errors: {}, familyNameGroup: { autoRomanize: bool, formattedLatin: str, formattedLocal: str, name1: { family: str, given: NoneType, label: str, labelKey: NoneType, suffix: NoneType, translitSource: bool, writingSystem: str }, name2: NoneType, name3: NoneType }, hohMrn: NoneType, members: [ { age: int, allPriesthoodOrdinations: NoneType, birthDate: str, deathDate: NoneType, deceased: bool, displayBirthDate: str, gender: str, headOfHousehold: bool, id: int, inAuthorizedUnit: bool, inHousehold: bool, linkedRecord: bool, listName: str, maidenName: NoneType, maidenOrLegalName: str, member: bool, mrn: NoneType, name: str, nameGroup: NoneType, noMrnInitiated: bool, pendingId: NoneType, preferredOrLegalName: str, priesthood: NoneType, priesthoodCode: NoneType, priesthoodType: NoneType, relationship: str, relationshipDisplay: str, spokenName: NoneType, unitNumber: int, unknown: bool } ] }, individual: { actualAge: int, actualAgeInMonths: int, adultAgeOrMarried: bool, age: int, ageAsOfDec31: int, ageAsOfDec31NextYear: NoneType, birthCountry: NoneType, birthCountryId: NoneType, birthDate: str, birthDateDisplay: str, birthPlace: NoneType, canHaveCalling: bool, canHaveHTAssignment: bool, canHaveMaidenName: bool, canHaveVTAssignment: bool, confidentialEvents: NoneType, email: str, endowed: bool, errors: {}, formattedHouseholdCoupleName: str, formattedMrn: NoneType, gender: str, hasOutOfUnitRecord: bool, hasPatriarchalBlessing: bool, head: bool, headInUnit: bool, hohId: int, hohName: str, householdEmail: NoneType, householdPhone: NoneType, hqMoveRestriction: bool, id: int, legalNameGroup: { autoRomanize: bool, formattedLatin: str, formattedLocal: str, name1: { family: str, given: str, label: str, labelKey: NoneType, suffix: NoneType, translitSource: bool, writingSystem: str }, name2: NoneType, name3: NoneType }, maidenNameGroup: { autoRomanize: bool, formattedLatin: NoneType, formattedLocal: NoneType, name1: { family: NoneType, given: NoneType, label: str, labelKey: NoneType, suffix: NoneType, translitSource: bool, writingSystem: str }, name2: NoneType, name3: NoneType }, mailingAddress: { city: NoneType, country: NoneType, district: NoneType, formattedLines: NoneType, geocodeToUnits: bool, postalCode: NoneType, standardized: NoneType, state: NoneType, street1: NoneType, street2: NoneType, units: NoneType }, mailingSameAsResidential: bool, missionCountry: NoneType, missionCountryId: NoneType, missionLanguage: NoneType, missionLanguageId: NoneType, moveDate: NoneType, moveDateDuration: NoneType, moveRestriction: bool, moveRestrictionDate: NoneType, mrn: NoneType, name: str, nameUpdateReason: NoneType, notAccountable: bool, outOfUnit: bool, phone: str, preferredNameGroup: { autoRomanize: bool, formattedLatin: str, formattedLocal: str, name1: { family: str, given: str, label: str, labelKey: NoneType, suffix: NoneType, translitSource: bool, writingSystem: str }, name2: NoneType, name3: NoneType }, priesthood: str, priesthoodCode: int, primaryUnitName: str, primaryUnitNumber: NoneType, priorUnitName: NoneType, priorUnitNumber: NoneType, priorUnits: NoneType, recommendStatus: NoneType, residentialAddress: { city: str, country: int, district: NoneType, formattedLines: [ str ], geocodeToUnits: bool, postalCode: str, standardized: NoneType, state: int, street1: str, street2: NoneType, units: NoneType }, restorationOfBlessingsRequired: bool, sealedToSpouse: bool, spouseId: int, spouseInUnit: bool, spouseName: str, templeRecStatuses: NoneType, unitName: str, unitNumber: str, unsubscribedFromEmail: bool, updateRequests: NoneType, warnings: {} }, individualName: str, membershipUpdateRequests: NoneType, ordinances: { allOrdinances: [ { bic: bool, date: NoneType, note: NoneType, occurred: bool, ordinanceName: str, ordinanceType: str, templeId: NoneType, updateRequestExists: bool } ], baptism: { bic: bool, date: NoneType, note: NoneType, occurred: bool, ordinanceName: str, ordinanceType: str, templeId: NoneType, updateRequestExists: bool }, bic: { bic: bool, date: NoneType, note: NoneType, occurred: bool, ordinanceName: str, ordinanceType: str, templeId: NoneType, updateRequestExists: bool }, confirmation: { bic: bool, date: NoneType, note: NoneType, occurred: bool, ordinanceName: str, ordinanceType: str, templeId: NoneType, updateRequestExists: bool }, endowment: { bic: bool, date: NoneType, note: NoneType, occurred: bool, ordinanceName: str, ordinanceType: str, templeId: NoneType, updateRequestExists: bool }, errors: {}, hasEditableFields: bool, ordinanceFields: [ str ], priesthoods: { apostle: NoneType, deacon: NoneType, elder: { aaronic: bool, bic: bool, date: NoneType, melchizedek: bool, note: NoneType, occurred: bool, ordinanceName: str, ordinanceType: str, priesthoodType: NoneType, templeId: NoneType, updateRequestExists: bool }, highPriest: NoneType, priest: NoneType, priesthoods: [ { aaronic: bool, bic: bool, date: NoneType, melchizedek: bool, note: NoneType, occurred: bool, ordinanceName: str, ordinanceType: str, priesthoodType: NoneType, templeId: NoneType, updateRequestExists: bool } ], seventy: NoneType, teacher: NoneType, unknown: NoneType }, restorationOfBlessings: bool, sealedToParents: NoneType, sealedToSpouse: { bic: bool, date: NoneType, note: NoneType, occurred: bool, ordinanceName: str, ordinanceType: str, templeId: NoneType, updateRequestExists: bool }, updateRequests: NoneType, warnings: {} }, outOfUnitMember: bool, recommend: NoneType, showNotEditEnabledMessage: bool, stakeOrDistrictUser: bool, unitLocaleData: { addressFields: [ str ], hasLatinWritingSystem: bool, name1WritingSystem: str, name2WritingSystem: NoneType }, withinStewardship: bool }
-
get_members_with_callings()¶ Returns the unit list of members with callings
Parameters
- unit : int
- Number of the church unit for which to retrieve the report
- timeout_sec : int
- Number of seconds to wait for a response when making a request
Returns
[ { activeCalender: str, activeDate: str, age: int, birthDate: str, birthDateSort: str, birthdDateDisplay: str, custom: bool, customSubOrgName: NoneType, displaySequence: NoneType, district: bool, email: str, errors: {}, gender: str, id: int, leaderHomePhone: NoneType, leaderWorkPhone: NoneType, memberUnitName: str, memberUnitNumber: int, mrn: str, name: str, nameOrder: int, organization: str, outOfUnit: bool, parentSubOrgId: int, phone: str, position: str, positionId: int, positionTypeId: NoneType, priesthood: NoneType, setApart: bool, setApartCalender: str, setApartDate: str, spokenName: str, stake: bool, standardPosition: bool, subOrgId: int, subOrgType: str, subOrgTypeId: int, sustainedDate: str, unitName: str, unitNumber: int } ]
-
get_members_without_callings()¶ Returns the unit list of members without callings
Parameters
- unit : int
- Number of the church unit for which to retrieve the report
- timeout_sec : int
- Number of seconds to wait for a response when making a request
Returns
[ { accountable: bool, actualAge: int, actualAgeInMonths: int, age: int, birthDate: str, birthDateFormatted: str, birthDateSort: str, birthDayFormatted: str, birthDaySort: str, email: NoneType, formattedMrn: NoneType, gender: str, genderCode: int, genderLabelShort: str, householdEmail: NoneType, householdPhone: str, id: int, mrn: NoneType, name: str, nameOrder: NoneType, nonMember: bool, notAccountable: bool, outOfUnitMember: bool, phone: str, priesthood: NoneType, priesthoodCode: NoneType, priesthoodType: NoneType, setApart: bool, spokenName: str, sustainedDate: NoneType, unitName: str, unitNumber: int, visible: NoneType } ]
-
get_ministering()¶ Returns the unit ministering assignments
Parameters
- unit : int
- Number of the church unit for which to retrieve the report
- timeout_sec : int
- Number of seconds to wait for a response when making a request
Returns
{ households: [ { hasReliefSocietyMember: bool, headOfHouseholdCmisId: int, headOfHouseholdUuid: str, householdName: str, householdSortOrder: int, ministeringBrothers: [ { age: int, legacyCmisId: int, name: str, nameOrder: int, personUuid: str, youthBasedOnAge: bool } ], ministeringSisters: [ { age: int, legacyCmisId: int, name: str, nameOrder: int, personUuid: str, youthBasedOnAge: bool } ], unitName: str, unitNumber: int } ], individuals: [ { assignments: [ { age: int, legacyCmisId: int, name: str, nameOrder: int, personUuid: str, youthBasedOnAge: bool } ], companions: [ { age: int, legacyCmisId: int, name: str, nameOrder: int, personUuid: str, youthBasedOnAge: bool } ], legacyCmisId: int, name: str, nameOrder: int, personUuid: str, unitOrgTypeId: int, youthBasedOnAge: bool } ] }
-
get_ministering_full()¶ Returns the unit ministering assignments as well as interview information
Parameters
- unit : int
- Number of the church unit for which to retrieve the report
- timeout_sec : int
- Number of seconds to wait for a response when making a request
Returns
{ elders: [ { companionships: [ { assignments: [ { legacyCmisId: int, name: str, nameOrder: int, personUuid: str, youthBasedOnAge: bool } ], id: str, ministers: [ { assignType: str, email: str, legacyCmisId: int, name: str, nameOrder: int, personUuid: str, unitOrgId: str, youthBasedOnAge: bool } ], recentlyChangedDate: str, recentlyChangedDateInMilliseconds: int } ], districtName: str, districtUuid: str, supervisorLegacyCmisId: int, supervisorName: str, supervisorPersonUuid: str } ], eldersQuorumSupervisors: [ { legacyCmisId: int, name: str, nameOrder: int, personUuid: str, youthBasedOnAge: bool } ], error: bool, interviewViewAccess: bool, reliefSociety: [ { companionships: [ { assignments: [ { legacyCmisId: int, name: str, nameOrder: int, personUuid: str, youthBasedOnAge: bool } ], id: str, ministers: [ { assignType: str, email: str, interviews: [ { date: str, id: str, timestamp: str } ], legacyCmisId: int, name: str, nameOrder: int, personUuid: str, unitOrgId: str, youthBasedOnAge: bool } ], recentlyChangedDate: str, recentlyChangedDateInMilliseconds: int } ], districtName: str, districtUuid: str, supervisorLegacyCmisId: int, supervisorName: str, supervisorPersonUuid: str } ], reliefSocietySupervisors: [ { legacyCmisId: int, name: str, nameOrder: int, personUuid: str, youthBasedOnAge: bool } ], unitOrgs: [ { children: [ { children: NoneType, isClass: bool, unitNumber: int, unitOrgName: str, unitOrgTypeIds: [ int ], unitOrgUuid: str, unitUuid: str } ], isClass: bool, unitNumber: int, unitOrgName: str, unitOrgTypeIds: [ int ], unitOrgUuid: str, unitUuid: str } ] }
-
get_missionary_indicators()¶ Returns the unit missionary indicators
Parameters
- unit : int
- Number of the church unit for which to retrieve the report
- timeout_sec : int
- Number of seconds to wait for a response when making a request
Returns
{ error: str, message: str, status: int, timestamp: str }
-
get_missionary_progress_record()¶ Returns the unit missionary progress record
Parameters
- unit : int
- Number of the church unit for which to retrieve the report
- timeout_sec : int
- Number of seconds to wait for a response when making a request
Returns
{ error: str, message: str, status: int, timestamp: str }
-
get_mobile_sync_data()¶ Returns data that can be found in the Member Tools app. This is the endpoint used by the app when an update is requested.
Parameters
- unit : int
- Number of the church unit for which to retrieve the report
- timeout_sec : int
- Number of seconds to wait for a response when making a request
Returns
{ authorized: bool, countries: [ { addressFields: [ [ str ] ], dialingCode: int, id: int, iso: str, iso3: str, name: str, states: [ { id: int, name: str } ] } ], households: [ { address: str, coordinates: { lat: float, long: float }, displayName: str, familyName: str, members: [ { ageGroup: str, birthDate: str, classes: [ str ], displayName: str, email: str, familyName: str, givenName: str, head: bool, householdUuid: str, individualId: int, member: bool, ordinances: [ { type: str } ], permissions: [ str ], phone: str, positions: [ { activeDate: str, name: str, setApart: bool, type: str, unitName: str, unitNumber: int, uuid: str } ], preferredName: str, priesthood: str, priorUnitMoveOutDate: str, privacy: { email: str, master: str, phone: str, photo: str }, sex: str, unitMoveInDate: str, uuid: str } ], permissions: [ str ], phone: str, privacy: { address: str, coordinates: str, master: str, phone: str, photo: str }, unitNumber: int, uuid: str, verified: bool } ], ministering: [ { assignments: [ { companions: [ str ], members: [ str ] } ], brothers: [ str ], sisters: [ str ], uuid: str } ], missionLeaders: [ { leader: { optedIn: bool, preferredName: str, uuid: str }, mission: { name: str, unitNumber: int, unitType: str }, optedIn: bool, serviceEnded: str, serviceStarted: str, spouse: { optedIn: bool, preferredName: str, uuid: str }, uuid: str } ], missionariesAssigned: [ { areaId: int, email: str, mission: { address: str, email: str, name: str, phone: str, unitNumber: int }, missionaries: [ { displayName: str, email: str, preferredName: str, sex: str, type: str, uuid: str } ], phone: str, unitNumbers: [ int ] } ], missionariesServing: [ { displayName: str, email: str, mission: { address: str, email: str, name: str, phone: str, unitNumber: int }, preferredName: str, sex: str, type: str, unitNumber: int, uuid: str } ], organizations: [ { name: str, orgTypes: [ str ], positions: [ str ], unitNumber: int, uuid: str } ], reportsAccess: { cdolAccess: bool, units: [ { reports: [ str ], unitNumber: int } ] }, toEpoch: int, unitSubscriptions: [ int ], units: [ { childUnits: [ { name: str, unitNumber: int, unitType: str } ], name: str, unitNumber: int, unitType: str } ], user: { authorized: bool, country: str, developer: bool, homeUnits: [ int ], individualId: int, ldsAccountId: int, leaderParentUnits: [ int ], member: bool, mrn: str, parentUnits: [ int ], preferredLanguage: str, preferredName: str, proxyEdit: bool, proxyUnit: bool, proxyUser: bool, templeNearest: [ int ], templeUnits: [ int ], username: str, uuid: str }, uuid: str }
-
get_moved_in()¶ Returns the unit list of recently moved in members
Parameters
- unit : int
- Number of the church unit for which to retrieve the report
- timeout_sec : int
- Number of seconds to wait for a response when making a request
Returns
[ { address: str, addressUnknown: bool, age: int, birthdate: str, birthdateCalc: str, gender: str, genderLabelShort: str, householdPosition: str, householdPositionEnum: str, householdUuid: str, id: int, locale: str, moveDate: str, moveDateCalc: str, moveDateOrder: int, name: str, nameOrder: int, phone: str, priesthood: NoneType, priorUnitName: str, priorUnitNumber: str, textAddress: str, unitName: str } ]
-
get_moved_out()¶ Returns the unit list of recently moved out members
Parameters
- unit : int
- Number of the church unit for which to retrieve the report
- timeout_sec : int
- Number of seconds to wait for a response when making a request
Returns
[ { addressUnknown: bool, birthDate: str, deceased: bool, moveDate: str, moveDateOrder: int, name: str, nameOrder: int, nextUnitName: NoneType, nextUnitNumber: NoneType, priorUnit: NoneType } ]
-
get_new_members()¶ Returns the unit list of new members (recent converts)
Parameters
- unit : int
- Number of the church unit for which to retrieve the report
- timeout_sec : int
- Number of seconds to wait for a response when making a request
Returns
list
-
get_out_of_unit_callings()¶ Returns the unit list of members with callings out of unit
Parameters
- unit : int
- Number of the church unit for which to retrieve the report
- timeout_sec : int
- Number of seconds to wait for a response when making a request
Returns
{ LIVING_INSIDE: [ { activeCalender: str, activeDate: str, age: int, birthDate: str, birthDateSort: str, birthdDateDisplay: str, custom: bool, customSubOrgName: NoneType, displaySequence: int, district: bool, email: str, errors: {}, gender: str, id: int, leaderHomePhone: NoneType, leaderWorkPhone: NoneType, memberUnitName: str, memberUnitNumber: int, mrn: str, name: str, nameOrder: int, organization: str, outOfUnit: bool, parentSubOrgId: int, phone: str, position: str, positionId: int, positionTypeId: int, priesthood: NoneType, setApart: bool, setApartCalender: NoneType, setApartDate: NoneType, spokenName: str, stake: bool, standardPosition: bool, subOrgId: int, subOrgType: str, subOrgTypeId: int, sustainedDate: str, unitName: str, unitNumber: int } ], LIVING_OUTSIDE: list }
-
get_quarterly_reports()¶ Returns all available unit quarterly reports
Parameters
- unit : int
- Number of the church unit for which to retrieve the report
- timeout_sec : int
- Number of seconds to wait for a response when making a request
Returns
{ 2014: { 4: { childUnits: NoneType, converts: list, dueDate: str, editable: bool, errors: {}, initialSubmitDate: str, lastSaveDate: str, overdue: bool, quarter: int, sections: [ { label: str, nameResourceId: str, rows: [ { actualListType: str, actualValue: int, calculated: bool, childUnitNumber: NoneType, childUnitRows: NoneType, editable: bool, helpLabel: str, helpResourceId: str, label: str, lineReference: NoneType, nameResourceId: str, number: int, potentialListType: str, potentialValue: int, propertyName: NoneType, updatedActualValue: NoneType, valueStr: NoneType, year1Percent: str, year5Percent: str } ] } ], submitted: bool, unitNumber: int, version: str, year: int } }, 2015: { 4: { childUnits: NoneType, converts: list, dueDate: str, editable: bool, errors: {}, initialSubmitDate: str, lastSaveDate: str, overdue: bool, quarter: int, sections: [ { label: str, nameResourceId: str, rows: [ { actualListType: str, actualValue: int, calculated: bool, childUnitNumber: NoneType, childUnitRows: NoneType, editable: bool, helpLabel: str, helpResourceId: str, label: str, lineReference: NoneType, nameResourceId: str, number: int, potentialListType: str, potentialValue: int, propertyName: NoneType, updatedActualValue: NoneType, valueStr: NoneType, year1Percent: str, year5Percent: str } ] } ], submitted: bool, unitNumber: int, version: str, year: int } }, 2016: { 4: { childUnits: NoneType, converts: list, dueDate: str, editable: bool, errors: {}, initialSubmitDate: str, lastSaveDate: str, overdue: bool, quarter: int, sections: [ { label: str, nameResourceId: str, rows: [ { actualListType: str, actualValue: int, calculated: bool, childUnitNumber: NoneType, childUnitRows: NoneType, editable: bool, helpLabel: str, helpResourceId: str, label: str, lineReference: NoneType, nameResourceId: str, number: int, potentialListType: str, potentialValue: int, propertyName: NoneType, updatedActualValue: NoneType, valueStr: NoneType, year1Percent: str, year5Percent: str } ] } ], submitted: bool, unitNumber: int, version: str, year: int } }, 2017: { 4: { childUnits: NoneType, converts: list, dueDate: str, editable: bool, errors: {}, initialSubmitDate: str, lastSaveDate: str, overdue: bool, quarter: int, sections: [ { label: str, nameResourceId: str, rows: [ { actualListType: str, actualValue: int, calculated: bool, childUnitNumber: NoneType, childUnitRows: NoneType, editable: bool, helpLabel: str, helpResourceId: str, label: str, lineReference: NoneType, nameResourceId: str, number: int, potentialListType: str, potentialValue: int, propertyName: NoneType, updatedActualValue: NoneType, valueStr: NoneType, year1Percent: str, year5Percent: str } ] } ], submitted: bool, unitNumber: int, version: str, year: int } }, 2018: { 4: { childUnits: NoneType, converts: [ { accountable: bool, actualAge: int, actualAgeInMonths: int, age: int, attendMeetings: bool, birthDate: str, birthDateFormatted: str, birthDateSort: str, birthDayFormatted: str, birthDaySort: str, email: NoneType, formattedMrn: NoneType, gender: str, genderCode: int, genderLabelShort: str, hasCalling: bool, householdEmail: NoneType, householdPhone: NoneType, id: int, inAuthorizedUnit: bool, mrn: NoneType, name: str, nameOrder: NoneType, nonMember: bool, notAccountable: bool, outOfUnitMember: bool, phone: NoneType, priesthood: NoneType, priesthoodCode: int, priesthoodType: NoneType, quarterlyReportUnitNumber: int, setApart: bool, spokenName: str, sustainedDate: NoneType, unitName: NoneType, unitNumber: NoneType, visible: NoneType } ], dueDate: str, editable: bool, errors: {}, initialSubmitDate: str, lastSaveDate: str, overdue: bool, quarter: int, sections: [ { label: str, nameResourceId: str, rows: [ { actualListType: str, actualValue: int, calculated: bool, childUnitNumber: NoneType, childUnitRows: NoneType, editable: bool, helpLabel: str, helpResourceId: str, label: str, lineReference: NoneType, nameResourceId: str, number: int, potentialListType: str, potentialValue: int, propertyName: NoneType, updatedActualValue: NoneType, valueStr: NoneType, year1Percent: str, year5Percent: str } ] } ], submitted: bool, unitNumber: int, version: str, year: int } }, 2019: { 4: { childUnits: NoneType, converts: list, dueDate: str, editable: bool, errors: {}, initialSubmitDate: str, lastSaveDate: str, overdue: bool, quarter: int, sections: [ { label: str, nameResourceId: str, rows: [ { actualListType: str, actualValue: int, calculated: bool, childUnitNumber: NoneType, childUnitRows: NoneType, editable: bool, helpLabel: str, helpResourceId: str, label: str, lineReference: NoneType, nameResourceId: str, number: int, potentialListType: str, potentialValue: int, propertyName: NoneType, updatedActualValue: NoneType, valueStr: NoneType, year1Percent: str, year5Percent: str } ] } ], submitted: bool, unitNumber: int, version: str, year: int } }, 2020: { 4: { childUnits: NoneType, converts: list, dueDate: str, editable: bool, errors: {}, initialSubmitDate: str, lastSaveDate: str, overdue: bool, quarter: int, sections: [ { label: str, nameResourceId: str, rows: [ { actualListType: str, actualValue: int, calculated: bool, childUnitNumber: NoneType, childUnitRows: NoneType, editable: bool, helpLabel: str, helpResourceId: str, label: str, lineReference: NoneType, nameResourceId: str, number: int, potentialListType: str, potentialValue: int, propertyName: NoneType, updatedActualValue: NoneType, valueStr: NoneType, year1Percent: str, year5Percent: str } ] } ], submitted: bool, unitNumber: int, version: str, year: int } }, 2021: { 4: { childUnits: NoneType, converts: list, dueDate: str, editable: bool, errors: {}, initialSubmitDate: str, lastSaveDate: str, overdue: bool, quarter: int, sections: [ { label: str, nameResourceId: str, rows: [ { actualListType: str, actualValue: int, calculated: bool, childUnitNumber: NoneType, childUnitRows: NoneType, editable: bool, helpLabel: str, helpResourceId: str, label: str, lineReference: NoneType, nameResourceId: str, number: int, potentialListType: str, potentialValue: int, propertyName: NoneType, updatedActualValue: NoneType, valueStr: NoneType, year1Percent: str, year5Percent: str } ] } ], submitted: bool, unitNumber: int, version: str, year: int } }, 2022: { 4: { childUnits: NoneType, converts: list, dueDate: str, editable: bool, errors: {}, initialSubmitDate: str, lastSaveDate: str, overdue: bool, quarter: int, sections: [ { label: str, nameResourceId: str, rows: [ { actualListType: str, actualValue: int, calculated: bool, childUnitNumber: NoneType, childUnitRows: NoneType, editable: bool, helpLabel: str, helpResourceId: str, label: str, lineReference: NoneType, nameResourceId: str, number: int, potentialListType: str, potentialValue: int, propertyName: NoneType, updatedActualValue: NoneType, valueStr: NoneType, year1Percent: str, year5Percent: str } ] } ], submitted: bool, unitNumber: int, version: str, year: int } }, 2023: { 2: { childUnits: NoneType, converts: list, dueDate: str, editable: bool, errors: {}, initialSubmitDate: str, lastSaveDate: str, overdue: bool, quarter: int, sections: [ { label: str, nameResourceId: str, rows: [ { actualListType: str, actualValue: int, calculated: bool, childUnitNumber: NoneType, childUnitRows: NoneType, editable: bool, helpLabel: str, helpResourceId: str, label: str, lineReference: NoneType, nameResourceId: str, number: int, potentialListType: str, potentialValue: int, propertyName: NoneType, updatedActualValue: NoneType, valueStr: NoneType, year1Percent: str, year5Percent: str } ] } ], submitted: bool, unitNumber: int, version: str, year: int } } }
-
get_seminary_and_institute_quarterly_attendance()¶ Returns all availabe seminary/institute quarterly attendance reports
Parameters
- unit : int
- Number of the church unit for which to retrieve the report
- timeout_sec : int
- Number of seconds to wait for a response when making a request
Returns
{ 2014: { 4: { isStakeTotals: bool, quarter: int, sections: [ { comment: str, id: int, name: str, rows: [ { actual: int, id: int, name: str, percent: int, potential: int, tooltip: str, value: NoneType, valueIsActual: bool, valueIsPercent: bool, valueIsPotential: bool } ], subSections: list } ], unitAbbreviation: NoneType, unitName: str, unitNumber: int, year: int, yearQuarterDisplay: str } }, 2015: { 4: { isStakeTotals: bool, quarter: int, sections: [ { comment: str, id: int, name: str, rows: [ { actual: int, id: int, name: str, percent: int, potential: int, tooltip: str, value: NoneType, valueIsActual: bool, valueIsPercent: bool, valueIsPotential: bool } ], subSections: list } ], unitAbbreviation: NoneType, unitName: str, unitNumber: int, year: int, yearQuarterDisplay: str } }, 2016: { 4: { isStakeTotals: bool, quarter: int, sections: [ { comment: str, id: int, name: str, rows: [ { actual: int, id: int, name: str, percent: int, potential: int, tooltip: str, value: NoneType, valueIsActual: bool, valueIsPercent: bool, valueIsPotential: bool } ], subSections: list } ], unitAbbreviation: NoneType, unitName: str, unitNumber: int, year: int, yearQuarterDisplay: str } }, 2017: { 4: { isStakeTotals: bool, quarter: int, sections: [ { comment: str, id: int, name: str, rows: [ { actual: int, id: int, name: str, percent: int, potential: int, tooltip: str, value: NoneType, valueIsActual: bool, valueIsPercent: bool, valueIsPotential: bool } ], subSections: list } ], unitAbbreviation: NoneType, unitName: str, unitNumber: int, year: int, yearQuarterDisplay: str } }, 2018: { 4: { isStakeTotals: bool, quarter: int, sections: [ { comment: str, id: int, name: str, rows: [ { actual: int, id: int, name: str, percent: int, potential: int, tooltip: str, value: NoneType, valueIsActual: bool, valueIsPercent: bool, valueIsPotential: bool } ], subSections: list } ], unitAbbreviation: NoneType, unitName: str, unitNumber: int, year: int, yearQuarterDisplay: str } }, 2019: { 4: { isStakeTotals: bool, quarter: int, sections: [ { comment: str, id: int, name: str, rows: [ { actual: int, id: int, name: str, percent: int, potential: int, tooltip: str, value: NoneType, valueIsActual: bool, valueIsPercent: bool, valueIsPotential: bool } ], subSections: list } ], unitAbbreviation: NoneType, unitName: str, unitNumber: int, year: int, yearQuarterDisplay: str } }, 2020: { 4: { isStakeTotals: bool, quarter: int, sections: [ { comment: str, id: int, name: str, rows: [ { actual: int, id: int, name: str, percent: int, potential: int, tooltip: str, value: NoneType, valueIsActual: bool, valueIsPercent: bool, valueIsPotential: bool } ], subSections: list } ], unitAbbreviation: NoneType, unitName: str, unitNumber: int, year: int, yearQuarterDisplay: str } }, 2021: { 4: { isStakeTotals: bool, quarter: int, sections: [ { comment: str, id: int, name: str, rows: [ { actual: int, id: int, name: str, percent: int, potential: int, tooltip: str, value: NoneType, valueIsActual: bool, valueIsPercent: bool, valueIsPotential: bool } ], subSections: list } ], unitAbbreviation: NoneType, unitName: str, unitNumber: int, year: int, yearQuarterDisplay: str } }, 2022: { 4: { isStakeTotals: bool, quarter: int, sections: [ { comment: str, id: int, name: str, rows: [ { actual: int, id: int, name: str, percent: int, potential: int, tooltip: str, value: NoneType, valueIsActual: bool, valueIsPercent: bool, valueIsPotential: bool } ], subSections: list } ], unitAbbreviation: NoneType, unitName: str, unitNumber: int, year: int, yearQuarterDisplay: str } }, 2023: { 3: { isStakeTotals: bool, quarter: int, sections: [ { comment: str, id: int, name: str, rows: [ { actual: int, id: int, name: str, percent: int, potential: int, tooltip: str, value: NoneType, valueIsActual: bool, valueIsPercent: bool, valueIsPotential: bool } ], subSections: list } ], unitAbbreviation: NoneType, unitName: str, unitNumber: int, year: int, yearQuarterDisplay: str } } }
-
get_suborganization()¶ Returns information for a given suborganization of a unit
Parameters org_id : int
Number of the suborganization of the unit for which to retrieve the report. Defaults to the class assignment for gendered class (Elders’ Quorum, Relief Society, etc.).- unit : int
- Number of the church unit for which to retrieve the report
- timeout_sec : int
- Number of seconds to wait for a response when making a request
Returns
{ addableSubOrgTypes: NoneType, adultClass: bool, callings: list, canHaveMembers: bool, canShowWithNoCallings: bool, children: [ { addableSubOrgTypes: NoneType, adultClass: bool, callings: [ { activeDate: str, allowApprove: bool, allowMultiple: bool, allowNew: bool, allowVacant: bool, approvalRequest: bool, autoReleasedPositionTypeIds: NoneType, canHaveResponsibilities: bool, contactEmail: str, contactInfoEditable: bool, contactMailingAddr: NoneType, contactMobilePhone: NoneType, contactWorkPhone: NoneType, custom: bool, customNameChanged: bool, dualAuthPass: NoneType, dualAuthUser: NoneType, editable: bool, errors: {}, expectedEndDate: NoneType, hasContactInfo: bool, hidden: bool, memberEmail: str, memberId: int, memberName: str, memberNameOrder: int, memberPhone: str, memberUnitName: str, memberUnitNumber: int, missionName: NoneType, missionUnitNumber: NoneType, missionary: bool, missionaryHomeUnitName: NoneType, mrn: NoneType, nameVerificationForMrn: NoneType, newSubOrgId: NoneType, ordainDate: NoneType, ordainedByPersonId: NoneType, ordainedByPersonMrn: NoneType, ordainedByPersonName: NoneType, organization: str, otherAllowedSubOrgs: [ { children: list, classGroup: NoneType, defaultOrgTypeIds: [ int ], firstTypeId: int, gender: NoneType, isClass: bool, isCombined: bool, isRealClass: bool, isSplit: bool, name: str, orgTypeIds: [ int ], parentName: str, subOrgId: int, unitNumber: int, userCanEditCallings: bool } ], parentOrganization: NoneType, pendingCalling: bool, pendingDelete: bool, pendingDualAuth: bool, position: str, positionDisplayOrder: int, positionId: int, positionTypeEnum: str, positionTypeId: int, previouslyOrdained: bool, releaseDate: NoneType, releasePositionIds: NoneType, requiresBishopOrdination: bool, requiresDualAuthorization: bool, requiresSetApartDateAndPerson: bool, responsibilities: NoneType, sequence: int, setApart: bool, setApartByPersonId: NoneType, setApartByPersonMrn: NoneType, setApartByPersonName: NoneType, setApartDate: str, showUnitCard: bool, subOrgId: int, subOrgTypeId: int, unitName: NoneType, unitNumber: int, unpublished: bool, userCanEdit: bool, userCanEditContactInfoOnly: bool, userCannotEditPreviousOrdination: bool, vacant: bool } ], canHaveMembers: bool, canShowWithNoCallings: bool, children: list, classGroup: NoneType, classes: NoneType, classesCollapsed: bool, customOrgName: NoneType, customPositionsAllowed: bool, defaultOrgName: str, displayOrder: int, enableHT: bool, enableVT: bool, filterOffices: list, firstOrgType: str, firstOrgTypeId: int, firstOrgTypeName: NoneType, gender: NoneType, hasAnyAllowMultiple: bool, hasCustomCallings: bool, highCouncilOrDistrictCouncil: bool, instance: int, isSplit: bool, leadershipSubOrgId: NoneType, members: list, mergeableSubOrgTypeIds: list, missionaries: bool, multipleAllowed: bool, name: str, nameEditable: bool, orgTypeIds: [ int ], other: bool, parentName: str, parentSubOrgId: int, positionTypeIdsThatCanHaveResponsibilities: list, priesthood: bool, relatedSubOrgName: NoneType, required: bool, resetable: bool, room: NoneType, size: NoneType, splitOrCombinedClassNotice: NoneType, subOrgId: int, supportsAttendanceRoll: bool, totalInstances: int, unitNumber: int, unitType: int, userCanEditCallings: bool, userCanEditClassAssignments: bool, userCanSeeBasicInfo: bool } ], classGroup: str, classes: NoneType, classesCollapsed: bool, customOrgName: NoneType, customPositionsAllowed: bool, defaultOrgName: str, displayOrder: int, enableHT: bool, enableVT: bool, filterOffices: [ { codes: [ int ], name: str } ], firstOrgType: str, firstOrgTypeId: int, firstOrgTypeName: NoneType, gender: str, hasAnyAllowMultiple: bool, hasCustomCallings: bool, highCouncilOrDistrictCouncil: bool, instance: int, isSplit: bool, leadershipSubOrgId: NoneType, members: [ { accountable: bool, actualAge: int, actualAgeInMonths: int, address: str, adultAgeOrMarried: bool, age: int, birthDate: str, birthDateFormatted: str, birthDateSort: str, birthDayFormatted: str, birthDaySort: str, defaultClass: bool, defaultClassTypeId: int, eligibleForHomeTeachingAssignment: bool, email: str, endowed: bool, formattedMrn: NoneType, gender: str, genderCode: int, genderLabelShort: str, householdEmail: NoneType, householdPhone: str, htvtAssignments: NoneType, htvtCompanions: NoneType, id: int, mrn: NoneType, name: str, nameOrder: int, nonMember: bool, notAccountable: bool, outOfUnitMember: bool, phone: str, priesthood: NoneType, priesthoodCode: int, priesthoodType: NoneType, sealedToSpouse: bool, setApart: bool, spokenName: str, sustainedDate: NoneType, unitName: str, unitNumber: int, visible: NoneType } ], mergeableSubOrgTypeIds: list, missionaries: bool, multipleAllowed: bool, name: str, nameEditable: bool, orgTypeIds: [ int ], other: bool, parentName: str, parentSubOrgId: NoneType, positionTypeIdsThatCanHaveResponsibilities: list, priesthood: bool, relatedSubOrgName: NoneType, required: bool, resetable: bool, room: NoneType, size: NoneType, splitOrCombinedClassNotice: NoneType, subOrgId: int, supportsAttendanceRoll: bool, totalInstances: int, unitNumber: int, unitType: int, userCanEditCallings: bool, userCanEditClassAssignments: bool, userCanSeeBasicInfo: bool }
-
get_unit_organizations()¶ Returns the unit calling/leadership organization structure
Parameters
- unit : int
- Number of the church unit for which to retrieve the report
- timeout_sec : int
- Number of seconds to wait for a response when making a request
Returns
[ { addableSubOrgTypes: NoneType, adultClass: bool, callings: [ { activeDate: str, allowApprove: bool, allowMultiple: bool, allowNew: bool, allowVacant: bool, approvalRequest: bool, autoReleasedPositionTypeIds: NoneType, canHaveResponsibilities: bool, contactEmail: str, contactInfoEditable: bool, contactMailingAddr: { city: str, country: int, district: NoneType, formattedLines: list, geocodeToUnits: bool, postalCode: str, standardized: NoneType, state: int, street1: str, street2: NoneType, units: NoneType }, contactMobilePhone: str, contactWorkPhone: NoneType, custom: bool, customNameChanged: bool, dualAuthPass: NoneType, dualAuthUser: NoneType, editable: bool, errors: {}, expectedEndDate: NoneType, hasContactInfo: bool, hidden: bool, memberEmail: str, memberId: int, memberName: str, memberNameOrder: int, memberPhone: str, memberUnitName: str, memberUnitNumber: int, missionName: NoneType, missionUnitNumber: NoneType, missionary: bool, missionaryHomeUnitName: NoneType, mrn: NoneType, nameVerificationForMrn: NoneType, newSubOrgId: NoneType, ordainDate: str, ordainedByPersonId: int, ordainedByPersonMrn: str, ordainedByPersonName: str, organization: str, otherAllowedSubOrgs: [ { children: list, classGroup: NoneType, defaultOrgTypeIds: [ int ], firstTypeId: int, gender: NoneType, isClass: bool, isCombined: bool, isRealClass: bool, isSplit: bool, name: str, orgTypeIds: [ int ], parentName: NoneType, subOrgId: int, unitNumber: int, userCanEditCallings: bool } ], parentOrganization: NoneType, pendingCalling: bool, pendingDelete: bool, pendingDualAuth: bool, position: str, positionDisplayOrder: int, positionId: int, positionTypeEnum: str, positionTypeId: int, previouslyOrdained: bool, releaseDate: NoneType, releasePositionIds: NoneType, requiresBishopOrdination: bool, requiresDualAuthorization: bool, requiresSetApartDateAndPerson: bool, responsibilities: NoneType, sequence: int, setApart: bool, setApartByPersonId: int, setApartByPersonMrn: str, setApartByPersonName: str, setApartDate: str, showUnitCard: bool, subOrgId: int, subOrgTypeId: int, unitName: NoneType, unitNumber: int, unpublished: bool, userCanEdit: bool, userCanEditContactInfoOnly: bool, userCannotEditPreviousOrdination: bool, vacant: bool } ], canHaveMembers: bool, canShowWithNoCallings: bool, children: list, classGroup: NoneType, classes: NoneType, classesCollapsed: bool, customOrgName: NoneType, customPositionsAllowed: bool, defaultOrgName: str, displayOrder: int, enableHT: bool, enableVT: bool, filterOffices: list, firstOrgType: str, firstOrgTypeId: int, firstOrgTypeName: NoneType, gender: NoneType, hasAnyAllowMultiple: bool, hasCustomCallings: bool, highCouncilOrDistrictCouncil: bool, instance: int, isSplit: bool, leadershipSubOrgId: NoneType, members: list, mergeableSubOrgTypeIds: list, missionaries: bool, multipleAllowed: bool, name: str, nameEditable: bool, orgTypeIds: [ int ], other: bool, parentName: str, parentSubOrgId: NoneType, positionTypeIdsThatCanHaveResponsibilities: list, priesthood: bool, relatedSubOrgName: NoneType, required: bool, resetable: bool, room: NoneType, size: NoneType, splitOrCombinedClassNotice: NoneType, subOrgId: int, supportsAttendanceRoll: bool, totalInstances: int, unitNumber: int, unitType: int, userCanEditCallings: bool, userCanEditClassAssignments: bool, userCanSeeBasicInfo: bool } ]
-
get_unit_statistics()¶ Returns the unit statistics
Parameters
- unit : int
- Number of the church unit for which to retrieve the report
- timeout_sec : int
- Number of seconds to wait for a response when making a request
Returns
{ adultFemaleRecentConverts: int, adultFemaleRecentConvertsIndividualIds: list, adultMaleRecentConverts: int, adultMaleRecentConvertsIndividualIds: list, adults: int, adultsIndividualIds: [ int ], baptizedNotConfirmed: int, baptizedNotConfirmedIndividualIds: list, beehive: int, beehiveIndividualIds: [ int ], children: int, childrenAge8to11RecentConverts: int, childrenAge8to11RecentConvertsIndividualIds: list, childrenIndividualIds: [ int ], deacons: int, deaconsIndividualIds: [ int ], elders: int, eldersIndividualIds: [ int ], endowedAdults: int, endowedAdultsIndividualIds: list, endowedWithRecommend: int, endowedWithRecommendIndividualIds: list, endowedWithoutRecommend: int, endowedWithoutRecommendIndividualIds: list, highPriests: int, highPriestsIndividualIds: [ int ], households: int, householdsIndividualIds: [ int ], householdsWithChildren: int, householdsWithChildrenIndividualIds: [ int ], householdsWithSingleParentAndYouthOrChildren: int, householdsWithSingleParentAndYouthOrChildrenIndividualIds: [ int ], householdsWithYouth: int, householdsWithYouthIndividualIds: [ int ], householdsWithoutMelchizedekPriesthoodHolder: int, householdsWithoutMelchizedekPriesthoodHolderIndividualIds: [ int ], individualsNotIncluded: int, individualsNotIncludedIndividualIds: [ int ], infants: int, infantsIndividualIds: [ int ], invalidBirthdate: int, invalidBirthdateIndividualIds: list, laurels: int, laurelsIndividualIds: [ int ], marriedAdults: int, marriedAdultsIndividualIds: [ int ], membersOfRecordAge9OrOlder: int, membersOfRecordAge9OrOlderIndividualIds: [ int ], men: int, menIndividualIds: [ int ], miaMaids: int, miaMaidsIndividualIds: [ int ], ordainedRecentConverts: int, ordainedRecentConvertsIndividualIds: list, priests: int, priestsIndividualIds: [ int ], prospectiveElders: int, prospectiveEldersIndividualIds: [ int ], recentConverts: int, recentConvertsEligibleForOrdination: int, recentConvertsEligibleForOrdinationIndividualIds: list, recentConvertsIndividualIds: list, shortUnitName: NoneType, singleAdults: int, singleAdultsIndividualIds: [ int ], teachers: int, teachersIndividualIds: [ int ], totalMembers: int, totalMembersIndividualIds: [ int ], unitName: NoneType, unitNumber: int, unitType: NoneType, unordainedRecentConverts: int, unordainedRecentConvertsIndividualIds: list, women: int, womenIndividualIds: [ int ], youngMen: int, youngMenIndividualIds: [ int ], youngMenRecentConverts: int, youngMenRecentConvertsIndividualIds: list, youngSingleAdults: int, youngSingleAdultsIndividualIds: [ int ], youngWomen: int, youngWomen12_13: int, youngWomen12_13IndividualIds: [ int ], youngWomen14_15: int, youngWomen14_15IndividualIds: [ int ], youngWomen16_17: int, youngWomen16_17IndividualIds: [ int ], youngWomenIndividualIds: [ int ], youngWomenRecentConverts: int, youngWomenRecentConvertsIndividualIds: list }
-
get_units()¶ Returns a list of child units for the given parent unit
Parameters
- parent_unit : int
- Number of the church unit for which to retrieve a list of child units
- timeout_sec : int
- Number of seconds to wait for a response when making a request
Returns
{ childUnits: [ { name: str, unitNumber: int, unitType: str } ], name: str, unitNumber: int, unitType: str }
-
org_id¶
-
session¶ Returns the requests session being used by the API.
-
user_details¶ Returns the details of the user logged into this session
Returns
{ authorized: bool, country: str, developer: bool, homeUnits: [ int ], individualId: int, ldsAccountId: int, leaderParentUnits: [ int ], member: bool, mrn: str, parentUnits: [ int ], preferredLanguage: str, preferredName: str, proxyEdit: bool, proxyUnit: bool, proxyUser: bool, templeNearest: [ int ], templeUnits: [ int ], username: str, uuid: str }
-