DigiOffice Gateway Web Services

<back to all web services

IDB_4PSBC_Import_Persoon

Import persoon record vanuit 4PS

"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

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

<IDB_4PSBC_Import_Persoon xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DO.Synchronization.IDB_4PSBC.DTO">
  <Data>
    <blocked>false</blocked>
    <cocCity>String</cocCity>
    <companyId>00000000-0000-0000-0000-000000000000</companyId>
    <companyName4ps>String</companyName4ps>
    <digiOfficeId>00000000-0000-0000-0000-000000000000</digiOfficeId>
    <eMail>String</eMail>
    <firstName>String</firstName>
    <gender>String</gender>
    <initials>String</initials>
    <middleName>String</middleName>
    <mobilePhoneNo>String</mobilePhoneNo>
    <nameAbbreviation>String</nameAbbreviation>
    <no>String</no>
    <phoneNo>String</phoneNo>
    <surname>String</surname>
    <systemId>00000000-0000-0000-0000-000000000000</systemId>
    <title>String</title>
    <titleBehindTheName>String</titleBehindTheName>
    <visitAddress>String</visitAddress>
    <visitAddress2>String</visitAddress2>
    <visitAddressCity>String</visitAddressCity>
    <visitAddressCountryRegionId>String</visitAddressCountryRegionId>
    <visitAddressPostCode>String</visitAddressPostCode>
  </Data>
  <Header>
    <Contains>String</Contains>
    <Date>String</Date>
    <MessageID>String</MessageID>
    <Sender>String</Sender>
  </Header>
</IDB_4PSBC_Import_Persoon>

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

<IDB_4PSBC_Response_Persoon 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>
    <DigiOfficeGlobalID>00000000-0000-0000-0000-000000000000</DigiOfficeGlobalID>
    <DigiOfficePersoonID>String</DigiOfficePersoonID>
    <Errors>String</Errors>
    <Status>String</Status>
  </Response>
</IDB_4PSBC_Response_Persoon>