DigiOffice API Services 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.*;

public class dtos
{

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

        /**
        * Message data
        */
        @ApiMember(Description="Message data", IsRequired=true)
        public Data_Bouwnummer Data = null;
        
        public Header getHeader() { return Header; }
        public IDB_4PSBC_Import_Bouwnummer setHeader(Header value) { this.Header = value; return this; }
        public Data_Bouwnummer getData() { return Data; }
        public IDB_4PSBC_Import_Bouwnummer setData(Data_Bouwnummer value) { this.Data = value; return this; }
    }

    public static class Header
    {
        /**
        * Inhoud van het bericht
        */
        @ApiMember(Description="Inhoud van het bericht")
        public String Contains = null;

        /**
        * Datum aanmaak bericht
        */
        @ApiMember(Description="Datum aanmaak bericht")
        public String Date = null;

        /**
        * ID voor het bericht
        */
        @ApiMember(Description="ID voor het bericht")
        public String MessageID = null;

        /**
        * Verzender van het bericht
        */
        @ApiMember(Description="Verzender van het bericht")
        public String Sender = null;
        
        public String getContains() { return Contains; }
        public Header setContains(String value) { this.Contains = value; return this; }
        public String getDate() { return Date; }
        public Header setDate(String value) { this.Date = value; return this; }
        public String getMessageID() { return MessageID; }
        public Header setMessageID(String value) { this.MessageID = value; return this; }
        public String getSender() { return Sender; }
        public Header setSender(String value) { this.Sender = value; return this; }
    }

    public static class Data_Bouwnummer
    {
        public UUID systemId = null;
        public UUID digiOfficeId = null;
        public UUID projectId = null;
        public String plotNo = null;
        public String address = null;
        public String address2 = null;
        public String postCode = null;
        public String city = null;
        public String countryRegionId = null;
        public String systemModifiedBy = null;
        public String companyName4ps = null;
        
        public UUID getSystemId() { return systemId; }
        public Data_Bouwnummer setSystemId(UUID value) { this.systemId = value; return this; }
        public UUID getDigiOfficeId() { return digiOfficeId; }
        public Data_Bouwnummer setDigiOfficeId(UUID value) { this.digiOfficeId = value; return this; }
        public UUID getProjectId() { return projectId; }
        public Data_Bouwnummer setProjectId(UUID value) { this.projectId = value; return this; }
        public String getPlotNo() { return plotNo; }
        public Data_Bouwnummer setPlotNo(String value) { this.plotNo = value; return this; }
        public String getAddress() { return address; }
        public Data_Bouwnummer setAddress(String value) { this.address = value; return this; }
        public String getAddress2() { return address2; }
        public Data_Bouwnummer setAddress2(String value) { this.address2 = value; return this; }
        public String getPostCode() { return postCode; }
        public Data_Bouwnummer setPostCode(String value) { this.postCode = value; return this; }
        public String getCity() { return city; }
        public Data_Bouwnummer setCity(String value) { this.city = value; return this; }
        public String getCountryRegionId() { return countryRegionId; }
        public Data_Bouwnummer setCountryRegionId(String value) { this.countryRegionId = value; return this; }
        public String getSystemModifiedBy() { return systemModifiedBy; }
        public Data_Bouwnummer setSystemModifiedBy(String value) { this.systemModifiedBy = value; return this; }
        public String getCompanyName4ps() { return companyName4ps; }
        public Data_Bouwnummer setCompanyName4ps(String value) { this.companyName4ps = value; return this; }
    }

    public static class IDB_4PSBC_Response_Bouwnummer
    {
        /**
        * Header of the response
        */
        @ApiMember(Description="Header of the response", IsRequired=true)
        public Header Header = null;

        /**
        * Response body
        */
        @ApiMember(Description="Response body", IsRequired=true)
        public Response_Bouwnummer Response = null;
        
        public Header getHeader() { return Header; }
        public IDB_4PSBC_Response_Bouwnummer setHeader(Header value) { this.Header = value; return this; }
        public Response_Bouwnummer getResponse() { return Response; }
        public IDB_4PSBC_Response_Bouwnummer setResponse(Response_Bouwnummer value) { this.Response = value; return this; }
    }

    public static class Response_Bouwnummer
    {
        /**
        * Reponse status (Ok/Error)
        */
        @ApiMember(Description="Reponse status (Ok/Error)", IsRequired=true)
        public String Status = null;

        /**
        * Errors summary
        */
        @ApiMember(Description="Errors summary")
        public String Errors = null;

        /**
        * ID of the bouwnummer in DigiOffice
        */
        @ApiMember(Description="ID of the bouwnummer in DigiOffice", IsRequired=true)
        public String DigiOfficeBouwnummerID = null;

        /**
        * GlobalID (digiOfficeId) of the bouwnummer in DigiOffice
        */
        @ApiMember(Description="GlobalID (digiOfficeId) of the bouwnummer in DigiOffice", IsRequired=true)
        public UUID DigiOfficeGlobalID = null;
        
        public String getStatus() { return Status; }
        public Response_Bouwnummer setStatus(String value) { this.Status = value; return this; }
        public String getErrors() { return Errors; }
        public Response_Bouwnummer setErrors(String value) { this.Errors = value; return this; }
        public String getDigiOfficeBouwnummerID() { return DigiOfficeBouwnummerID; }
        public Response_Bouwnummer setDigiOfficeBouwnummerID(String value) { this.DigiOfficeBouwnummerID = value; return this; }
        public UUID getDigiOfficeGlobalID() { return DigiOfficeGlobalID; }
        public Response_Bouwnummer setDigiOfficeGlobalID(UUID value) { this.DigiOfficeGlobalID = value; return this; }
    }

}

Java 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>