POST api/owners/institutions

Request Information

URI Parameters

None.

Body Parameters

GetOwnerInstitutionRequest
NameDescriptionTypeAdditional information
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/json, text/json

Sample:
{
  "KnownSearchFields": [
    "InstitutionNumber",
    "TypeName",
    "TypeId",
    "PhysicalCommuneNumber",
    "AdministrativeCommuneNumber",
    "HasWs17Agreement",
    "Active"
  ],
  "KnownSortFields": [],
  "PageSize": 1,
  "PageIndex": 2,
  "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

SearchResultOfGetOwnerInstitutionResponse
NameDescriptionTypeAdditional information
Items

Collection of GetOwnerInstitutionResponse

None.

Total

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Items": [
    {
      "InstitutionId": "67290a5e-86d3-4447-92c8-c25ed269720e",
      "InstitutionName": "sample string 2",
      "InstitutionNumber": "sample string 3",
      "GroupTypeId": "sample string 4",
      "GroupTypeName": "sample string 5",
      "Address": "sample string 6",
      "City": "sample string 7",
      "WS17": true,
      "Active": true,
      "PhysicalMunicipality": "sample string 10",
      "PhysicalMunicipalityName": "sample string 11",
      "Municipality": "sample string 12",
      "MunicipalityName": "sample string 13"
    },
    {
      "InstitutionId": "67290a5e-86d3-4447-92c8-c25ed269720e",
      "InstitutionName": "sample string 2",
      "InstitutionNumber": "sample string 3",
      "GroupTypeId": "sample string 4",
      "GroupTypeName": "sample string 5",
      "Address": "sample string 6",
      "City": "sample string 7",
      "WS17": true,
      "Active": true,
      "PhysicalMunicipality": "sample string 10",
      "PhysicalMunicipalityName": "sample string 11",
      "Municipality": "sample string 12",
      "MunicipalityName": "sample string 13"
    }
  ],
  "Total": 1
}