search shadow

Articles in this section

See more

API - Mission Participants Follow

Avatar
Ryan MacAlmon
  • Updated

The mission participants endpoint will return all participants for a specific mission trip if they have not been deleted. This will return particpants that have not yet been confirmed which are called "applicants" as well. The participant information will include basic information about the person along with any profile question answers and application question answers that the participant provided.

The max pageSize can be 100. In the headers of the response will be a header "X-Pagination" which will hold pagination information to identify the total count of participants and what the url is for the prev and next set of participants.

Request

Below is an example request. Please replace <TENANT_API_URL> with the url is that presented under the license key section for settings inside of Focus Missions. Refer to the authentication section of the document for instructions on how to find this url.

URL: https://<TENANT_API_URL>/1.0/missions/{tripID}/participants?page=1&pageSize=20

Request Headers:

Authorization: Basic 239848923sdfhs93jsdf0u2h3
Content-Type: application/json
Host: 52projects.focusmissions.com
Response:
HTTP/1.1 200 OK
Cache-Control: no-cache
Pragma: no-cache
Content-Type: application/json; charset=utf-8
Expires: -1
Server: Microsoft-IIS/8.5
Set-Cookie: .ASPXANONYMOUS=XRdMygx5HU6ZEcf49Mbwdn_v3mnDtQ-HbxG-rPGqcJ0fIyriul33HaZmz_jSfGkCPYu6evUWvM9mDwUOoCiQKZseKAA5gTo_5wkvW9stpmMtz7SiEK6H_RRgc8ArQpTjU_oyIg2; expires=Thu, 30-Mar-2017 10:18:32 GMT; path=/; HttpOnly
X-AspNet-Version: 4.0.30319
X-Pagination:{"totalCount":96,"totalPages":5,"prevPageLink":"","nextPageLink":"https://52projects.focusmissions.com/api/1.0/missions/1/participants?page=2&pageSize=20"}
X-Powered-By: ASP.NET
Date: Thu, 19 Jan 2017 23:38:32 GMT
Content-Length: 70308
[
{
    "id": 43026,
    "personID": 252159,
    "firstName": "Stormy",
    "lastName": "Weather",
    "email": "cagutekunst+stormy@gmail.com",
    "phone": "2149876325",
    "dateOfBirth": "1989-03-26T00:00:00",
    "gender": "F",
    "citizenship": null,
    "passportFullName": "",
    "passportNumber": null,
    "passportExpiration": null,
    "knownTravelerNumber": "",
    "redressNumber": "",
    "frequentFlyerNumbers": [],
    "address": {
      "line1": "123 Main Street",
      "line2": "",
      "line3": null,
      "line4": null,
      "line5": null,
      "city": "Dallas",
      "province": "TX",
      "postalCode": "77777",
      "country": "US"
    },
    "confirmedDateTime": "2018-03-14T21:54:35.397",
    "participantType": {
      "id": 1,
      "name": "TeamMember"
    },
    "donationUrl": "gVRc0N",
    "removedDateTime": null,
    "applicationCompletionDate": "2018-03-14T21:54:35.397",
    "applicationDecision": {
      "id": 1,
      "name": "Approved"
    },
    "applicationDecisionDate": "2018-03-14T21:55:25.143",
    "applicationDecisionComment": "",
    "tripStory": null,
    "fundRaisingGoal": 500.00,
    "hasMetReferencesRequirement": true,
    "hasBackgroundCheck": false,
    "donationBalance": 0.00,
    "isApplicant": false,
    "profileQuestions": [
      {
        "id": 2184,
        "name": "T-shirt size",
        "isRequired": false,
        "sort": 2,
        "answers": [
          {
            "value": "Medium",
            "valueID": 2067
          }
        ]
      },
      {
        "id": 4733,
        "name": "Do you have any allergies?",
        "isRequired": false,
        "sort": 3,
        "answers": [
          {
            "value": "asdfadf",
            "valueID": null
          }
        ]
      },
      {
        "id": 18225,
        "name": "What are your favorite colors?",
        "isRequired": false,
        "sort": 10,
        "answers": [
          {
            "value": "Green",
            "valueID": 12903
          }
        ]
      }
    ],
    "applicationQuestions": [
      {
        "id": 47051,
        "name": "What is your full legal name",
        "isRequired": true,
        "sort": null,
        "answers": [
          {
            "value": "Stormy",
            "valueID": null
          }
        ]
      },
      {
        "id": 47052,
        "name": "What is your address",
        "isRequired": true,
        "sort": null,
        "answers": [
          {
            "value": "address",
            "valueID": null
          }
        ]
      },
      {
        "id": 47053,
        "name": "What is your home phone number",
        "isRequired": true,
        "sort": null,
        "answers": [
          {
            "value": "phone",
            "valueID": null
          }
        ]
      },
      {
        "id": 47054,
        "name": "What is your date of birth",
        "isRequired": true,
        "sort": null,
        "answers": [
          {
            "value": "asdfa",
            "valueID": null
          }
        ]
      },
      {
        "id": 47055,
        "name": "What is your age",
        "isRequired": true,
        "sort": null,
        "answers": [
          {
            "value": "29",
            "valueID": null
          }
        ]
      },
      {
        "id": 47056,
        "name": "What is your gender?",
        "isRequired": true,
        "sort": null,
        "answers": [
          {
            "value": "Female",
            "valueID": 42180
          }
        ]
      },
      {
        "id": 47057,
        "name": "What is your t-shirt size",
        "isRequired": true,
        "sort": null,
        "answers": [
          {
            "value": "medium",
            "valueID": 42182
          }
        ]
      },
      {
        "id": 47058,
        "name": "What is your experience with short mission trips",
        "isRequired": true,
        "sort": null,
        "answers": [
          {
            "value": "asdf",
            "valueID": null
          }
        ]
      },
      {
        "id": 47059,
        "name": "List any languages you can speak fluently",
        "isRequired": true,
        "sort": null,
        "answers": [
          {
            "value": "adsf",
            "valueID": null
          }
        ]
      },
      {
        "id": 47060,
        "name": "What is your passport number?",
        "isRequired": true,
        "sort": null,
        "answers": [
          {
            "value": "adf",
            "valueID": null
          }
        ]
      },
      {
        "id": 47061,
        "name": "What is your passport expiration?",
        "isRequired": true,
        "sort": null,
        "answers": [
          {
            "value": "adf",
            "valueID": null
          }
        ]
      },
      {
        "id": 47062,
        "name": "Where was your passport issued?",
        "isRequired": false,
        "sort": null,
        "answers": [
          {
            "value": "af",
            "valueID": null
          }
        ]
      },
      {
        "id": 47063,
        "name": "What year are you in college?",
        "isRequired": false,
        "sort": null,
        "answers": [
          {
            "value": "af",
            "valueID": null
          }
        ]
      },
      {
        "id": 48549,
        "name": "Please list any medications that you are currently taking.",
        "isRequired": true,
        "sort": null,
        "answers": [
          {
            "value": "ad",
            "valueID": null
          }
        ]
      },
      {
        "id": 48550,
        "name": "Please list any special skills or gifts (music, singing, drama, etc.) that you have that would be an asset to the team. ",
        "isRequired": false,
        "sort": null,
        "answers": [
          {
            "value": "af",
            "valueID": null
          }
        ]
      },
      {
        "id": 48551,
        "name": "Please list any ministries you are currently serving in at your local church, as well as any additional volunteering you do with a parachurch organizations.",
        "isRequired": true,
        "sort": null,
        "answers": [
          {
            "value": "af",
            "valueID": null
          }
        ]
      }
    ],
    "references": null,
    "emergencyContacts": [
      {
        "id": "39425",
        "fullName": "Mom",
        "relationship": "Mom",
        "phone": "2548969899",
        "email": "mom@test.com",
        "address": {
          "line1": "123 Main Street",
          "line2": null,
          "country": "US",
          "city": "Dallas",
          "stProvince": "TX",
          "postalCode": "77777"
        }
      }
    ],
    "activityLog": []
  },,
    ...
]

 

The following are parameters that can be added to the request

Querystring Parameter Data Type Definition
page integer With pagnation, this specifies the page number that is tied to the request. If no page number is provided, '1' will be used.
pageSize integer With pagnation, this specifies how many records to pull back in the request. The max is 100 and if no number is provided'20' will be used.
updatedFrom dateTime Adds a filter to the request to only retrieve participants where the date that something changed about the participant is greater than the date provided. Date should be in UTC
updatedTo dateTime Adds a filter to the request to only retrieve participants where the date that something changed about the participant is less than the date provided. Date should be in UTC

Related articles