PUT api/v2/chamberofcommerce/nl/kvk/registrations/list

ListKVKRegistrationQuery

Request Information

URI Parameters

None.

Body Parameters

The query

Name	Type	Additional information
ObjectKind	ListKVKRegistrationQueryKind	Required
ObjectId	universally unique identifier	Required
KVKNumber	string	Max length: 8 Min length: 8
BranchNumber	string	Max length: 12 Min length: 12
Name	string	Max length: 200
Street	string	Max length: 200
Locality	string	Max length: 200
PostalCode	string	Max length: 6 Min length: 6
StreetNumber	integer (32 bits)	None.
StreetNumberSuffix	string	Max length: 1 Min length: 1
PostalBoxNumber	integer (32 bits)	None.
PageNumber	integer (32 bits)	Required Range: inclusive between 1 and 1000
PageSize	integer (32 bits)	Required Range: inclusive between 1 and 100

Request Formats

application/json

Sample:

{
  "ObjectKind": "Environment",
  "ObjectId": "00000000-0000-0000-0000-000000000000",
  "KVKNumber": "sample string 1",
  "BranchNumber": "sample string 2",
  "Name": "sample string 3",
  "Street": "sample string 4",
  "Locality": "sample string 5",
  "PostalCode": "sample string 6",
  "StreetNumber": 1,
  "StreetNumberSuffix": "sample string 7",
  "PostalBoxNumber": 1,
  "PageNumber": 1,
  "PageSize": 1
}

Response Information

Resource Description

ListKVKRegistrationQueryResult

Name	Type	Additional information
Registrations	Collection of ListKVKRegistrationQueryResultRegistration	None.
HasNextPage	boolean	None.
HasPrevPage	boolean	None.
Count	integer (32 bits)	Range: inclusive between 0 and 2147483647

Response Formats

application/json

Sample:

{
  "Registrations": [
    {
      "KVKNumber": "sample string 1",
      "BranchNumber": "sample string 2",
      "Name": "sample string 3",
      "Type": "sample string 4",
      "Status": "sample string 5",
      "DomesticAddress": {
        "Kind": "VisitAddress",
        "Street": "sample string 1",
        "StreetNumber": "sample string 2",
        "Locality": "sample string 3",
        "PostalCode": "sample string 4"
      },
      "ForeignAddress": {
        "StreetAndNumber": "sample string 1",
        "PostalCodeAndLocality": "sample string 2",
        "Country": "sample string 3"
      }
    },
    {
      "KVKNumber": "sample string 1",
      "BranchNumber": "sample string 2",
      "Name": "sample string 3",
      "Type": "sample string 4",
      "Status": "sample string 5",
      "DomesticAddress": {
        "Kind": "VisitAddress",
        "Street": "sample string 1",
        "StreetNumber": "sample string 2",
        "Locality": "sample string 3",
        "PostalCode": "sample string 4"
      },
      "ForeignAddress": {
        "StreetAndNumber": "sample string 1",
        "PostalCodeAndLocality": "sample string 2",
        "Country": "sample string 3"
      }
    }
  ],
  "HasNextPage": true,
  "HasPrevPage": true,
  "Count": 1
}