DigiOffice Gateway Web Services

<back to all web services

IDB_4PSBC_Import_Bouwnummer

Import bouwnummer record vanuit 4PS

Requires Authentication
The following routes are available for this service:
POST/api/4PSBC/ImportBouwnummer
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Import bouwnummer record vanuit 4PS
*/
@Api(Description="Import bouwnummer record vanuit 4PS")
open class IDB_4PSBC_Import_Bouwnummer
{
    /**
    * Message header
    */
    @ApiMember(Description="Message header", IsRequired=true)
    open var Header:Header? = null

    /**
    * Message data
    */
    @ApiMember(Description="Message data", IsRequired=true)
    open var Data:Data_Bouwnummer? = null
}

open class Header
{
    /**
    * Inhoud van het bericht
    */
    @ApiMember(Description="Inhoud van het bericht")
    open var Contains:String? = null

    /**
    * Datum aanmaak bericht
    */
    @ApiMember(Description="Datum aanmaak bericht")
    open var Date:String? = null

    /**
    * ID voor het bericht
    */
    @ApiMember(Description="ID voor het bericht")
    open var MessageID:String? = null

    /**
    * Verzender van het bericht
    */
    @ApiMember(Description="Verzender van het bericht")
    open var Sender:String? = null
}

open class Data_Bouwnummer
{
    open var systemId:UUID? = null
    open var digiOfficeId:UUID? = null
    open var projectId:UUID? = null
    open var plotNo:String? = null
    open var address:String? = null
    open var address2:String? = null
    open var postCode:String? = null
    open var city:String? = null
    open var countryRegionId:String? = null
    open var systemModifiedBy:String? = null
    open var companyName4ps:String? = null
}

open class IDB_4PSBC_Response_Bouwnummer
{
    /**
    * Header of the response
    */
    @ApiMember(Description="Header of the response", IsRequired=true)
    open var Header:Header? = null

    /**
    * Response body
    */
    @ApiMember(Description="Response body", IsRequired=true)
    open var Response:Response_Bouwnummer? = null
}

open class Response_Bouwnummer
{
    /**
    * Reponse status (Ok/Error)
    */
    @ApiMember(Description="Reponse status (Ok/Error)", IsRequired=true)
    open var Status:String? = null

    /**
    * Errors summary
    */
    @ApiMember(Description="Errors summary")
    open var Errors:String? = null

    /**
    * ID of the bouwnummer in DigiOffice
    */
    @ApiMember(Description="ID of the bouwnummer in DigiOffice", IsRequired=true)
    open var DigiOfficeBouwnummerID:String? = null

    /**
    * GlobalID (digiOfficeId) of the bouwnummer in DigiOffice
    */
    @ApiMember(Description="GlobalID (digiOfficeId) of the bouwnummer in DigiOffice", IsRequired=true)
    open var DigiOfficeGlobalID:UUID? = null
}

Kotlin IDB_4PSBC_Import_Bouwnummer DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/4PSBC/ImportBouwnummer HTTP/1.1 
Host: test-dogw.klokgroep.nl 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Header":{"Contains":"String","Date":"String","MessageID":"String","Sender":"String"},"Data":{"systemId":"00000000-0000-0000-0000-000000000000","digiOfficeId":"00000000-0000-0000-0000-000000000000","projectId":"00000000-0000-0000-0000-000000000000","plotNo":"String","address":"String","address2":"String","postCode":"String","city":"String","countryRegionId":"String","systemModifiedBy":"String","companyName4ps":"String"}}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Header":{"Contains":"String","Date":"String","MessageID":"String","Sender":"String"},"Response":{"Status":"String","Errors":"String","DigiOfficeBouwnummerID":"String","DigiOfficeGlobalID":"00000000-0000-0000-0000-000000000000"}}