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
"use strict";
export class Header {
    /** @param {{Contains?:string,Date?:string,MessageID?:string,Sender?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Inhoud van het bericht */
    Contains;
    /**
     * @type {string}
     * @description Datum aanmaak bericht */
    Date;
    /**
     * @type {string}
     * @description ID voor het bericht */
    MessageID;
    /**
     * @type {string}
     * @description Verzender van het bericht */
    Sender;
}
export class Response_Bouwnummer {
    /** @param {{Status?:string,Errors?:string,DigiOfficeBouwnummerID?:string,DigiOfficeGlobalID?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Reponse status (Ok/Error) */
    Status;
    /**
     * @type {string}
     * @description Errors summary */
    Errors;
    /**
     * @type {string}
     * @description ID of the bouwnummer in DigiOffice */
    DigiOfficeBouwnummerID;
    /**
     * @type {string}
     * @description GlobalID (digiOfficeId) of the bouwnummer in DigiOffice */
    DigiOfficeGlobalID;
}
export class IDB_4PSBC_Response_Bouwnummer {
    /** @param {{Header?:Header,Response?:Response_Bouwnummer}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {Header}
     * @description Header of the response */
    Header;
    /**
     * @type {Response_Bouwnummer}
     * @description Response body */
    Response;
}
export class Data_Bouwnummer {
    /** @param {{systemId?:string,digiOfficeId?:string,projectId?:string,plotNo?:string,address?:string,address2?:string,postCode?:string,city?:string,countryRegionId?:string,systemModifiedBy?:string,companyName4ps?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    systemId;
    /** @type {?string} */
    digiOfficeId;
    /** @type {string} */
    projectId;
    /** @type {string} */
    plotNo;
    /** @type {string} */
    address;
    /** @type {string} */
    address2;
    /** @type {string} */
    postCode;
    /** @type {string} */
    city;
    /** @type {string} */
    countryRegionId;
    /** @type {string} */
    systemModifiedBy;
    /** @type {string} */
    companyName4ps;
}
export class IDB_4PSBC_Import_Bouwnummer {
    /** @param {{Header?:Header,Data?:Data_Bouwnummer}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {Header}
     * @description Message header */
    Header;
    /**
     * @type {Data_Bouwnummer}
     * @description Message data */
    Data;
}

JavaScript 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: 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"}}