GET api/Entity?entityName={entityName}&entityAttribute={entityAttribute}&name={name}&page={page}&size={size}
Retrieves Paged List of Accounts starting with the Partial Name
Possible Service Responses:
200/OK - match found and list of account records are in the body of the response.
404/Accounts Not Found - no accounts found matching specified name.
500/Internal Server - unexpected server error, details in the body of the response.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
entityName | System.String |
Required |
|
entityAttribute | System.String |
Required |
|
name |
String to use to match the account name. |
System.String |
Required |
page |
The page number to retrieve results from. |
System.Int32 |
Required |
size |
The size of the page. |
System.Int32 |
Required |
Body Parameters
None.
Response Information
Resource Description
List of Accounts
Altai.Core.Services.Entities+EntityLookupResultsName | Description | Type | Additional information |
---|---|---|---|
TotalRecords | System.Int32 |
None. |
|
Results | System.Collections.Generic.List`1[Altai.Core.Services.Entities+EntityLookup] |
None. |
Response Formats
application/json, text/json
Sample:
{ "TotalRecords": 1, "Results": [ { "Id": "sample string 1", "Name": "sample string 2" }, { "Id": "sample string 1", "Name": "sample string 2" } ] }
application/xml, text/xml
Sample:
<Entities.EntityLookupResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Altai.Core.Services"> <Results> <Entities.EntityLookup> <Id>sample string 1</Id> <Name>sample string 2</Name> </Entities.EntityLookup> <Entities.EntityLookup> <Id>sample string 1</Id> <Name>sample string 2</Name> </Entities.EntityLookup> </Results> <TotalRecords>1</TotalRecords> </Entities.EntityLookupResults>