GET api/v2/Organization?nameFragment={nameFragment}&searchMode={searchMode}&limit={limit}&scopeType={scopeType}&scope={scope}

Request Information

URI Parameters

Name	Type	Additional information
nameFragment	string	Required
searchMode	SearchModes	Default value is Any
limit	integer	Default value is 10
scopeType	ScopeTypes	Default value is All
scope	integer	Default value is 0

Body Parameters

None.

Response Information

Resource Description

Collection of OrganizationInfoV2

Name	Type	Additional information
Name	string	None.
RinggoldId	integer	None.
ParentRinggoldId	integer	None.
AncestorRinggoldIds	Collection of integer	None.
City	string	None.
State	string	None.
Zip	string	None.
Country	string	None.
SearchScore	decimal number	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Name": "sample string 1",
    "RinggoldId": 2,
    "ParentRinggoldId": 3,
    "AncestorRinggoldIds": [
      1,
      2
    ],
    "City": "sample string 4",
    "State": "sample string 5",
    "Zip": "sample string 6",
    "Country": "sample string 7",
    "SearchScore": 8.0
  },
  {
    "Name": "sample string 1",
    "RinggoldId": 2,
    "ParentRinggoldId": 3,
    "AncestorRinggoldIds": [
      1,
      2
    ],
    "City": "sample string 4",
    "State": "sample string 5",
    "Zip": "sample string 6",
    "Country": "sample string 7",
    "SearchScore": 8.0
  }
]

text/html

Sample:

[{"Name":"sample string 1","RinggoldId":2,"ParentRinggoldId":3,"AncestorRinggoldIds":[1,2],"City":"sample string 4","State":"sample string 5","Zip":"sample string 6","Country":"sample string 7","SearchScore":8.0},{"Name":"sample string 1","RinggoldId":2,"ParentRinggoldId":3,"AncestorRinggoldIds":[1,2],"City":"sample string 4","State":"sample string 5","Zip":"sample string 6","Country":"sample string 7","SearchScore":8.0}]

application/xml, text/xml

Sample:

<ArrayOfOrganizationInfoV2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TypeAhead.Models">
  <OrganizationInfoV2>
    <AncestorRinggoldIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>1</d3p1:long>
      <d3p1:long>2</d3p1:long>
    </AncestorRinggoldIds>
    <City>sample string 4</City>
    <Country>sample string 7</Country>
    <Name>sample string 1</Name>
    <ParentRinggoldId>3</ParentRinggoldId>
    <RinggoldId>2</RinggoldId>
    <SearchScore>8</SearchScore>
    <State>sample string 5</State>
    <Zip>sample string 6</Zip>
  </OrganizationInfoV2>
  <OrganizationInfoV2>
    <AncestorRinggoldIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>1</d3p1:long>
      <d3p1:long>2</d3p1:long>
    </AncestorRinggoldIds>
    <City>sample string 4</City>
    <Country>sample string 7</Country>
    <Name>sample string 1</Name>
    <ParentRinggoldId>3</ParentRinggoldId>
    <RinggoldId>2</RinggoldId>
    <SearchScore>8</SearchScore>
    <State>sample string 5</State>
    <Zip>sample string 6</Zip>
  </OrganizationInfoV2>
</ArrayOfOrganizationInfoV2>