POST api/owners

Returns all owners in specific account context based on provided filters (profile scope required)

Request Information

URI Parameters

None.

Body Parameters

Request filters

Name	Type	Additional information
UseOr	boolean	None.
KnownSearchFields	Collection of string	None.
KnownSortFields	Collection of string	None.
PageSize	integer	None.
PageIndex	integer	None.
SearchBy	Collection of Filter	None.
SortBy	Collection of Sort	None.

Request Formats

application/xml, text/xml

Sample:

<GetOwnerRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Requests.Owner">
  <KnownSearchFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Core">
    <d2p1:string>CustomerName</d2p1:string>
    <d2p1:string>Municipality</d2p1:string>
    <d2p1:string>MunicipalityName</d2p1:string>
    <d2p1:string>PhysicalMunicipality</d2p1:string>
    <d2p1:string>PhysicalMunicipalityName</d2p1:string>
    <d2p1:string>Uvmid</d2p1:string>
    <d2p1:string>Address</d2p1:string>
    <d2p1:string>City</d2p1:string>
    <d2p1:string>TypeName</d2p1:string>
    <d2p1:string>Ws17</d2p1:string>
    <d2p1:string>Blocked</d2p1:string>
    <d2p1:string>AlternativeName</d2p1:string>
  </KnownSearchFields>
  <KnownSortFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Core">
    <d2p1:string>CustomerName</d2p1:string>
    <d2p1:string>Municipality</d2p1:string>
    <d2p1:string>MunicipalityName</d2p1:string>
    <d2p1:string>PhysicalMunicipality</d2p1:string>
    <d2p1:string>PhysicalMunicipalityName</d2p1:string>
    <d2p1:string>Uvmid</d2p1:string>
    <d2p1:string>Address</d2p1:string>
    <d2p1:string>City</d2p1:string>
    <d2p1:string>TypeName</d2p1:string>
    <d2p1:string>AlternativeName</d2p1:string>
  </KnownSortFields>
  <PageIndex xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Core">3</PageIndex>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Core">2</PageSize>
  <SearchBy xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Core">
    <Filter>
      <Key>sample string 1</Key>
      <Type>None</Type>
      <Value />
    </Filter>
    <Filter>
      <Key>sample string 1</Key>
      <Type>None</Type>
      <Value />
    </Filter>
  </SearchBy>
  <SortBy xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Core">
    <Sort>
      <Key>sample string 1</Key>
      <Order>None</Order>
    </Sort>
    <Sort>
      <Key>sample string 1</Key>
      <Order>None</Order>
    </Sort>
  </SortBy>
  <UseOr>true</UseOr>
</GetOwnerRequest>

application/json, text/json

Sample:

{
  "UseOr": true,
  "KnownSearchFields": [
    "CustomerName",
    "Municipality",
    "MunicipalityName",
    "PhysicalMunicipality",
    "PhysicalMunicipalityName",
    "Uvmid",
    "Address",
    "City",
    "TypeName",
    "Ws17",
    "Blocked",
    "AlternativeName"
  ],
  "KnownSortFields": [
    "CustomerName",
    "Municipality",
    "MunicipalityName",
    "PhysicalMunicipality",
    "PhysicalMunicipalityName",
    "Uvmid",
    "Address",
    "City",
    "TypeName",
    "AlternativeName"
  ],
  "PageSize": 2,
  "PageIndex": 3,
  "SearchBy": [
    {
      "Key": "sample string 1",
      "Value": {},
      "Type": 0
    },
    {
      "Key": "sample string 1",
      "Value": {},
      "Type": 0
    }
  ],
  "SortBy": [
    {
      "Key": "sample string 1",
      "Order": 0
    },
    {
      "Key": "sample string 1",
      "Order": 0
    }
  ]
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of owners

ApiCollectionResponseOfGetOwnerViewResponse

Name	Type	Additional information
PageSize	integer	None.
PageIndex	integer	None.
Total	integer	None.
SearchBy	Collection of Filter	None.
SortBy	Collection of Sort	None.
Data	Collection of GetOwnerViewResponse	None.
Errors	Collection of string	None.

Response Formats

application/xml, text/xml

Sample:

<ApiCollectionResponseOfGetOwnerViewResponseLgVmlFmJ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Core">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Alice.Dto.Responses">
    <d2p1:GetOwnerViewResponse>
      <d2p1:AccountId>c3f2d946-8eca-4fde-8ca6-de9c2ee0d9d6</d2p1:AccountId>
      <d2p1:Address>sample string 10</d2p1:Address>
      <d2p1:AlternativeName>sample string 18</d2p1:AlternativeName>
      <d2p1:Blocked>true</d2p1:Blocked>
      <d2p1:City>sample string 11</d2p1:City>
      <d2p1:CustomerName>sample string 4</d2p1:CustomerName>
      <d2p1:CustomerNumber>sample string 19</d2p1:CustomerNumber>
      <d2p1:Id>dd7035c0-c4a1-4fb8-a535-a1122e42054c</d2p1:Id>
      <d2p1:IsDeleted>true</d2p1:IsDeleted>
      <d2p1:LastSyncDate>2025-12-25T16:03:29.8258997+00:00</d2p1:LastSyncDate>
      <d2p1:Municipality>sample string 5</d2p1:Municipality>
      <d2p1:MunicipalityName>sample string 6</d2p1:MunicipalityName>
      <d2p1:PhysicalMunicipality>sample string 7</d2p1:PhysicalMunicipality>
      <d2p1:PhysicalMunicipalityName>sample string 8</d2p1:PhysicalMunicipalityName>
      <d2p1:Postcode>sample string 12</d2p1:Postcode>
      <d2p1:Type>13</d2p1:Type>
      <d2p1:TypeName>sample string 14</d2p1:TypeName>
      <d2p1:UserGroupId>sample string 3</d2p1:UserGroupId>
      <d2p1:Uvmid>sample string 9</d2p1:Uvmid>
      <d2p1:Ws17>true</d2p1:Ws17>
    </d2p1:GetOwnerViewResponse>
    <d2p1:GetOwnerViewResponse>
      <d2p1:AccountId>c3f2d946-8eca-4fde-8ca6-de9c2ee0d9d6</d2p1:AccountId>
      <d2p1:Address>sample string 10</d2p1:Address>
      <d2p1:AlternativeName>sample string 18</d2p1:AlternativeName>
      <d2p1:Blocked>true</d2p1:Blocked>
      <d2p1:City>sample string 11</d2p1:City>
      <d2p1:CustomerName>sample string 4</d2p1:CustomerName>
      <d2p1:CustomerNumber>sample string 19</d2p1:CustomerNumber>
      <d2p1:Id>dd7035c0-c4a1-4fb8-a535-a1122e42054c</d2p1:Id>
      <d2p1:IsDeleted>true</d2p1:IsDeleted>
      <d2p1:LastSyncDate>2025-12-25T16:03:29.8258997+00:00</d2p1:LastSyncDate>
      <d2p1:Municipality>sample string 5</d2p1:Municipality>
      <d2p1:MunicipalityName>sample string 6</d2p1:MunicipalityName>
      <d2p1:PhysicalMunicipality>sample string 7</d2p1:PhysicalMunicipality>
      <d2p1:PhysicalMunicipalityName>sample string 8</d2p1:PhysicalMunicipalityName>
      <d2p1:Postcode>sample string 12</d2p1:Postcode>
      <d2p1:Type>13</d2p1:Type>
      <d2p1:TypeName>sample string 14</d2p1:TypeName>
      <d2p1:UserGroupId>sample string 3</d2p1:UserGroupId>
      <d2p1:Uvmid>sample string 9</d2p1:Uvmid>
      <d2p1:Ws17>true</d2p1:Ws17>
    </d2p1:GetOwnerViewResponse>
  </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>
  <PageIndex>2</PageIndex>
  <PageSize>1</PageSize>
  <SearchBy>
    <Filter>
      <Key>sample string 1</Key>
      <Type>None</Type>
      <Value />
    </Filter>
    <Filter>
      <Key>sample string 1</Key>
      <Type>None</Type>
      <Value />
    </Filter>
  </SearchBy>
  <SortBy>
    <Sort>
      <Key>sample string 1</Key>
      <Order>None</Order>
    </Sort>
    <Sort>
      <Key>sample string 1</Key>
      <Order>None</Order>
    </Sort>
  </SortBy>
  <Total>3</Total>
</ApiCollectionResponseOfGetOwnerViewResponseLgVmlFmJ>

application/json, text/json

Sample:

{
  "PageSize": 1,
  "PageIndex": 2,
  "Total": 3,
  "SearchBy": [
    {
      "Key": "sample string 1",
      "Value": {},
      "Type": 0
    },
    {
      "Key": "sample string 1",
      "Value": {},
      "Type": 0
    }
  ],
  "SortBy": [
    {
      "Key": "sample string 1",
      "Order": 0
    },
    {
      "Key": "sample string 1",
      "Order": 0
    }
  ],
  "Data": [
    {
      "Id": "dd7035c0-c4a1-4fb8-a535-a1122e42054c",
      "AccountId": "c3f2d946-8eca-4fde-8ca6-de9c2ee0d9d6",
      "UserGroupId": "sample string 3",
      "CustomerName": "sample string 4",
      "Municipality": "sample string 5",
      "MunicipalityName": "sample string 6",
      "PhysicalMunicipality": "sample string 7",
      "PhysicalMunicipalityName": "sample string 8",
      "Uvmid": "sample string 9",
      "Address": "sample string 10",
      "City": "sample string 11",
      "Postcode": "sample string 12",
      "Type": 13,
      "TypeName": "sample string 14",
      "Ws17": true,
      "LastSyncDate": "2025-12-25T16:03:29.8258997+00:00",
      "Blocked": true,
      "IsDeleted": true,
      "AlternativeName": "sample string 18",
      "CustomerNumber": "sample string 19"
    },
    {
      "Id": "dd7035c0-c4a1-4fb8-a535-a1122e42054c",
      "AccountId": "c3f2d946-8eca-4fde-8ca6-de9c2ee0d9d6",
      "UserGroupId": "sample string 3",
      "CustomerName": "sample string 4",
      "Municipality": "sample string 5",
      "MunicipalityName": "sample string 6",
      "PhysicalMunicipality": "sample string 7",
      "PhysicalMunicipalityName": "sample string 8",
      "Uvmid": "sample string 9",
      "Address": "sample string 10",
      "City": "sample string 11",
      "Postcode": "sample string 12",
      "Type": 13,
      "TypeName": "sample string 14",
      "Ws17": true,
      "LastSyncDate": "2025-12-25T16:03:29.8258997+00:00",
      "Blocked": true,
      "IsDeleted": true,
      "AlternativeName": "sample string 18",
      "CustomerNumber": "sample string 19"
    }
  ],
  "Errors": [
    "sample string 1",
    "sample string 2"
  ]
}