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 .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
	}
}