LDSTechForumProjects

Community Services Missionary Service

Overview

The Missionary service is a brand new service that provides missionary information for various community-driven Church applications including Area Book.

This Service is currently implemented using SOAP, not REST. Additionally, an application key is required to access the service. It is important to note that the actual methods and data available may vary according to the Data Agreement for the application you are developing. Some methods and/or data may not be available The community appkey for the full service is missionary / missionary

Also note that the WSDL for the service indicates that input params are optional (minOccurs="0"); however this is not the case. This is due to a bug in the underlying architecture. All input params are required.

For community development, a number of individual IDs have not been set and so are defaulted to 0. If a request for an individual with an ID of 0 is made, there will be a lot of results, which should not happen with production data.

This service enables an increase in community participation of software development at the Church. This service is in response to a requirement from the Emerging Technologies Group in ICS to accomplish the above goal.

SOAP Method Documentation

ping

java.lang.String ping()

getInFieldMissionaryAssignmentsByMission

Method

java.util.List<MissionaryAssignmentInfo> getInFieldMissionaryAssignmentsByMission(java.lang.String missionUnitNumber)

Description

Retrieves assignment and missionary information for all missionaries in a given mission (flattened into a single object).
This method will only return those missionaries that are currently serving in the specified mission. Each missionary will be associated with a single assignment.

Example SOAP Call

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:v1="http://schema.lds.org/missionary-services/v1_0">
 <soap:Header/>
 <soap:Body>
  <v1:getInFieldMissionaryAssignments>
   <missionUnitNumber>87654</missionUnitNumber>
  </v1:getInFieldMissionaryAssignments>
 </soap:Body>
</soap:Envelope>

Parameters

missionUnitNumber - The MLU Unit number for the mission

Returns

A list of combined missionary-assignment objects.

Example SOAP response

<ns2:getInFieldMissionaryAssignmentsResponse xmlns:ns2="http://schema.lds.org/missionary-services/v1_0">
<MissionaryAssignment>
 <applicationId>12345</applicationId>
 <assignmentEnd>1832-02-15T00:00:00-07:00</assignmentEnd>
 <assignmentStart>1830-03-03T00:00:00-07:00</assignmentStart>
 <assignmentStatus>
  <code>IN_FIELD</code>
  <name>In Field</name>
 </assignmentStatus>
 <birthDate>1800-12-02T00:00:00-07:00</birthDate>
 <currentProsArea>
  <address>
   <city>Kirtland</city>
   <countryCode>251</countryCode>
   <postalCode>12345</postalCode>
   <stateProvince>OH</stateProvince>
   <streetAddress>123 Mission St.</streetAddress>
  </address>
  <areaType>AREA</areaType>
  <districtName>Kirtland</districtName>
  <proselytingAreaId>654321</proselytingAreaId>
  <individualIds>
   <individualId>234567</individualId>
   <individualId>123456</individualId>
  </individualIds>
  <name>Kirtland East</name>
  <phoneNumbers>
   <acceptsMMS>false</acceptsMMS>
   <acceptsSMS>false</acceptsSMS>
   <callerCharged>false</callerCharged>
   <number>c123-456-7890</number>
  </phoneNumbers>
  <zoneName>Ohio</zoneName>
 </currentProsArea>
 <customFields/>
 <emailAddress>
  <acceptsHtml>true</acceptsHtml>
  <emailAddress>pioneer@myldsmail.net</emailAddress>
 </emailAddress>
 <individualId>123456</individualId>
 <languages>
  <language>
   <iso3Code>eng</iso3Code>
   <nativeSpeaker>true</nativeSpeaker>
  </language>
  <language>
   <iso3Code>jpn</iso3Code>
   <nativeSpeaker>false</nativeSpeaker>
  </language>
 </languages>
 <mission>
  <parentUnitId>12345</parentUnitId>
  <unitId>234567</unitId>
  <unitName>Western US Mission</unitName>
  <unitType>Mission</unitType>
  <unitTypeId>3</unitTypeId>
 </mission>
 <missionRelease>1834-02-15T00:00:00-07:00</missionRelease>
 <missionStart>1830-02-10T00:00:00-07:00</missionStart>
 <missionaryStatus>
  <id>13</id>
  <name>Arrived in Mission Field</name>
 </missionaryStatus>
 <name>
  <firstName>Orson</firstName>
  <lastName>Card</lastName>
  <middleName>Scott</middleName>
  <prefFirstName>Scott</prefFirstName>
  <prefLastName>Card</prefLastName>
  <prefMiddleName>Scott</prefMiddleName>
 </name>
 <role>
  <code>JUNIOR_COMPANION</code>
  <roleId>9</roleId>
  </role>
 <type>
  <gender>Male</gender>
  <partTime>false</partTime>
  <typeCode>ELDER</typeCode>
 </type>
</MissionaryAssignment>
...

getMissionaryDetailsByMission

Method

java.util.List<MissionaryDetailInfo> getMissionaryDetailsByMission(java.lang.String missionUnitNumber)

Description

Retrieves a list of detailed missionary information for each missionary assigned to the specified mission, regardless of whether they are currently serving in that mission.

Example SOAP call

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:v1="http://schema.lds.org/missionary-services/v1_0">
 <soap:Header/>
 <soap:Body>
  <v1:getMissionaryDetailsByMission>
   <missionUnitNumber>1234</missionUnitNumber>
  </v1:getMissionaryDetailsByMission>
 </soap:Body>
</soap:Envelope>

Parameters

missionUnitNumber - The unit Number for the mission

Returns

A list of MissionaryDetailInfo objects

Example SOAP Response

<ns2:getMissionaryDetailsByMissionResponse xmlns:ns2="http://schema.lds.org/missionary-services/v1_0">
<MissionaryDetails>
 <applicationId>3456</applicationId>
 <birthDate>1908-09-17T00:00:00-06:00</birthDate>
 <individualId>123456</individualId>
 <languages>
  <language>
   <iso3Code>eng</iso3Code>
   <nativeSpeaker>false</nativeSpeaker>
  </language>
  <language>
   <iso3Code>ibo</iso3Code>
   <nativeSpeaker>true</nativeSpeaker>
  </language>
 </languages>
 <name>
  <firstName>Paul</firstName>
  <lastName>Apostle</lastName>
  <middleName>The</middleName>
  <prefFirstName>Paul</prefFirstName>
  <prefLastName>Apostle</prefLastName>
  <prefMiddleName>The</prefMiddleName>
 </name>
 <release>1930-03-02T00:00:00-07:00</release>
 <startDate>1928-02-26T00:00:00-07:00</startDate>
 <status>
  <missionaryStatusId>12</missionaryStatusId>
  <name>Started Mission(At MTC)</name>
 </status>
 <type>
  <gender>Male</gender>
  <partTime>false</partTime>
  <typeCode>ELDER</typeCode>
 </type>
</MissionaryDetails>
...
</ns2:getMissionaryDetailsByMissionResponse>

getAssignmentsByMission

Method

java.util.List<AssignmentInfo> getAssignmentsByMission(java.lang.String missionUnitNumber)

Description

Return the assignments for a particular mission.

Example SOAP call

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:v1="http://schema.lds.org/missionary-services/v1_0">
 <soap:Header/>
 <soap:Body>
  <v1:getAssignmentsByMission>
   <missionUnitNumber>123456</missionUnitNumber>
  </v1:getAssignmentsByMission>
 </soap:Body>
</soap:Envelope>

Parameters

missionUnitNumber - The MLU Unit Number for the mission

Returns

A list of AssignmentInfo objects.

Example SOAP Response

<ns2:getAssignmentsByMissionResponse xmlns:ns2="http://schema.lds.org/missionary-services/v1_0">
 <Assignment>
  <assignmentStart>1820-03-11T00:00:00-07:00</assignmentStart>
  <currentProsAreaId>1234567</currentProsAreaId>
  <customFields>
   <customField>
    <description>"MyLDSMail"</description>
    <customFieldId>76543</customFieldId>
    <value>jsmithjr@myldsmail.net</value>
   </customField>
  </customFields>
  <individualId>123456</individualId>
  <mission>
   <missionUnitId xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
   <parentUnitId>23456</parentUnitId>
   <unitId>12345</unitId>
   <unitName>Palmyra New York Mission</unitName>
   <unitType>Mission</unitType>
   <unitTypeId>3</unitTypeId>
  </mission>
  <role>
   <code>JUNIOR_COMPANION</code>
   <roleId>9</roleId>
  </role>
  <status>
   <code>IN_FIELD</code>
   <name>In Field</name>
  </status>
 </Assignment>
 ...
</ns2:getAssignmentsByMissionResponse>

getProselytingAreasByMission

Method

java.util.List<ProselytingAreaInfo> getProselytingAreasByMission(java.lang.String missionUnitNumber)

Description

Returns a list of proselytizing areas within a given mission.
Zones are children of Missions, Districts are children of Zones and ProselytingAreas are children of Districts
There is a Many to Many relationship between proselytingAreas and church units This relationship is set and maintained by Missions The relationship can be configured either for wards/branches to proselyting areas or from Stakes/Ecclesiastical Districts to proselyting areas. A mission determines which relationship is appropriate.

Parameters

missionUnitNumber - The unit number for the mission

Returns

A list of proselytizing areas.

Throws

SoapFault - if the unit number is missing

Example SOAP Response

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
 <soap:Body>
  <ns2:getProselytingAreasByMissionResponse xmlns:ns2="http://schema.lds.org/missionary-services/v1_0">
   <return>
    <address>
     <city>Scranton</city>
     <countryCode>72</countryCode>
     <stateProvince>OH</stateProvince>
     <streetAddress>North Temple Apt. 3</streetAddress>
    </address>
    <districtName>Scranton District 3</districtName>
    <individualIds>
     <individualId>35585498762</individualId>
     <individualId>29133185952</individualId>
    </individualIds>
    <name>Scranton 3 South Proselyting Area</name>
    <phoneNumbers>
     <phoneNumber>
      <acceptsMMS>false</acceptsMMS>
      <acceptsSMS>false</acceptsSMS>
      <areaCode>801</areaCode>
      <callerCharged>false</callerCharged>
      <countryCode>34<countryCode>
      <internationalNumber>02320-15-865-5309</internationalNumber>
      <localNumber>02320-15-865-5309</localNumber>
      <longDistanceNumber>02320-15-865-5309</longDistanceNumber>
      <number>02320-15-865-5309</number>
     </phoneNumber>
    </phoneNumbers>
    <proselytingAreaId>5913023</proselytingAreaId>
    <unitsServed>
     <unitServed>
      <missionUnitId>123123<missionUnitId>
      <parentUnitId>234234</parentUnitId>
      <unitId>345345</unitId>
      <unitName>Scranton 1 Branch</unitName>
      <unitType>Branch</unitType>
      <unitTypeId>8</unitTypeId>
     </unitServed>
    </unitsServed>
    <zoneName>Ohio North Zone</zoneName>
   </return>
  </ns2:getProselytingAreasByMissionResponse>
 </soap:Body>
</soap:Envelope>

getMissionaryDetails

Method

MissionaryDetailInfo getMissionaryDetails(java.lang.String individualId)

Description

Retrieve detailed information about a missionary

Example SOAP Call

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:v1="http://schema.lds.org/missionary-services/v1_0">
 <soap:Header/>
 <soap:Body>
  <v1:getMissionaryDetails>
   <individualId>123456</individualId>
  </v1:getMissionaryDetails>
 </soap:Body>
</soap:Envelope>

Parameters

individualId - The MLU ID of the missionary

Returns

A MissionaryDetailInfo object.

Example SOAP Response

<MissionaryDetails>
 <applicationId>3456</applicationId>
 <birthDate>1908-09-17T00:00:00-06:00</birthDate>
 <individualId>123456</individualId>
 <languages>
  <language>
   <iso3Code>eng</iso3Code>
   <nativeSpeaker>false</nativeSpeaker>
  </language>
  <language>
   <iso3Code>ibo</iso3Code>
   <nativeSpeaker>true</nativeSpeaker>
  </language>
 </languages>
 <name>
  <firstName>Paul</firstName>
  <lastName>Apostle</lastName>
  <middleName>The</middleName>
  <prefFirstName>Paul</prefFirstName>
  <prefLastName>Apostle</prefLastName>
  <prefMiddleName>The</prefMiddleName>
 </name>
 <release>1930-03-02T00:00:00-07:00</release>
 <startDate>1928-02-26T00:00:00-07:00</startDate>
 <status>
  <missionaryStatusId>12</missionaryStatusId>
  <name>Started Mission(At MTC)</name>
 </status>
 <type>
  <gender>Male</gender>
  <partTime>false</partTime>
  <typeCode>ELDER</typeCode>
 </type>
</MissionaryDetails>

getMisssionaryDetailsAndAssignment

Method

java.util.List<MissionaryAssignmentInfo> getMisssionaryDetailsAndAssignment(java.lang.String individualId)

Description

Get missionary details and assignment information in a single (flattened) object for one missionary. Only the active assignment will be returned.
Note: It is rare but possible for a missionary to have more than one active assignment

Example SOAP call

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:v1="http://schema.lds.org/missionary-services/v1_0">
 <soap:Header/>
 <soap:Body>
  <v1:getMisssionaryDetailsAndAssignment>
   <individualId>123456</individualId>
  </v1:getMisssionaryDetailsAndAssignment>
 </soap:Body>
</soap:Envelope>

Parameters

individualId - The missionaries MLU individual ID

Returns

A list of combined missionary-assignment objects.

Example SOAP response

<ns2:getMisssionaryDetailsAndAssignmentResponse xmlns:ns2="http://schema.lds.org/missionary-services/v1_0">
 <MissionaryAssignment>
  <applicationId>12345</applicationId>
  <assignmentEnd>1832-02-15T00:00:00-07:00</assignmentEnd>
  <assignmentStart>1830-03-03T00:00:00-07:00</assignmentStart>
  <assignmentStatus>
   <code>IN_FIELD</code>
   <name>In Field</name>
  </assignmentStatus>
  <birthDate>1800-12-02T00:00:00-07:00</birthDate>
  <currentProsArea>
   <address>
    <city>Kirtland</city>
    <countryCode>251</countryCode>
    <postalCode>12345</postalCode>
    <stateProvince>OH</stateProvince>
    <streetAddress>123 Mission St.</streetAddress>
   </address>
   <areaType>AREA</areaType>
   <districtName>Kirtland</districtName>
   <proselytingAreaId>654321</proselytingAreaId>
   <individualIds>
    <individualId>234567</individualId>
    <individualId>123456</individualId>
    </individualIds>
    <name>Kirtland East</name>
    <phoneNumbers>
     <acceptsMMS>false</acceptsMMS>
     <acceptsSMS>false</acceptsSMS>
     <callerCharged>false</callerCharged>
     <number>c123-456-7890</number>
    </phoneNumbers>
   <zoneName>Ohio</zoneName>
  </currentProsArea>
  <customFields/>
  <emailAddress>
   <acceptsHtml>true</acceptsHtml>
   <emailAddress>pioneer@myldsmail.net</emailAddress>
  </emailAddress>
  <individualId>123456</individualId>
   <languages>
    <language>
     <iso3Code>eng</iso3Code>
     <nativeSpeaker>true</nativeSpeaker>
    </language>
    <language>
     <iso3Code>jpn</iso3Code>
     <nativeSpeaker>false</nativeSpeaker>
    </language>
   </languages>
   <mission>
    <parentUnitId>12345</parentUnitId>
    <unitId>234567</unitId>
    <unitName>Western US Mission</unitName>
    <unitType>Mission</unitType>
    <unitTypeId>3</unitTypeId>
   </mission>
   <missionRelease>1834-02-15T00:00:00-07:00</missionRelease>
   <missionStart>1830-02-10T00:00:00-07:00</missionStart>
  <missionaryStatus>
   <id>13</id>
   <name>Arrived in Mission Field</name>
  </missionaryStatus>
  <name>
  <firstName>Orson</firstName>
   <lastName>Card</lastName>
   <middleName>Scott</middleName>
   <prefFirstName>Oreo</prefFirstName>
   <prefLastName>Card</prefLastName>
   <prefMiddleName>Scott</prefMiddleName>
  </name>
  <role>
   <code>JUNIOR_COMPANION</code>
   <roleId>9</roleId>
  </role>
  <type>
   <gender>Male</gender>
   <partTime>false</partTime>
   <typeCode>ELDER</typeCode>
  </type>
 </MissionaryAssignment>
</ns2:getMisssionaryDetailsAndAssignmentResponse>



getMissionaryImage

Method

MissionaryImageInfo getMissionaryImage(java.lang.String individualId)

Description

Returns a photo image (including thumbnail) of the specified missionary

Example SOAP Request

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:v1="http://schema.lds.org/missionary-services/v1_0">
 <soap:Header/>
 <soap:Body>
  <v1:getMissionaryImage>
   <individualId>12345</individualId>
  </v1:getMissionaryImage>
 </soap:Body>
</soap:Envelope>

Rest Path

/missionary/{individualId}/image/

Parameters

individualId - The MLU ID of the missionary

Returns

An object containing the missionary's picture (and thumbnail)

Example SOAP Response

<ns2:getMissionaryImageResponse xmlns:ns2="http://schema.lds.org/missionary-services/v1_0">
 <MissionaryImage>
  <image>[base-64 encoded string]</image>
  <individualId>123456</individualId>
  <thumbnail>[base-64 encoded string]</thumbnail>
 </MissionaryImage>
</ns2:getMissionaryImageResponse>

getMissionaryAssignmentHistory

Method

java.util.List<AssignmentHistoryInfo> getMissionaryAssignmentHistory(java.lang.String individualId)

Description:

Retrieves the assignment history for a given missionary.
Note that an Assignment corresponds to a mission; The assignment history retrieves the areas that a missionary has served in within his assignment (mission).

Example SOAP call

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:v1="http://schema.lds.org/missionary-services/v1_0">
 <soap:Header/>
 <soap:Body>
  <v1:getMissionaryAssignmentHistory>
   <individualId>123456</individualId>
  </v1:getMissionaryAssignmentHistory>
 </soap:Body>
</soap:Envelope>

Parameters

individualId - The MLU ID of the missionary

Returns

A list of objects, each specifying a proselytizing area that a missionary served in.

Example SOAP Response

<ns2:getMissionaryAssignmentHistoryResponse xmlns:ns2="http://schema.lds.org/missionary-services/v1_0">
 <AssignmentHistory>
  <areaName>Nephi</areaName>
  <companions>Omner</companions>
  <assignmentHistoryId>2345678</assignmentHistoryId>
  <individualId>123456</individualId>
  <missionId>45678</missionId>
  <position>Senior Companion</position>
  <startDate>1908-07-08T00:00:00-06:00</startDate>
 </AssignmentHistory>
 <AssignmentHistory>
  <areaName>Middoni</areaName>
  <companions>Ammon</companions>
  <assignmentHistoryId>2345679</assignmentHistoryId>
  <individualId>123456</individualId>
  <missionId>45678</missionId>
  <position>Junior Companion</position>
  <startDate>1908-05-27T00:00:00-06:00</startDate>
 </AssignmentHistory>
 <AssignmentHistory>
  <areaName>Middoni</areaName>
  <companions>Himni (SC)</companions>
  <assignmentHistoryId>2345680</assignmentHistoryId>
  <individualId>123456</individualId>
  <missionId>45678</missionId>
  <position>Junior Companion</position>
  <startDate>1908-08-20T00:00:00-06:00</startDate>
 </AssignmentHistory>
</ns2:getMissionaryAssignmentHistoryResponse>



getMissionaryHomeContacts

Method

java.util.List<HomeContactInfo> getMissionaryHomeContacts(java.lang.String individualId)

Description

Retrieves the home contacts for a missionary.

Example SOAP Call

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:v1="http://schema.lds.org/missionary-services/v1_0">
 <soap:Header/>
 <soap:Body>
  <v1:getMissionaryHomeContacts>
   <individualId>123456</individualId>
  </v1:getMissionaryHomeContacts>
 </soap:Body>
</soap:Envelope>

Parameters

individualId - The MLU ID of the missionary

Returns

A list of contact objects.

Example SOAP Response

<ns2:getMissionaryHomeContactsResponse xmlns:ns2="http://schema.lds.org/missionary-services/v1_0">
 <HomeContact>
  <address>
   <city>Zarahemla</city>
   <countryCode>098</countryCode>
   <postalCode>12345</postalCode>
   <stateProvince>ZH</stateProvince>
   <streetAddress>45 Prophet St.</streetAddress>
  </address>
  <contactId>1234</contactId>
  <doNotContact>false</doNotContact>
  <email>alma_elder@nephites.org</email>
  <missionaryIndividualId>1234567</missionaryIndividualId>
  <isDeceased>false</isDeceased>
  <isMember>true</isMember>
  <name>Alma the Elder</name>
  <parentsSameInfo>true</parentsSameInfo>
  <phone>(123) 456-7890</phone>
  <type>FATHER</type>
 </HomeContact>
 ...
</ns2:getMissionaryHomeContactsResponse>



getMissionaryAssignments

Method

java.util.List<AssignmentInfo> getMissionaryAssignments(java.lang.String individualId)

Description

Returns one or more assignments pertaining to a missionary. Most missionaries will only have one assignment, but there are cases where a missionary may have multiple. For example, a missionary waiting for a visa will have one assignment in the mission he is intended to go to, and another assignment in the mission he is currently serving in. Missionaries from Temple Square serve for a while in other missions--during this time they have multiple assignments. The assignment that is labeled "In Field" is the one the missionary is currently serving in.

Example SOAP Call

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:v1="http://schema.lds.org/missionary-services/v1_0">
 <soap:Header/>
 <soap:Body>
  <v1:getMissionaryAssignments>
   <individualId>123456</individualId>
  </v1:getMissionaryAssignments>
 </soap:Body>
</soap:Envelope>

Parameters

individualId - The MLU ID of the missionary

Returns

One or more AssignmentInfo objects.

Example SOAP Response

<ns2:getMissionaryAssignmentsResponse xmlns:ns2="http://schema.lds.org/missionary-services/v1_0">
 <Assignment>
  <assignmentStart>1820-03-11T00:00:00-07:00</assignmentStart>
  <currentProsAreaId>1234567</currentProsAreaId>
  <customFields>
   <customField>
    <description>"MyLDSMail"</description>
    <customFieldId>76543</customFieldId>
    <value>jsmithjr@myldsmail.net</value>
   </customField>
  </customFields>
  <individualId>123456</individualId>
  <mission>
   <missionUnitId xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
   <parentUnitId>23456</parentUnitId>
   <unitId>12345</unitId>
   <unitName>Palmyra New York Mission</unitName>
   <unitType>Mission</unitType>
   <unitTypeId>3</unitTypeId>
  </mission>
  <role>
   <code>JUNIOR_COMPANION</code>
   <roleId>9</roleId>
  </role>
  <status>
   <code>IN_FIELD</code>
   <name>In Field</name>
  </status>
 </Assignment>
 ...
</ns2:getMissionaryAssignmentsResponse>

getInFieldMissionaryAssignment

Method

java.util.List<AssignmentInfo> getInFieldMissionaryAssignment(java.lang.String individualId)

Description

Returns the assignment the missionary is currently serving in (excluding the MTC).
Note: It is rare but possible for a missionary to have more than one active assignment
Most missionaries will only have one assignment, but there are cases where a missionary may have multiple. For example, a missionary waiting for a visa will have one assignment in the mission he is intended to go to, and another assignment in the mission he is currently serving in. Missionaries from Temple Square serve for a while in other missions--during this time they have multiple assignments. The assignment that is labeled "In Field" is the one the missionary is currently serving in.

Example SOAP Call

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:v1="http://schema.lds.org/missionary-services/v1_0">
 <soap:Header/>
 <soap:Body>
  <v1:getInFieldMissionaryAssignment>
   <individualId>123456</individualId>
  </v1:getInFieldMissionaryAssignment>
 </soap:Body>
</soap:Envelope>

Parameters

individualId - The MLU ID of the missionary

Returns

One or more AssignmentInfo objects.

Example SOAP Response

<ns2:getInFieldMissionaryAssignmentResponse xmlns:ns2="http://schema.lds.org/missionary-services/v1_0">
 <Assignment>
  <assignmentStart>1820-03-11T00:00:00-07:00</assignmentStart>
  <currentProsAreaId>1234567</currentProsAreaId>
  <customFields>
   <customField>
    <description>"MyLDSMail"</description>
    <customFieldId>76543</customFieldId>
    <value>jsmithjr@myldsmail.net</value>
   </customField>
  </customFields>
  <individualId>123456</individualId>
  <mission>
   <missionUnitId xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
   <parentUnitId>23456</parentUnitId>
   <unitId>12345</unitId>
   <unitName>Palmyra New York Mission</unitName>
   <unitType>Mission</unitType>
   <unitTypeId>3</unitTypeId>
  </mission>
  <role>
   <code>JUNIOR_COMPANION</code>
   <roleId>9</roleId>
  </role>
  <status>
   <code>IN_FIELD</code>
   <name>In Field</name>
  </status>
 </Assignment>
</ns2:getInFieldMissionaryAssignmentResponse>

getProselytingAreasInUnit

Method

java.util.List<ProselytingAreaInfo> getProselytingAreasInUnit(java.lang.String unitId)

Description

Retrieves proselytizing areas within a unit
Zones are children of Missions, Districts are children of Zones and ProselytingAreas are children of Districts
There is a Many to Many relationship between proselytingAreas and church units This relationship is set and maintained by Missions The relationship can be configured either for wards/branches to proselyting areas or from Stakes/Ecclesiastical Districts to proselyting areas. A mission determines which relationship is appropriate.

REST Path

unit/{unitId}/proselyting_areas/

Parameters

unitId - The unit id of a Ward/Branch/Stake/District

Returns

A list of proselyting areas that fall within an ecclesiastical unit.

Throws

SoapFault - if the unit number is missing

Example SOAP Response

 
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
 <soap:Body> 
  <ns2:getProselytingAreasInUnitResponse xmlns:ns2="http://schema.lds.org/missionary-services/v1_0">
   <ProselytingArea>
    <address>
     <city>Scranton</city>
     <countryCode>251</countryCode>
     <postalCode>17963</postalCode>
     <stateProvince>OH</stateProvince>
     <streetAddress>123 North Temple Street, Apt. A</streetAddress>
    </address>
    <districtName>District One</districtName>
    <id>9267853</id>
    <individualIds>3282556237</individualIds>
    <individualIds>9348936165</individualIds>
    <name>South Scranton Proselyting Area</name>
    <phoneNumbers>
     <acceptsMMS>false</acceptsMMS>
     <acceptsSMS>true</acceptsSMS>
     <callerCharged>false</callerCharged>
     <id>12174782</id>
     <number>210-867-5309</number>
    </phoneNumbers>
    <unitsServed>
     <parentUnitId>403248</parentUnitId>
     <unitId>423883</unitId>
     <unitName>Scranton Ward</unitName>
     <unitType>Ward</unitType>
     <unitTypeId>7</unitTypeId>
    </unitsServed>
    <zoneName>Dunder Mifflin Zone</zoneName>
   </ProselytingArea>
  </ns2:getProselytingAreasInUnitResponse>
 </soap:Body>
</soap:Envelope>

getZonesInMission

Method

java.util.List<ZoneInfo> getZonesInMission(java.lang.String missionUnitNumber)

Description

Retrieves zones within a mission

REST Path

mission/{missionUnitNumber}/zones/

Parameters

unitId - unit id of a mission

Returns

A list of zones within the mission.

Throws

SoapFault - if the unit number is missing

Example SOAP Response

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
 <soap:Body>
  <ns2:getZonesInMissionResponse xmlns:ns2="http://schema.lds.org/missionary-services/v1_0">
   <return>
    <zoneId>3203160</zoneId>
    <zoneName>First Zone</zoneName>
   </return>
   <return>
    <zoneId>1233065</zoneId>
    <zoneName>Second Zone</zoneName>
   </return>
  </ns2:getZonesInMissionResponse>
 </soap:Body>
</soap:Envelope>



getDistrictsInMission

Method

java.util.List<DistrictInfo> getDistrictsInMission(java.lang.String missionUnitNumber)

Description

Retrieves districts within a mission.
Zones are children of Missions, Districts are children of Zones and ProselytingAreas are children of Districts

REST Path

mission/{missionUnitNumber}/districts/

Parameters

unitId - unit id of a mission

Returns

A list of Districts within the mission.

Throws

SoapFault - if the unit number is missing

Example SOAP Response

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
 <soap:Body>
  <ns2:getDistrictsInMissionResponse xmlns:ns2="http://schema.lds.org/missionary-services/v1_0">
   <return>
    <districtId>4523032</districtId>
    <districtName>District One</districtName>
    <zoneId>2533267</zoneId>
   </return>
   <return>
    <districtId>3502872</districtId>
    <districtName>District Two</districtName>
    <zoneId>2503023</zoneId>
   </return>
  </ns2:getDistrictsInMissionResponse>
 </soap:Body>
</soap:Envelope>
This page was last modified on 2 April 2010, at 07:52.

Note: Content found in this wiki may not always reflect official Church information. See Terms of Use.