DigiOffice Gateway Web Services

IDB_4PSBC_Import_Persoon

Import persoon record vanuit 4PS

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

"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_Person {
    /** @param {{Status?:string,Errors?:string,DigiOfficePersoonID?: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 person in DigiOffice */
    DigiOfficePersoonID;
    /**
     * @type {string}
     * @description GlobalID (digiOfficeId) of the person in DigiOffice */
    DigiOfficeGlobalID;
}
export class IDB_4PSBC_Response_Persoon {
    /** @param {{Header?:Header,Response?:Response_Person}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {Header}
     * @description Header of the response */
    Header;
    /**
     * @type {Response_Person}
     * @description Response body */
    Response;
}
export class Data_Person {
    /** @param {{systemId?:string,digiOfficeId?:string,companyName4ps?:string,no?:string,firstName?:string,middleName?:string,surname?:string,gender?:string,initials?:string,nameAbbreviation?:string,title?:string,titleBehindTheName?:string,phoneNo?:string,mobilePhoneNo?:string,eMail?:string,visitAddress?:string,visitAddress2?:string,visitAddressPostCode?:string,visitAddressCity?:string,visitAddressCountryRegionId?:string,companyId?:string,blocked?:boolean,cocCity?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    systemId;
    /** @type {?string} */
    digiOfficeId;
    /** @type {string} */
    companyName4ps;
    /** @type {string} */
    no;
    /** @type {string} */
    firstName;
    /** @type {string} */
    middleName;
    /** @type {string} */
    surname;
    /** @type {string} */
    gender;
    /** @type {string} */
    initials;
    /** @type {string} */
    nameAbbreviation;
    /** @type {string} */
    title;
    /** @type {string} */
    titleBehindTheName;
    /** @type {string} */
    phoneNo;
    /** @type {string} */
    mobilePhoneNo;
    /** @type {string} */
    eMail;
    /** @type {string} */
    visitAddress;
    /** @type {string} */
    visitAddress2;
    /** @type {string} */
    visitAddressPostCode;
    /** @type {string} */
    visitAddressCity;
    /** @type {string} */
    visitAddressCountryRegionId;
    /** @type {?string} */
    companyId;
    /** @type {?boolean} */
    blocked;
    /** @type {string} */
    cocCity;
}
export class IDB_4PSBC_Import_Persoon {
    /** @param {{Header?:Header,Data?:Data_Person}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {Header}
     * @description Message header */
    Header;
    /**
     * @type {Data_Person}
     * @description Message data */
    Data;
}

JavaScript IDB_4PSBC_Import_Persoon DTOs

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

HTTP + JSV

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

POST /api/4PSBC/ImportPersoon HTTP/1.1 
Host: test-dogw.klokgroep.nl 
Accept: text/jsv
Content-Type: text/jsv
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,
		firstName: String,
		middleName: String,
		surname: String,
		gender: String,
		initials: String,
		nameAbbreviation: String,
		title: String,
		titleBehindTheName: String,
		phoneNo: String,
		mobilePhoneNo: String,
		eMail: String,
		visitAddress: String,
		visitAddress2: String,
		visitAddressPostCode: String,
		visitAddressCity: String,
		visitAddressCountryRegionId: String,
		companyId: 00000000-0000-0000-0000-000000000000,
		blocked: False,
		cocCity: String
	}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Header: 
	{
		Contains: String,
		Date: String,
		MessageID: String,
		Sender: String
	},
	Response: 
	{
		Status: String,
		Errors: String,
		DigiOfficePersoonID: String
	}
}