DigiOffice Gateway Web Services

<back to all web services

IDB_4PSBC_Import_ContactPerson

Import bedrijf record vanuit 4PS

Requires Authentication
The following routes are available for this service:
POST/api/4PSBC/ImportContactpersoon
"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_ContactPerson {
    /** @param {{Status?:string,Errors?:string,DigiOfficeContactPersonID?: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 contactperson in DigiOffice */
    DigiOfficeContactPersonID;
    /**
     * @type {string}
     * @description GlobalID (digiOfficeId) of the contactperson in DigiOffice */
    DigiOfficeGlobalID;
}
export class IDB_4PSBC_Response_ContactPerson {
    /** @param {{Header?:Header,Response?:Response_ContactPerson}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {Header}
     * @description Header of the response */
    Header;
    /**
     * @type {Response_ContactPerson}
     * @description Response body */
    Response;
}
export class Data_ContactPerson {
    /** @param {{systemId?:string,digiOfficeId?:string,companyName4ps?:string,no?:string,crmCompanyId?:string,crmPersonId?:string,jobTitle?:string,phoneNo?:string,mobilePhoneNo?:string,eMail?:string,companyId?:string,blocked?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    systemId;
    /** @type {?string} */
    digiOfficeId;
    /** @type {string} */
    companyName4ps;
    /** @type {string} */
    no;
    /** @type {string} */
    crmCompanyId;
    /** @type {string} */
    crmPersonId;
    /** @type {string} */
    jobTitle;
    /** @type {string} */
    phoneNo;
    /** @type {string} */
    mobilePhoneNo;
    /** @type {string} */
    eMail;
    /** @type {?string} */
    companyId;
    /** @type {?boolean} */
    blocked;
}
export class IDB_4PSBC_Import_ContactPerson {
    /** @param {{Header?:Header,Data?:Data_ContactPerson}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {Header}
     * @description Message header */
    Header;
    /**
     * @type {Data_ContactPerson}
     * @description Message data */
    Data;
}

JavaScript IDB_4PSBC_Import_ContactPerson 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/ImportContactpersoon 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","companyName4ps":"String","no":"String","crmCompanyId":"00000000-0000-0000-0000-000000000000","crmPersonId":"00000000-0000-0000-0000-000000000000","jobTitle":"String","phoneNo":"String","mobilePhoneNo":"String","eMail":"String","companyId":"00000000-0000-0000-0000-000000000000","blocked":false}}

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","DigiOfficeContactPersonID":"String","DigiOfficeGlobalID":"00000000-0000-0000-0000-000000000000"}}