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

import Foundation
import ServiceStack

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

    /**
    * Message data
    */
    // @ApiMember(Description="Message data", IsRequired=true)
    public var data:Data_Person

    required public init(){}
}

public class Header : Codable
{
    /**
    * Inhoud van het bericht
    */
    // @ApiMember(Description="Inhoud van het bericht")
    public var contains:String

    /**
    * Datum aanmaak bericht
    */
    // @ApiMember(Description="Datum aanmaak bericht")
    public var date:String

    /**
    * ID voor het bericht
    */
    // @ApiMember(Description="ID voor het bericht")
    public var messageID:String

    /**
    * Verzender van het bericht
    */
    // @ApiMember(Description="Verzender van het bericht")
    public var sender:String

    required public init(){}
}

public class Data_Person : Codable
{
    public var systemId:String?
    public var digiOfficeId:String?
    public var companyName4ps:String
    public var no:String
    public var firstName:String
    public var middleName:String
    public var surname:String
    public var gender:String
    public var initials:String
    public var nameAbbreviation:String
    public var title:String
    public var titleBehindTheName:String
    public var phoneNo:String
    public var mobilePhoneNo:String
    public var eMail:String
    public var visitAddress:String
    public var visitAddress2:String
    public var visitAddressPostCode:String
    public var visitAddressCity:String
    public var visitAddressCountryRegionId:String
    public var companyId:String?
    public var blocked:Bool?
    public var cocCity:String

    required public init(){}
}

public class IDB_4PSBC_Response_Persoon : Codable
{
    /**
    * Header of the response
    */
    // @ApiMember(Description="Header of the response", IsRequired=true)
    public var header:Header

    /**
    * Response body
    */
    // @ApiMember(Description="Response body", IsRequired=true)
    public var response:Response_Person

    required public init(){}
}

public class Response_Person : Codable
{
    /**
    * Reponse status (Ok/Error)
    */
    // @ApiMember(Description="Reponse status (Ok/Error)", IsRequired=true)
    public var status:String

    /**
    * Errors summary
    */
    // @ApiMember(Description="Errors summary")
    public var errors:String

    /**
    * ID of the person in DigiOffice
    */
    // @ApiMember(Description="ID of the person in DigiOffice", IsRequired=true)
    public var digiOfficePersoonID:String

    /**
    * GlobalID (digiOfficeId) of the person in DigiOffice
    */
    // @ApiMember(Description="GlobalID (digiOfficeId) of the person in DigiOffice", IsRequired=true)
    public var digiOfficeGlobalID:String

    required public init(){}
}

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