DigiOffice Gateway Web Services

IDB_4PSBC_Import_Bouwnummer

Import bouwnummer record vanuit 4PS

The following routes are available for this service:
POST	/api/4PSBC/ImportBouwnummer

import Foundation
import ServiceStack

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

    /**
    * Message data
    */
    // @ApiMember(Description="Message data", IsRequired=true)
    public var data:Data_Bouwnummer

    required public init(){}
}

public class Header : Codable
{
    /**
    * Inhoud van het bericht
    */
    // @ApiMember(Description="Inhoud van het bericht")
    public var contains:String

    /**
    * Datum aanmaak bericht
    */
    // @ApiMember(Description="Datum aanmaak bericht")
    public var date:String

    /**
    * ID voor het bericht
    */
    // @ApiMember(Description="ID voor het bericht")
    public var messageID:String

    /**
    * Verzender van het bericht
    */
    // @ApiMember(Description="Verzender van het bericht")
    public var sender:String

    required public init(){}
}

public class Data_Bouwnummer : Codable
{
    public var systemId:String?
    public var digiOfficeId:String?
    public var projectId:String
    public var plotNo:String
    public var address:String
    public var address2:String
    public var postCode:String
    public var city:String
    public var countryRegionId:String
    public var systemModifiedBy:String
    public var companyName4ps:String

    required public init(){}
}

public class IDB_4PSBC_Response_Bouwnummer : Codable
{
    /**
    * Header of the response
    */
    // @ApiMember(Description="Header of the response", IsRequired=true)
    public var header:Header

    /**
    * Response body
    */
    // @ApiMember(Description="Response body", IsRequired=true)
    public var response:Response_Bouwnummer

    required public init(){}
}

public class Response_Bouwnummer : Codable
{
    /**
    * Reponse status (Ok/Error)
    */
    // @ApiMember(Description="Reponse status (Ok/Error)", IsRequired=true)
    public var status:String

    /**
    * Errors summary
    */
    // @ApiMember(Description="Errors summary")
    public var errors:String

    /**
    * ID of the bouwnummer in DigiOffice
    */
    // @ApiMember(Description="ID of the bouwnummer in DigiOffice", IsRequired=true)
    public var digiOfficeBouwnummerID:String

    /**
    * GlobalID (digiOfficeId) of the bouwnummer in DigiOffice
    */
    // @ApiMember(Description="GlobalID (digiOfficeId) of the bouwnummer in DigiOffice", IsRequired=true)
    public var digiOfficeGlobalID:String

    required public init(){}
}

Swift 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"}}