Waiting for user¶

Some KIK API products may require clarification on locations in order to generate the correct product. In this cases the product will return a waiting for user status. When this status occurs we require that a choice is made between 2 or more locations that have a relation to the original location.

For example when ordering eigendomsinformatie for a certain address it is possible to receive this status. In this example 2 percelen are part of this address. in order to complete the order a perceel has to be chosen to continue.

When receiving waiting for user status please retrieve the location list to start the clarification process

status: waiting for user >> Waiting for user location list: >> Post chosen location: >> status order: >> Download completed order:

Waiting for user location list¶

GET product_api/v1/kik/waiting/(string: uuid)¶

View the list of related locations.

Parameters:	uuid (string) – Uuid of job.
Status Codes:	200 OK – yields the result of the job as a downloadable file. 403 Forbidden – you are not authorized to retrieve the result of this job. 404 Not Found – job did not finish (successfully).

Example request:

GET product_api/v1/kik/waiting/e0ff72f8-ed75-44f8-8bff-d31a7088acc2
Host: planviewer.nl

Example response:

{
  "locaties": {
      "1": "Hoogkerk A 100 Dorpsweg 8 a 9999AA Groningen t.n.v. J. Jansen",
      "2": "Hoogkerk A 101 Dorpsweg 8 9999AA Groningen t.n.v. Jo. de Jong"
  },
  "message": "Which of the found locations must be used to complete te order?"
}

Note

The example above uses non-existent locations

Post chosen location¶

POST product_api/v1/kik/select/(string: uuid)¶

Post index of selected location

Request JSON Object:
Parameters:	uuid (string) – Uuid of job.
	select (integer[]) – index of the location chosen from the locations list:.

Example request:

POST /product_api/v1/kik/select/e0ff72f8-ed75-44f8-8bff-d31a7088acc2
Host: planviewer.nl
Accept: application/json
Content-Type: application/json

{
  "select":2
}

Example response:

{
  "uuid": "e0ff72f8-ed75-44f8-8bff-d31a7088acc2",
  "message": "Generation resumed with new location. use status with this uuid to check progress and completion"
}

Note

in the example above the end-user choice the location with index 2 [see example waiting for user location list]

“1”: “Hoogkerk A 100 Dorpsweg 8 a 9999AA Groningen t.n.v. J. Jansen”,

“2”: “Hoogkerk A 101 Dorpsweg 8 9999AA Groningen t.n.v. Jo. de Jong”

Note

Once the chosen location has been passed the order will automatically continue being generated. User status order call: to check on generation progress.