DigiOffice Gateway Web Services

<back to all web services

IDB_4PSBC_Import_Bedrijf

Import bedrijf record vanuit 4PS

Requires Authentication
The following routes are available for this service:
POST/api/4PSBC/ImportBedrijf
"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_Company {
    /** @param {{Status?:string,Errors?:string,DigiOfficeCompanyID?: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 company in DigiOffice */
    DigiOfficeCompanyID;
    /**
     * @type {string}
     * @description GlobalID (digiOfficeId) of the company in DigiOffice */
    DigiOfficeGlobalID;
}
export class IDB_4PSBC_Response_Bedrijf {
    /** @param {{Header?:Header,Response?:Response_Company}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {Header}
     * @description Header of the response */
    Header;
    /**
     * @type {Response_Company}
     * @description Response body */
    Response;
}
export class Data_Company {
    /** @param {{visitAddress?:string,visitAddress2?:string,vatRegistrationNo?:string,vendorNo?:string,customerNo?:string,eMail?:string,companyName4ps?:string,systemId?:string,digiOfficeId?:string,cocRegistrationNo?:string,cocLocationNo?:string,cocCity?:string,visitAddressCountryRegionId?:string,countryRegionId?:string,countryRegionCodeId?:string,mobilePhoneNo?:string,name?:string,name2?:string,visitAddressCity?:string,city?:string,address?:string,visitAddressPostCode?:string,postCode?:string,phoneNo?:string,phoneNo2?:string,homePage?:string,no?:string,companyId?:string,blocked?:boolean,nameAbbreviation?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    visitAddress;
    /** @type {string} */
    visitAddress2;
    /** @type {string} */
    vatRegistrationNo;
    /** @type {string} */
    vendorNo;
    /** @type {string} */
    customerNo;
    /** @type {string} */
    eMail;
    /** @type {string} */
    companyName4ps;
    /** @type {?string} */
    systemId;
    /** @type {?string} */
    digiOfficeId;
    /** @type {string} */
    cocRegistrationNo;
    /** @type {string} */
    cocLocationNo;
    /** @type {string} */
    cocCity;
    /** @type {string} */
    visitAddressCountryRegionId;
    /** @type {string} */
    countryRegionId;
    /** @type {string} */
    countryRegionCodeId;
    /** @type {string} */
    mobilePhoneNo;
    /** @type {string} */
    name;
    /** @type {string} */
    name2;
    /** @type {string} */
    visitAddressCity;
    /** @type {string} */
    city;
    /** @type {string} */
    address;
    /** @type {string} */
    visitAddressPostCode;
    /** @type {string} */
    postCode;
    /** @type {string} */
    phoneNo;
    /** @type {string} */
    phoneNo2;
    /** @type {string} */
    homePage;
    /** @type {string} */
    no;
    /** @type {?string} */
    companyId;
    /** @type {?boolean} */
    blocked;
    /** @type {string} */
    nameAbbreviation;
}
export class IDB_4PSBC_Import_Bedrijf {
    /** @param {{Header?:Header,Data?:Data_Company}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {Header}
     * @description Message header */
    Header;
    /**
     * @type {Data_Company}
     * @description Message data */
    Data;
}

JavaScript IDB_4PSBC_Import_Bedrijf DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /api/4PSBC/ImportBedrijf HTTP/1.1 
Host: dogw.klokgroep.nl 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Header":{"Contains":"String","Date":"String","MessageID":"String","Sender":"String"},"Data":{"visitAddress":"String","visitAddress2":"String","vatRegistrationNo":"String","vendorNo":"String","customerNo":"String","eMail":"String","companyName4ps":"String","systemId":"00000000-0000-0000-0000-000000000000","digiOfficeId":"00000000-0000-0000-0000-000000000000","cocRegistrationNo":"String","cocLocationNo":"String","cocCity":"String","visitAddressCountryRegionId":"String","countryRegionId":"String","countryRegionCodeId":"String","mobilePhoneNo":"String","name":"String","name2":"String","visitAddressCity":"String","city":"String","address":"String","visitAddressPostCode":"String","postCode":"String","phoneNo":"String","phoneNo2":"String","homePage":"String","no":"String","companyId":"00000000-0000-0000-0000-000000000000","blocked":false,"nameAbbreviation":"String"}}

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

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