DigiOffice API Services Services

IDB_4PSBC_Import_Bouwnummer

Import bouwnummer record vanuit 4PS

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 .xml suffix or ?format=xml

HTTP + XML

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-do-services.klokgroep.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<IDB_4PSBC_Import_Bouwnummer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DO.Synchronization.IDB_4PSBC.DTO">
  <Data>
    <address>String</address>
    <address2>String</address2>
    <city>String</city>
    <companyName4ps>String</companyName4ps>
    <countryRegionId>String</countryRegionId>
    <digiOfficeId>00000000-0000-0000-0000-000000000000</digiOfficeId>
    <plotNo>String</plotNo>
    <postCode>String</postCode>
    <projectId>00000000-0000-0000-0000-000000000000</projectId>
    <systemId>00000000-0000-0000-0000-000000000000</systemId>
    <systemModifiedBy>String</systemModifiedBy>
  </Data>
  <Header>
    <Contains>String</Contains>
    <Date>String</Date>
    <MessageID>String</MessageID>
    <Sender>String</Sender>
  </Header>
</IDB_4PSBC_Import_Bouwnummer>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<IDB_4PSBC_Response_Bouwnummer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DO.Synchronization.IDB_4PSBC.DTO">
  <Header>
    <Contains>String</Contains>
    <Date>String</Date>
    <MessageID>String</MessageID>
    <Sender>String</Sender>
  </Header>
  <Response>
    <DigiOfficeBouwnummerID>String</DigiOfficeBouwnummerID>
    <DigiOfficeGlobalID>00000000-0000-0000-0000-000000000000</DigiOfficeGlobalID>
    <Errors>String</Errors>
    <Status>String</Status>
  </Response>
</IDB_4PSBC_Response_Bouwnummer>