GET

apiportal/v1/Community?surname={surname}&given1={given1}&given2={given2}&gender={gender}&birthDate={birthDate}&page={page}

No documentation available.

Request Information

Roles

Vendor_APIClient

URI Parameters

Name	Type	Additional information
surname	string	Default value is
given1	string	Default value is
given2	string	Default value is
gender	string	Default value is
birthDate	date	None.
page	integer	None.

Body Parameters

None.

Response Information

Resource Description

Collection of spsCommunitySearchAPI_Response

Name	Description	Type	Additional information
CommunityDetails		CommunityDetails	None.
Address		AddressDetails	None.

[
  {
    "CommunityDetails": {
      "ID": 1,
      "Title": "sample string 1",
      "Surname": "sample string 2",
      "Given1": "sample string 3",
      "Preferred": "sample string 4",
      "Given2": "sample string 5",
      "Gender": "sample string 6",
      "BirthDate": "2025-05-09T23:17:17.9918702+10:00",
      "SpouseID": 1,
      "ReligionCode": "sample string 7",
      "ParishCode": "sample string 8",
      "Email": "sample string 9",
      "MobilePhoneActual": "sample string 10",
      "OccupPhone": "sample string 11",
      "OccupEmail": "sample string 12",
      "OccupCode": "sample string 13",
      "OccupDesc": "sample string 14",
      "OccupCompany": "sample string 15"
    },
    "Address": {
      "AddressID": 1,
      "AddressLine": "sample string 1",
      "Suburb": "sample string 2",
      "State": "sample string 3",
      "PostCode": "sample string 4",
      "CountryCode": "sample string 5",
      "PhoneActual": "sample string 6"
    }
  },
  {
    "CommunityDetails": {
      "ID": 1,
      "Title": "sample string 1",
      "Surname": "sample string 2",
      "Given1": "sample string 3",
      "Preferred": "sample string 4",
      "Given2": "sample string 5",
      "Gender": "sample string 6",
      "BirthDate": "2025-05-09T23:17:17.9918702+10:00",
      "SpouseID": 1,
      "ReligionCode": "sample string 7",
      "ParishCode": "sample string 8",
      "Email": "sample string 9",
      "MobilePhoneActual": "sample string 10",
      "OccupPhone": "sample string 11",
      "OccupEmail": "sample string 12",
      "OccupCode": "sample string 13",
      "OccupDesc": "sample string 14",
      "OccupCompany": "sample string 15"
    },
    "Address": {
      "AddressID": 1,
      "AddressLine": "sample string 1",
      "Suburb": "sample string 2",
      "State": "sample string 3",
      "PostCode": "sample string 4",
      "CountryCode": "sample string 5",
      "PhoneActual": "sample string 6"
    }
  }
]

<ArrayOfspsCommunitySearchAPI_Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Synergetic.Model.APIClient">
  <spsCommunitySearchAPI_Response>
    <Address>
      <AddressID>1</AddressID>
      <AddressLine>sample string 1</AddressLine>
      <CountryCode>sample string 5</CountryCode>
      <PhoneActual>sample string 6</PhoneActual>
      <PostCode>sample string 4</PostCode>
      <State>sample string 3</State>
      <Suburb>sample string 2</Suburb>
    </Address>
    <CommunityDetails>
      <BirthDate>2025-05-09T23:17:17.9918702+10:00</BirthDate>
      <Email>sample string 9</Email>
      <Gender>sample string 6</Gender>
      <Given1>sample string 3</Given1>
      <Given2>sample string 5</Given2>
      <ID>1</ID>
      <MobilePhoneActual>sample string 10</MobilePhoneActual>
      <OccupCode>sample string 13</OccupCode>
      <OccupCompany>sample string 15</OccupCompany>
      <OccupDesc>sample string 14</OccupDesc>
      <OccupEmail>sample string 12</OccupEmail>
      <OccupPhone>sample string 11</OccupPhone>
      <ParishCode>sample string 8</ParishCode>
      <Preferred>sample string 4</Preferred>
      <ReligionCode>sample string 7</ReligionCode>
      <SpouseID>1</SpouseID>
      <Surname>sample string 2</Surname>
      <Title>sample string 1</Title>
    </CommunityDetails>
  </spsCommunitySearchAPI_Response>
  <spsCommunitySearchAPI_Response>
    <Address>
      <AddressID>1</AddressID>
      <AddressLine>sample string 1</AddressLine>
      <CountryCode>sample string 5</CountryCode>
      <PhoneActual>sample string 6</PhoneActual>
      <PostCode>sample string 4</PostCode>
      <State>sample string 3</State>
      <Suburb>sample string 2</Suburb>
    </Address>
    <CommunityDetails>
      <BirthDate>2025-05-09T23:17:17.9918702+10:00</BirthDate>
      <Email>sample string 9</Email>
      <Gender>sample string 6</Gender>
      <Given1>sample string 3</Given1>
      <Given2>sample string 5</Given2>
      <ID>1</ID>
      <MobilePhoneActual>sample string 10</MobilePhoneActual>
      <OccupCode>sample string 13</OccupCode>
      <OccupCompany>sample string 15</OccupCompany>
      <OccupDesc>sample string 14</OccupDesc>
      <OccupEmail>sample string 12</OccupEmail>
      <OccupPhone>sample string 11</OccupPhone>
      <ParishCode>sample string 8</ParishCode>
      <Preferred>sample string 4</Preferred>
      <ReligionCode>sample string 7</ReligionCode>
      <SpouseID>1</SpouseID>
      <Surname>sample string 2</Surname>
      <Title>sample string 1</Title>
    </CommunityDetails>
  </spsCommunitySearchAPI_Response>
</ArrayOfspsCommunitySearchAPI_Response>