POST api/Account/Get
Returns all accounts of specyfic system user based on provided filters
Request Information
URI Parameters
None.
Body Parameters
GetAccountRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Filters | Dictionary of string [key] and FilterValue [value] |
None. |
|
| SortFields | Dictionary of string [key] and OrderType [value] |
None. |
|
| AvailablePageSizes | Collection of integer |
None. |
|
| PageSize | integer |
None. |
|
| PageIndex | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"Filters": {},
"SortFields": {},
"AvailablePageSizes": [
10,
50,
100
],
"PageSize": 1,
"PageIndex": 2
}
application/xml, text/xml
Sample:
<GetAccountRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Requests.GetRequests">
<AvailablePageSizes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Alice.Api.Common.Request">
<d2p1:int>10</d2p1:int>
<d2p1:int>50</d2p1:int>
<d2p1:int>100</d2p1:int>
</AvailablePageSizes>
<Filters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Alice.Api.Common.Request" />
<PageIndex xmlns="http://schemas.datacontract.org/2004/07/Alice.Api.Common.Request">2</PageIndex>
<PageSize xmlns="http://schemas.datacontract.org/2004/07/Alice.Api.Common.Request">1</PageSize>
<SortFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Alice.Api.Common.Request" />
</GetAccountRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ApiCollectionResponseOfIEnumerableOfGetAccountResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| IsSuccess | boolean |
None. |
|
| Errors | Collection of string |
None. |
|
| Data | Collection of GetAccountResponse |
None. |
|
| Filters | Dictionary of string [key] and FilterValue [value] |
None. |
|
| SortFields | Dictionary of string [key] and OrderType [value] |
None. |
|
| AvailablePageSizes | Collection of integer |
None. |
|
| PageSize | integer |
None. |
|
| PageIndex | integer |
None. |
|
| Total | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"IsSuccess": true,
"Errors": [
"sample string 1",
"sample string 2"
],
"Data": [
{
"Id": "90cfe4b5-70eb-4fbd-a806-ce64c791ea1f",
"CompanyName": "sample string 2",
"Cvr": "sample string 3",
"PostalCode": "sample string 4",
"City": "sample string 5",
"Country": "sample string 6",
"AttentionPerson": "sample string 7",
"Phone": "sample string 8",
"PrimaryEmail": "sample string 9",
"Secret": "sample string 10",
"ExternalAccountId": "137ea9e4-85a7-4179-bcb1-a3f62abc6201",
"AccountCredentials": {
"Id": "abc59412-3948-4f52-ac07-7f945f52d211",
"Login": "sample string 2",
"Password": "sample string 3"
}
},
{
"Id": "90cfe4b5-70eb-4fbd-a806-ce64c791ea1f",
"CompanyName": "sample string 2",
"Cvr": "sample string 3",
"PostalCode": "sample string 4",
"City": "sample string 5",
"Country": "sample string 6",
"AttentionPerson": "sample string 7",
"Phone": "sample string 8",
"PrimaryEmail": "sample string 9",
"Secret": "sample string 10",
"ExternalAccountId": "137ea9e4-85a7-4179-bcb1-a3f62abc6201",
"AccountCredentials": {
"Id": "abc59412-3948-4f52-ac07-7f945f52d211",
"Login": "sample string 2",
"Password": "sample string 3"
}
}
],
"Filters": {
"sample string 1": {
"Value": "sample string 1",
"FilterType": 0
},
"sample string 2": {
"Value": "sample string 1",
"FilterType": 0
}
},
"SortFields": {
"sample string 1": 0,
"sample string 2": 0
},
"AvailablePageSizes": [
10,
50,
100
],
"PageSize": 2,
"PageIndex": 3,
"Total": 4
}
application/xml, text/xml
Sample:
<ApiCollectionResponseOfArrayOfGetAccountResponseLgVmlFmJ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Alice.Api.Common.Response">
<AvailablePageSizes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>10</d2p1:int>
<d2p1:int>50</d2p1:int>
<d2p1:int>100</d2p1:int>
</AvailablePageSizes>
<Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Alice.Dto.Responses">
<d2p1:GetAccountResponse>
<d2p1:AccountCredentials>
<d2p1:Id>abc59412-3948-4f52-ac07-7f945f52d211</d2p1:Id>
<d2p1:Login>sample string 2</d2p1:Login>
<d2p1:Password>sample string 3</d2p1:Password>
</d2p1:AccountCredentials>
<d2p1:AttentionPerson>sample string 7</d2p1:AttentionPerson>
<d2p1:City>sample string 5</d2p1:City>
<d2p1:CompanyName>sample string 2</d2p1:CompanyName>
<d2p1:Country>sample string 6</d2p1:Country>
<d2p1:Cvr>sample string 3</d2p1:Cvr>
<d2p1:ExternalAccountId>137ea9e4-85a7-4179-bcb1-a3f62abc6201</d2p1:ExternalAccountId>
<d2p1:Id>90cfe4b5-70eb-4fbd-a806-ce64c791ea1f</d2p1:Id>
<d2p1:Phone>sample string 8</d2p1:Phone>
<d2p1:PostalCode>sample string 4</d2p1:PostalCode>
<d2p1:PrimaryEmail>sample string 9</d2p1:PrimaryEmail>
<d2p1:Secret>sample string 10</d2p1:Secret>
</d2p1:GetAccountResponse>
<d2p1:GetAccountResponse>
<d2p1:AccountCredentials>
<d2p1:Id>abc59412-3948-4f52-ac07-7f945f52d211</d2p1:Id>
<d2p1:Login>sample string 2</d2p1:Login>
<d2p1:Password>sample string 3</d2p1:Password>
</d2p1:AccountCredentials>
<d2p1:AttentionPerson>sample string 7</d2p1:AttentionPerson>
<d2p1:City>sample string 5</d2p1:City>
<d2p1:CompanyName>sample string 2</d2p1:CompanyName>
<d2p1:Country>sample string 6</d2p1:Country>
<d2p1:Cvr>sample string 3</d2p1:Cvr>
<d2p1:ExternalAccountId>137ea9e4-85a7-4179-bcb1-a3f62abc6201</d2p1:ExternalAccountId>
<d2p1:Id>90cfe4b5-70eb-4fbd-a806-ce64c791ea1f</d2p1:Id>
<d2p1:Phone>sample string 8</d2p1:Phone>
<d2p1:PostalCode>sample string 4</d2p1:PostalCode>
<d2p1:PrimaryEmail>sample string 9</d2p1:PrimaryEmail>
<d2p1:Secret>sample string 10</d2p1:Secret>
</d2p1:GetAccountResponse>
</Data>
<Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Errors>
<Filters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringFilterValueN3g1kdQt>
<d2p1:Key>sample string 1</d2p1:Key>
<d2p1:Value xmlns:d4p1="http://schemas.datacontract.org/2004/07/Alice.Api.Common.Request">
<d4p1:FilterType>None</d4p1:FilterType>
<d4p1:Value>sample string 1</d4p1:Value>
</d2p1:Value>
</d2p1:KeyValueOfstringFilterValueN3g1kdQt>
<d2p1:KeyValueOfstringFilterValueN3g1kdQt>
<d2p1:Key>sample string 2</d2p1:Key>
<d2p1:Value xmlns:d4p1="http://schemas.datacontract.org/2004/07/Alice.Api.Common.Request">
<d4p1:FilterType>None</d4p1:FilterType>
<d4p1:Value>sample string 1</d4p1:Value>
</d2p1:Value>
</d2p1:KeyValueOfstringFilterValueN3g1kdQt>
</Filters>
<IsSuccess>true</IsSuccess>
<PageIndex>3</PageIndex>
<PageSize>2</PageSize>
<SortFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringOrderTypevpR9PHaG>
<d2p1:Key>sample string 1</d2p1:Key>
<d2p1:Value>None</d2p1:Value>
</d2p1:KeyValueOfstringOrderTypevpR9PHaG>
<d2p1:KeyValueOfstringOrderTypevpR9PHaG>
<d2p1:Key>sample string 2</d2p1:Key>
<d2p1:Value>None</d2p1:Value>
</d2p1:KeyValueOfstringOrderTypevpR9PHaG>
</SortFields>
<Total>4</Total>
</ApiCollectionResponseOfArrayOfGetAccountResponseLgVmlFmJ>