DigiOffice Gateway Web Services

<back to all web services

IDB_4PSBC_Import_Persoon

Import persoon record vanuit 4PS

Requires Authentication
The following routes are available for this service:
POST/api/4PSBC/ImportPersoon
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Import persoon record vanuit 4PS
*/
@Api(Description="Import persoon record vanuit 4PS")
open class IDB_4PSBC_Import_Persoon
{
    /**
    * Message header
    */
    @ApiMember(Description="Message header", IsRequired=true)
    open var Header:Header? = null

    /**
    * Message data
    */
    @ApiMember(Description="Message data", IsRequired=true)
    open var Data:Data_Person? = null
}

open class Header
{
    /**
    * Inhoud van het bericht
    */
    @ApiMember(Description="Inhoud van het bericht")
    open var Contains:String? = null

    /**
    * Datum aanmaak bericht
    */
    @ApiMember(Description="Datum aanmaak bericht")
    open var Date:String? = null

    /**
    * ID voor het bericht
    */
    @ApiMember(Description="ID voor het bericht")
    open var MessageID:String? = null

    /**
    * Verzender van het bericht
    */
    @ApiMember(Description="Verzender van het bericht")
    open var Sender:String? = null
}

open class Data_Person
{
    open var systemId:UUID? = null
    open var digiOfficeId:UUID? = null
    open var companyName4ps:String? = null
    open var no:String? = null
    open var firstName:String? = null
    open var middleName:String? = null
    open var surname:String? = null
    open var gender:String? = null
    open var initials:String? = null
    open var nameAbbreviation:String? = null
    open var title:String? = null
    open var titleBehindTheName:String? = null
    open var phoneNo:String? = null
    open var mobilePhoneNo:String? = null
    open var eMail:String? = null
    open var visitAddress:String? = null
    open var visitAddress2:String? = null
    open var visitAddressPostCode:String? = null
    open var visitAddressCity:String? = null
    open var visitAddressCountryRegionId:String? = null
    open var companyId:UUID? = null
    open var blocked:Boolean? = null
    open var cocCity:String? = null
}

open class IDB_4PSBC_Response_Persoon
{
    /**
    * Header of the response
    */
    @ApiMember(Description="Header of the response", IsRequired=true)
    open var Header:Header? = null

    /**
    * Response body
    */
    @ApiMember(Description="Response body", IsRequired=true)
    open var Response:Response_Person? = null
}

open class Response_Person
{
    /**
    * Reponse status (Ok/Error)
    */
    @ApiMember(Description="Reponse status (Ok/Error)", IsRequired=true)
    open var Status:String? = null

    /**
    * Errors summary
    */
    @ApiMember(Description="Errors summary")
    open var Errors:String? = null

    /**
    * ID of the person in DigiOffice
    */
    @ApiMember(Description="ID of the person in DigiOffice", IsRequired=true)
    open var DigiOfficePersoonID:String? = null

    /**
    * GlobalID (digiOfficeId) of the person in DigiOffice
    */
    @ApiMember(Description="GlobalID (digiOfficeId) of the person in DigiOffice", IsRequired=true)
    open var DigiOfficeGlobalID:UUID? = null
}

Kotlin IDB_4PSBC_Import_Persoon DTOs

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

HTTP + XML

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: 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>