GET api/Accounts?name={name}
Returns a list of all accounts in your database filtered by name
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| name | string |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of Account| Name | Description | Type | Additional information |
|---|---|---|---|
| AccountId | integer |
None. |
|
| AccountType | AccountType |
None. |
|
| UnitId | integer |
None. |
|
| Name | string |
None. |
|
| IsActive | boolean |
None. |
|
| Comments | string |
None. |
|
| Url | string |
None. |
|
| AccountContacts | Collection of AccountContact |
None. |
|
| Links | Collection of Link |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"AccountId": 1,
"AccountType": {
"AccountTypeId": 1,
"OrganizationId": 2,
"Description": "sample string 3",
"IsActive": true,
"IsSystemDefined": true,
"Links": [
{
"Rel": "sample string 1",
"Href": "sample string 2",
"Title": "sample string 3",
"Type": "sample string 4"
},
{
"Rel": "sample string 1",
"Href": "sample string 2",
"Title": "sample string 3",
"Type": "sample string 4"
}
]
},
"UnitId": 2,
"Name": "sample string 3",
"IsActive": true,
"Comments": "sample string 5",
"Url": "sample string 6",
"AccountContacts": [
{
"AccountContactId": 1,
"AccountId": 2,
"ContactId": 3,
"AccountContactType": {
"AccountContactTypeId": 1,
"OrganizationId": 2,
"Description": "sample string 3",
"IsActive": true,
"IsSystemDefined": true,
"IsAvailableOnline": true,
"IsAvailableForAdult": true,
"IsAvailableForChild": true,
"Links": [
{
"Rel": "sample string 1",
"Href": "sample string 2",
"Title": "sample string 3",
"Type": "sample string 4"
},
{
"Rel": "sample string 1",
"Href": "sample string 2",
"Title": "sample string 3",
"Type": "sample string 4"
}
]
},
"IsPrimary": true,
"IsBilling": true,
"IsEmergency": true,
"IsActive": true,
"CanRegisterSelfOnline": true,
"CanRegisterSelfAndOthersOnline": true,
"CanEditDataOnline": true,
"UnitId": 11,
"Links": [
{
"Rel": "sample string 1",
"Href": "sample string 2",
"Title": "sample string 3",
"Type": "sample string 4"
},
{
"Rel": "sample string 1",
"Href": "sample string 2",
"Title": "sample string 3",
"Type": "sample string 4"
}
]
},
{
"AccountContactId": 1,
"AccountId": 2,
"ContactId": 3,
"AccountContactType": {
"AccountContactTypeId": 1,
"OrganizationId": 2,
"Description": "sample string 3",
"IsActive": true,
"IsSystemDefined": true,
"IsAvailableOnline": true,
"IsAvailableForAdult": true,
"IsAvailableForChild": true,
"Links": [
{
"Rel": "sample string 1",
"Href": "sample string 2",
"Title": "sample string 3",
"Type": "sample string 4"
},
{
"Rel": "sample string 1",
"Href": "sample string 2",
"Title": "sample string 3",
"Type": "sample string 4"
}
]
},
"IsPrimary": true,
"IsBilling": true,
"IsEmergency": true,
"IsActive": true,
"CanRegisterSelfOnline": true,
"CanRegisterSelfAndOthersOnline": true,
"CanEditDataOnline": true,
"UnitId": 11,
"Links": [
{
"Rel": "sample string 1",
"Href": "sample string 2",
"Title": "sample string 3",
"Type": "sample string 4"
},
{
"Rel": "sample string 1",
"Href": "sample string 2",
"Title": "sample string 3",
"Type": "sample string 4"
}
]
}
],
"Links": [
{
"Rel": "sample string 1",
"Href": "sample string 2",
"Title": "sample string 3",
"Type": "sample string 4"
},
{
"Rel": "sample string 1",
"Href": "sample string 2",
"Title": "sample string 3",
"Type": "sample string 4"
}
]
},
{
"AccountId": 1,
"AccountType": {
"AccountTypeId": 1,
"OrganizationId": 2,
"Description": "sample string 3",
"IsActive": true,
"IsSystemDefined": true,
"Links": [
{
"Rel": "sample string 1",
"Href": "sample string 2",
"Title": "sample string 3",
"Type": "sample string 4"
},
{
"Rel": "sample string 1",
"Href": "sample string 2",
"Title": "sample string 3",
"Type": "sample string 4"
}
]
},
"UnitId": 2,
"Name": "sample string 3",
"IsActive": true,
"Comments": "sample string 5",
"Url": "sample string 6",
"AccountContacts": [
{
"AccountContactId": 1,
"AccountId": 2,
"ContactId": 3,
"AccountContactType": {
"AccountContactTypeId": 1,
"OrganizationId": 2,
"Description": "sample string 3",
"IsActive": true,
"IsSystemDefined": true,
"IsAvailableOnline": true,
"IsAvailableForAdult": true,
"IsAvailableForChild": true,
"Links": [
{
"Rel": "sample string 1",
"Href": "sample string 2",
"Title": "sample string 3",
"Type": "sample string 4"
},
{
"Rel": "sample string 1",
"Href": "sample string 2",
"Title": "sample string 3",
"Type": "sample string 4"
}
]
},
"IsPrimary": true,
"IsBilling": true,
"IsEmergency": true,
"IsActive": true,
"CanRegisterSelfOnline": true,
"CanRegisterSelfAndOthersOnline": true,
"CanEditDataOnline": true,
"UnitId": 11,
"Links": [
{
"Rel": "sample string 1",
"Href": "sample string 2",
"Title": "sample string 3",
"Type": "sample string 4"
},
{
"Rel": "sample string 1",
"Href": "sample string 2",
"Title": "sample string 3",
"Type": "sample string 4"
}
]
},
{
"AccountContactId": 1,
"AccountId": 2,
"ContactId": 3,
"AccountContactType": {
"AccountContactTypeId": 1,
"OrganizationId": 2,
"Description": "sample string 3",
"IsActive": true,
"IsSystemDefined": true,
"IsAvailableOnline": true,
"IsAvailableForAdult": true,
"IsAvailableForChild": true,
"Links": [
{
"Rel": "sample string 1",
"Href": "sample string 2",
"Title": "sample string 3",
"Type": "sample string 4"
},
{
"Rel": "sample string 1",
"Href": "sample string 2",
"Title": "sample string 3",
"Type": "sample string 4"
}
]
},
"IsPrimary": true,
"IsBilling": true,
"IsEmergency": true,
"IsActive": true,
"CanRegisterSelfOnline": true,
"CanRegisterSelfAndOthersOnline": true,
"CanEditDataOnline": true,
"UnitId": 11,
"Links": [
{
"Rel": "sample string 1",
"Href": "sample string 2",
"Title": "sample string 3",
"Type": "sample string 4"
},
{
"Rel": "sample string 1",
"Href": "sample string 2",
"Title": "sample string 3",
"Type": "sample string 4"
}
]
}
],
"Links": [
{
"Rel": "sample string 1",
"Href": "sample string 2",
"Title": "sample string 3",
"Type": "sample string 4"
},
{
"Rel": "sample string 1",
"Href": "sample string 2",
"Title": "sample string 3",
"Type": "sample string 4"
}
]
}
]
application/xml, text/xml
Sample:
<ArrayOfAccount xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProClassApi.Web.Api.Models">
<Account>
<AccountContacts>
<AccountContact>
<AccountContactId>1</AccountContactId>
<AccountContactType>
<AccountContactTypeId>1</AccountContactTypeId>
<Description>sample string 3</Description>
<IsActive>true</IsActive>
<IsAvailableForAdult>true</IsAvailableForAdult>
<IsAvailableForChild>true</IsAvailableForChild>
<IsAvailableOnline>true</IsAvailableOnline>
<IsSystemDefined>true</IsSystemDefined>
<Links>
<Link>
<Href>sample string 2</Href>
<Rel>sample string 1</Rel>
<Title>sample string 3</Title>
<Type>sample string 4</Type>
</Link>
<Link>
<Href>sample string 2</Href>
<Rel>sample string 1</Rel>
<Title>sample string 3</Title>
<Type>sample string 4</Type>
</Link>
</Links>
<OrganizationId>2</OrganizationId>
</AccountContactType>
<AccountId>2</AccountId>
<CanEditDataOnline>true</CanEditDataOnline>
<CanRegisterSelfAndOthersOnline>true</CanRegisterSelfAndOthersOnline>
<CanRegisterSelfOnline>true</CanRegisterSelfOnline>
<ContactId>3</ContactId>
<IsActive>true</IsActive>
<IsBilling>true</IsBilling>
<IsEmergency>true</IsEmergency>
<IsPrimary>true</IsPrimary>
<Links>
<Link>
<Href>sample string 2</Href>
<Rel>sample string 1</Rel>
<Title>sample string 3</Title>
<Type>sample string 4</Type>
</Link>
<Link>
<Href>sample string 2</Href>
<Rel>sample string 1</Rel>
<Title>sample string 3</Title>
<Type>sample string 4</Type>
</Link>
</Links>
<UnitId>11</UnitId>
</AccountContact>
<AccountContact>
<AccountContactId>1</AccountContactId>
<AccountContactType>
<AccountContactTypeId>1</AccountContactTypeId>
<Description>sample string 3</Description>
<IsActive>true</IsActive>
<IsAvailableForAdult>true</IsAvailableForAdult>
<IsAvailableForChild>true</IsAvailableForChild>
<IsAvailableOnline>true</IsAvailableOnline>
<IsSystemDefined>true</IsSystemDefined>
<Links>
<Link>
<Href>sample string 2</Href>
<Rel>sample string 1</Rel>
<Title>sample string 3</Title>
<Type>sample string 4</Type>
</Link>
<Link>
<Href>sample string 2</Href>
<Rel>sample string 1</Rel>
<Title>sample string 3</Title>
<Type>sample string 4</Type>
</Link>
</Links>
<OrganizationId>2</OrganizationId>
</AccountContactType>
<AccountId>2</AccountId>
<CanEditDataOnline>true</CanEditDataOnline>
<CanRegisterSelfAndOthersOnline>true</CanRegisterSelfAndOthersOnline>
<CanRegisterSelfOnline>true</CanRegisterSelfOnline>
<ContactId>3</ContactId>
<IsActive>true</IsActive>
<IsBilling>true</IsBilling>
<IsEmergency>true</IsEmergency>
<IsPrimary>true</IsPrimary>
<Links>
<Link>
<Href>sample string 2</Href>
<Rel>sample string 1</Rel>
<Title>sample string 3</Title>
<Type>sample string 4</Type>
</Link>
<Link>
<Href>sample string 2</Href>
<Rel>sample string 1</Rel>
<Title>sample string 3</Title>
<Type>sample string 4</Type>
</Link>
</Links>
<UnitId>11</UnitId>
</AccountContact>
</AccountContacts>
<AccountId>1</AccountId>
<AccountType>
<AccountTypeId>1</AccountTypeId>
<Description>sample string 3</Description>
<IsActive>true</IsActive>
<IsSystemDefined>true</IsSystemDefined>
<Links>
<Link>
<Href>sample string 2</Href>
<Rel>sample string 1</Rel>
<Title>sample string 3</Title>
<Type>sample string 4</Type>
</Link>
<Link>
<Href>sample string 2</Href>
<Rel>sample string 1</Rel>
<Title>sample string 3</Title>
<Type>sample string 4</Type>
</Link>
</Links>
<OrganizationId>2</OrganizationId>
</AccountType>
<Comments>sample string 5</Comments>
<IsActive>true</IsActive>
<Links>
<Link>
<Href>sample string 2</Href>
<Rel>sample string 1</Rel>
<Title>sample string 3</Title>
<Type>sample string 4</Type>
</Link>
<Link>
<Href>sample string 2</Href>
<Rel>sample string 1</Rel>
<Title>sample string 3</Title>
<Type>sample string 4</Type>
</Link>
</Links>
<Name>sample string 3</Name>
<UnitId>2</UnitId>
<Url>sample string 6</Url>
</Account>
<Account>
<AccountContacts>
<AccountContact>
<AccountContactId>1</AccountContactId>
<AccountContactType>
<AccountContactTypeId>1</AccountContactTypeId>
<Description>sample string 3</Description>
<IsActive>true</IsActive>
<IsAvailableForAdult>true</IsAvailableForAdult>
<IsAvailableForChild>true</IsAvailableForChild>
<IsAvailableOnline>true</IsAvailableOnline>
<IsSystemDefined>true</IsSystemDefined>
<Links>
<Link>
<Href>sample string 2</Href>
<Rel>sample string 1</Rel>
<Title>sample string 3</Title>
<Type>sample string 4</Type>
</Link>
<Link>
<Href>sample string 2</Href>
<Rel>sample string 1</Rel>
<Title>sample string 3</Title>
<Type>sample string 4</Type>
</Link>
</Links>
<OrganizationId>2</OrganizationId>
</AccountContactType>
<AccountId>2</AccountId>
<CanEditDataOnline>true</CanEditDataOnline>
<CanRegisterSelfAndOthersOnline>true</CanRegisterSelfAndOthersOnline>
<CanRegisterSelfOnline>true</CanRegisterSelfOnline>
<ContactId>3</ContactId>
<IsActive>true</IsActive>
<IsBilling>true</IsBilling>
<IsEmergency>true</IsEmergency>
<IsPrimary>true</IsPrimary>
<Links>
<Link>
<Href>sample string 2</Href>
<Rel>sample string 1</Rel>
<Title>sample string 3</Title>
<Type>sample string 4</Type>
</Link>
<Link>
<Href>sample string 2</Href>
<Rel>sample string 1</Rel>
<Title>sample string 3</Title>
<Type>sample string 4</Type>
</Link>
</Links>
<UnitId>11</UnitId>
</AccountContact>
<AccountContact>
<AccountContactId>1</AccountContactId>
<AccountContactType>
<AccountContactTypeId>1</AccountContactTypeId>
<Description>sample string 3</Description>
<IsActive>true</IsActive>
<IsAvailableForAdult>true</IsAvailableForAdult>
<IsAvailableForChild>true</IsAvailableForChild>
<IsAvailableOnline>true</IsAvailableOnline>
<IsSystemDefined>true</IsSystemDefined>
<Links>
<Link>
<Href>sample string 2</Href>
<Rel>sample string 1</Rel>
<Title>sample string 3</Title>
<Type>sample string 4</Type>
</Link>
<Link>
<Href>sample string 2</Href>
<Rel>sample string 1</Rel>
<Title>sample string 3</Title>
<Type>sample string 4</Type>
</Link>
</Links>
<OrganizationId>2</OrganizationId>
</AccountContactType>
<AccountId>2</AccountId>
<CanEditDataOnline>true</CanEditDataOnline>
<CanRegisterSelfAndOthersOnline>true</CanRegisterSelfAndOthersOnline>
<CanRegisterSelfOnline>true</CanRegisterSelfOnline>
<ContactId>3</ContactId>
<IsActive>true</IsActive>
<IsBilling>true</IsBilling>
<IsEmergency>true</IsEmergency>
<IsPrimary>true</IsPrimary>
<Links>
<Link>
<Href>sample string 2</Href>
<Rel>sample string 1</Rel>
<Title>sample string 3</Title>
<Type>sample string 4</Type>
</Link>
<Link>
<Href>sample string 2</Href>
<Rel>sample string 1</Rel>
<Title>sample string 3</Title>
<Type>sample string 4</Type>
</Link>
</Links>
<UnitId>11</UnitId>
</AccountContact>
</AccountContacts>
<AccountId>1</AccountId>
<AccountType>
<AccountTypeId>1</AccountTypeId>
<Description>sample string 3</Description>
<IsActive>true</IsActive>
<IsSystemDefined>true</IsSystemDefined>
<Links>
<Link>
<Href>sample string 2</Href>
<Rel>sample string 1</Rel>
<Title>sample string 3</Title>
<Type>sample string 4</Type>
</Link>
<Link>
<Href>sample string 2</Href>
<Rel>sample string 1</Rel>
<Title>sample string 3</Title>
<Type>sample string 4</Type>
</Link>
</Links>
<OrganizationId>2</OrganizationId>
</AccountType>
<Comments>sample string 5</Comments>
<IsActive>true</IsActive>
<Links>
<Link>
<Href>sample string 2</Href>
<Rel>sample string 1</Rel>
<Title>sample string 3</Title>
<Type>sample string 4</Type>
</Link>
<Link>
<Href>sample string 2</Href>
<Rel>sample string 1</Rel>
<Title>sample string 3</Title>
<Type>sample string 4</Type>
</Link>
</Links>
<Name>sample string 3</Name>
<UnitId>2</UnitId>
<Url>sample string 6</Url>
</Account>
</ArrayOfAccount>