GET GetOrganisationsByName_V2?Name={Name}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| Name | string |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of Organisation| Name | Description | Type | Additional information |
|---|---|---|---|
| OrgID | string |
None. |
|
| OrgName | string |
None. |
|
| TradingName | string |
None. |
|
| Segment | string |
None. |
|
| OrgNumber | string |
None. |
|
| Contacts | Collection of Contact |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"OrgID": "sample string 1",
"OrgName": "sample string 2",
"TradingName": "sample string 3",
"Segment": "sample string 4",
"OrgNumber": "sample string 5",
"Contacts": [
{
"FirstName": "sample string 1",
"LastName": "sample string 2",
"ContactID": "sample string 3",
"Title": "sample string 4",
"OwnerOrgID": "sample string 5"
},
{
"FirstName": "sample string 1",
"LastName": "sample string 2",
"ContactID": "sample string 3",
"Title": "sample string 4",
"OwnerOrgID": "sample string 5"
}
]
},
{
"OrgID": "sample string 1",
"OrgName": "sample string 2",
"TradingName": "sample string 3",
"Segment": "sample string 4",
"OrgNumber": "sample string 5",
"Contacts": [
{
"FirstName": "sample string 1",
"LastName": "sample string 2",
"ContactID": "sample string 3",
"Title": "sample string 4",
"OwnerOrgID": "sample string 5"
},
{
"FirstName": "sample string 1",
"LastName": "sample string 2",
"ContactID": "sample string 3",
"Title": "sample string 4",
"OwnerOrgID": "sample string 5"
}
]
}
]
application/xml, text/xml
Sample:
<ArrayOfBaseController.Organisation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RunMags.API.Controllers">
<BaseController.Organisation>
<Contacts>
<BaseController.Contact>
<ContactID>sample string 3</ContactID>
<FirstName>sample string 1</FirstName>
<LastName>sample string 2</LastName>
<OwnerOrgID>sample string 5</OwnerOrgID>
<Title>sample string 4</Title>
</BaseController.Contact>
<BaseController.Contact>
<ContactID>sample string 3</ContactID>
<FirstName>sample string 1</FirstName>
<LastName>sample string 2</LastName>
<OwnerOrgID>sample string 5</OwnerOrgID>
<Title>sample string 4</Title>
</BaseController.Contact>
</Contacts>
<OrgID>sample string 1</OrgID>
<OrgName>sample string 2</OrgName>
<OrgNumber>sample string 5</OrgNumber>
<Segment>sample string 4</Segment>
<TradingName>sample string 3</TradingName>
</BaseController.Organisation>
<BaseController.Organisation>
<Contacts>
<BaseController.Contact>
<ContactID>sample string 3</ContactID>
<FirstName>sample string 1</FirstName>
<LastName>sample string 2</LastName>
<OwnerOrgID>sample string 5</OwnerOrgID>
<Title>sample string 4</Title>
</BaseController.Contact>
<BaseController.Contact>
<ContactID>sample string 3</ContactID>
<FirstName>sample string 1</FirstName>
<LastName>sample string 2</LastName>
<OwnerOrgID>sample string 5</OwnerOrgID>
<Title>sample string 4</Title>
</BaseController.Contact>
</Contacts>
<OrgID>sample string 1</OrgID>
<OrgName>sample string 2</OrgName>
<OrgNumber>sample string 5</OrgNumber>
<Segment>sample string 4</Segment>
<TradingName>sample string 3</TradingName>
</BaseController.Organisation>
</ArrayOfBaseController.Organisation>