upload_examples.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Documentation on the upload task endpoint\n",
    "---------\n",
    "To deliver data, the upload task endpoint is used. By making a POST request, a delivery type can be selected, and the data for it can be provided. This data must be provided in JSON format. The API converts the data into XML format and delivers the data. The status of this process can be tracked in the upload task instance created after a POST request.\n",
    "\n",
    "Below is an example of how a POST request can be made from a script for a GMN StartRegistration:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "import requests\n",
    "\n",
    "url = \"http://brostar.nl/api/uploadtasks/\"\n",
    "\n",
    "metadata = {\n",
    "    \"requestReference\": \"test\",\n",
    "    \"deliveryAccountableParty\": \"12345678\",\n",
    "    \"qualityRegime\": \"IMBRO\",\n",
    "}\n",
    "\n",
    "sourcedocument_data = {\n",
    "    \"objectIdAccountableParty\": \"test\",\n",
    "    \"name\": \"test\",\n",
    "    \"deliveryContext\": \"kaderrichtlijnWater\",\n",
    "    \"monitoringPurpose\": \"strategischBeheerKwaliteitRegionaal\",\n",
    "    \"groundwaterAspect\": \"kwantiteit\",\n",
    "    \"startDateMonitoring\": \"2024-01-01\",\n",
    "    \"measuringPoints\": [\n",
    "        {\n",
    "            \"measuringPointCode\": \"PUT00001\",\n",
    "            \"broId\": \"GMW000000000001\",\n",
    "            \"tubeNumber\": \"1\",\n",
    "        }\n",
    "    ],\n",
    "}\n",
    "\n",
    "payload = {\n",
    "    \"bro_domain\": \"GMN\",\n",
    "    \"project_number\": \"1234\",\n",
    "    \"registration_type\": \"GMN_StartRegistration\",\n",
    "    \"request_type\": \"registration\",\n",
    "    \"metadata\": metadata,\n",
    "    \"sourcedocument_data\": sourcedocument_data,\n",
    "}\n",
    "\n",
    "r = requests.post(url, json=payload)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Available deliveries\n",
    "--------------------\n",
    "\n",
    "**GMW**\n",
    "- registration\n",
    "\n",
    "**GMN_StartRegistration**\n",
    "- registration\n",
    "- move\n",
    "- replace\n",
    "    \n",
    "**GMN_MeasuringPoint**\n",
    "- registration\n",
    "- move\n",
    "- replace\n",
    "- insert\n",
    "- delete\n",
    "\n",
    "**GMN_MeasuringPointEndDate**\n",
    "- registration\n",
    "- move\n",
    "- delete\n",
    "\n",
    "**GMN_TubeReference**\n",
    "- registration\n",
    "- insert\n",
    "- move\n",
    "- replace\n",
    "- delete\n",
    "\n",
    "**GMN_Closure**\n",
    "- registration\n",
    "- move\n",
    "- delete"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Input per registration type\n",
    "---------------------\n"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "GMW \n",
    "####"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "metadata = {\n",
    "    \"requestReference\": \"\",\n",
    "    \"deliveryAccountableParty\": \"\",\n",
    "    \"qualityRegime\": \"\",\n",
    "    \"underPrivilege\": \"\",\n",
    "}\n",
    "\n",
    "sourcedocument_data = {\n",
    "    \"objectIdAccountableParty\": \"\",\n",
    "    \"deliveryContext\": \"\",\n",
    "    \"constructionStandard\": \"\",\n",
    "    \"initialFunction\": \"\",\n",
    "    \"numberOfMonitoringTubes\": \"\",\n",
    "    \"groundLevelStable\": \"\",\n",
    "    \"owner\": \"\",\n",
    "    \"maintenanceResponsibleParty\": \"\",\n",
    "    \"wellHeadProtector\": \"\",\n",
    "    \"wellConstructionDate\": \"\",\n",
    "    \"deliveredLocation\": \"\",\n",
    "    \"horizontalPositioningMethod\": \"\",\n",
    "    \"localVerticalReferencePoint\": \"\",\n",
    "    \"offset\": \"\",\n",
    "    \"verticalDatum\": \"\",\n",
    "    \"groundLevelPosition\": \"\",\n",
    "    \"groundLevelPositioningMethod\": \"\",\n",
    "    \"monitoringTubes\": [\n",
    "        {\n",
    "            \"tubeNumber\": \"\",\n",
    "            \"tubeType\": \"\",\n",
    "            \"artesianWellCapPresent\": \"\",\n",
    "            \"sedimentSumpPresent\": \"\",\n",
    "            \"numberOfGeoOhmCables\": \"\",\n",
    "            \"tubeTopDiameter\": \"\",\n",
    "            \"variableDiameter\": \"\",\n",
    "            \"tubeStatus\": \"\",\n",
    "            \"tubeTopPosition\": \"\",\n",
    "            \"tubeTopPositioningMethod\": \"\",\n",
    "            \"tubePackingMaterial\": \"\",\n",
    "            \"tubeMaterial\": \"\",\n",
    "            \"glue\": \"\",\n",
    "            \"screenLength\": \"\",\n",
    "            \"sockMaterial\": \"\",\n",
    "            \"plainTubePartLength\": \"\",\n",
    "            \"sedimentSumpLength\": \"\",\n",
    "            \"geoohmcables\": [\n",
    "                {\n",
    "                    \"cableNumber\": \"\",\n",
    "                    \"electrodes\": [\n",
    "                        {\n",
    "                            \"electrodeNumber\": \"\",\n",
    "                            \"electrodePackingMaterial\": \"\",\n",
    "                            \"electrodeStatus\": \"\",\n",
    "                            \"electrodePosition\": \"\",\n",
    "                        },\n",
    "                        {\n",
    "                            \"electrodeNumber\": \"\",\n",
    "                            \"electrodePackingMaterial\": \"\",\n",
    "                            \"electrodeStatus\": \"\",\n",
    "                            \"electrodePosition\": \"\",\n",
    "                        },\n",
    "                    ],\n",
    "                }\n",
    "            ],\n",
    "        }\n",
    "    ],\n",
    "}"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "GMN\n",
    "####"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "#########################\n",
    "##      metadata       ##\n",
    "#########################\n",
    "\n",
    "# Registration requests:\n",
    "metadata = {\"requestReference\": \"\", \"deliveryAccountableParty\": \"\", \"qualityRegime\": \"\"}\n",
    "\n",
    "# All other request types:\n",
    "metadata = {\n",
    "    \"requestReference\": \"\",\n",
    "    \"deliveryAccountableParty\": \"\",\n",
    "    \"broId\": \"\",\n",
    "    \"qualityRegime\": \"\",\n",
    "    \"correctionReason\": \"\",\n",
    "}\n",
    "\n",
    "#########################\n",
    "## sourcedocument_data ##\n",
    "#########################\n",
    "\n",
    "# GMN_StartRegistration:\n",
    "\n",
    "sourcedocument_data = {\n",
    "    \"objectIdAccountableParty\": \"\",\n",
    "    \"name\": \"\",\n",
    "    \"deliveryContext\": \"\",\n",
    "    \"monitoringPurpose\": \"\",\n",
    "    \"groundwaterAspect\": \"\",\n",
    "    \"startDateMonitoring\": \"\",\n",
    "    \"measuringPoints\": [{\"measuringPointCode\": \"\", \"broId\": \"\", \"tubeNumber\": \"\"}],\n",
    "}\n",
    "\n",
    "# GMN_MeasuringPoint\n",
    "sourcedocument_data = {\n",
    "    \"eventDate\": \"\",\n",
    "    \"measuringPointCode\": \"\",\n",
    "    \"broId\": \"\",\n",
    "    \"tubeNumber\": \"\",\n",
    "}\n",
    "\n",
    "# GMN_TubeReference\n",
    "sourcedocument_data = {\n",
    "    \"eventDate\": \"\",\n",
    "    \"measuringPointCode\": \"\",\n",
    "    \"broId\": \"\",\n",
    "    \"tubeNumber\": \"\",\n",
    "}\n",
    "\n",
    "# GMN_MeasuringPointEndDate\n",
    "sourcedocument_data = {\"eventDate\": \"\", \"measuringPointCode\": \"\"}\n",
    "\n",
    "# GMN_Closure\n",
    "sourcedocument_data = {\"endDateMonitoring\": \"\"}"
   ]
  }
 ],
 "metadata": {
  "language_info": {
   "name": "python"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}