GET api/v1/Organization?nameFragment={nameFragment}&limit={limit}&scope={scope}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| nameFragment | string |
Required |
|
| limit | integer |
Default value is 10 |
|
| scope | integer |
Default value is 0 |
Body Parameters
None.
Response Information
Resource Description
Collection of OrganizationInfo| Name | Description | Type | Additional information |
|---|---|---|---|
| Name | string |
None. |
|
| RinggoldId | integer |
None. |
|
| ParentRinggoldId | integer |
None. |
|
| City | string |
None. |
|
| State | string |
None. |
|
| Zip | string |
None. |
|
| Country | string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"Name": "sample string 1",
"RinggoldId": 2,
"ParentRinggoldId": 3,
"City": "sample string 4",
"State": "sample string 5",
"Zip": "sample string 6",
"Country": "sample string 7"
},
{
"Name": "sample string 1",
"RinggoldId": 2,
"ParentRinggoldId": 3,
"City": "sample string 4",
"State": "sample string 5",
"Zip": "sample string 6",
"Country": "sample string 7"
}
]
text/html
Sample:
[{"Name":"sample string 1","RinggoldId":2,"ParentRinggoldId":3,"City":"sample string 4","State":"sample string 5","Zip":"sample string 6","Country":"sample string 7"},{"Name":"sample string 1","RinggoldId":2,"ParentRinggoldId":3,"City":"sample string 4","State":"sample string 5","Zip":"sample string 6","Country":"sample string 7"}]
application/xml, text/xml
Sample:
<ArrayOfOrganizationInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TypeAhead.Models">
<OrganizationInfo>
<City>sample string 4</City>
<Country>sample string 7</Country>
<Name>sample string 1</Name>
<ParentRinggoldId>3</ParentRinggoldId>
<RinggoldId>2</RinggoldId>
<State>sample string 5</State>
<Zip>sample string 6</Zip>
</OrganizationInfo>
<OrganizationInfo>
<City>sample string 4</City>
<Country>sample string 7</Country>
<Name>sample string 1</Name>
<ParentRinggoldId>3</ParentRinggoldId>
<RinggoldId>2</RinggoldId>
<State>sample string 5</State>
<Zip>sample string 6</Zip>
</OrganizationInfo>
</ArrayOfOrganizationInfo>