DigiOffice API Services 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
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using DO.Synchronization.IDB_4PSBC.DTO;

namespace DO.Synchronization.IDB_4PSBC.DTO
{
    public partial class Data_Person
    {
        public virtual Guid? systemId { get; set; }
        public virtual Guid? digiOfficeId { get; set; }
        public virtual string companyName4ps { get; set; }
        public virtual string no { get; set; }
        public virtual string firstName { get; set; }
        public virtual string middleName { get; set; }
        public virtual string surname { get; set; }
        public virtual string gender { get; set; }
        public virtual string initials { get; set; }
        public virtual string nameAbbreviation { get; set; }
        public virtual string title { get; set; }
        public virtual string titleBehindTheName { get; set; }
        public virtual string phoneNo { get; set; }
        public virtual string mobilePhoneNo { get; set; }
        public virtual string eMail { get; set; }
        public virtual string visitAddress { get; set; }
        public virtual string visitAddress2 { get; set; }
        public virtual string visitAddressPostCode { get; set; }
        public virtual string visitAddressCity { get; set; }
        public virtual string visitAddressCountryRegionId { get; set; }
        public virtual Guid? companyId { get; set; }
        public virtual bool? blocked { get; set; }
        public virtual string cocCity { get; set; }
    }

    public partial class Header
    {
        ///<summary>
        ///Inhoud van het bericht
        ///</summary>
        [ApiMember(Description="Inhoud van het bericht")]
        public virtual string Contains { get; set; }

        ///<summary>
        ///Datum aanmaak bericht
        ///</summary>
        [ApiMember(Description="Datum aanmaak bericht")]
        public virtual string Date { get; set; }

        ///<summary>
        ///ID voor het bericht
        ///</summary>
        [ApiMember(Description="ID voor het bericht")]
        public virtual string MessageID { get; set; }

        ///<summary>
        ///Verzender van het bericht
        ///</summary>
        [ApiMember(Description="Verzender van het bericht")]
        public virtual string Sender { get; set; }
    }

    ///<summary>
    ///Import persoon record vanuit 4PS
    ///</summary>
    [Api(Description="Import persoon record vanuit 4PS")]
    public partial class IDB_4PSBC_Import_Persoon
    {
        ///<summary>
        ///Message header
        ///</summary>
        [ApiMember(Description="Message header", IsRequired=true)]
        public virtual Header Header { get; set; }

        ///<summary>
        ///Message data
        ///</summary>
        [ApiMember(Description="Message data", IsRequired=true)]
        public virtual Data_Person Data { get; set; }
    }

    public partial class IDB_4PSBC_Response_Persoon
    {
        ///<summary>
        ///Header of the response
        ///</summary>
        [ApiMember(Description="Header of the response", IsRequired=true)]
        public virtual Header Header { get; set; }

        ///<summary>
        ///Response body
        ///</summary>
        [ApiMember(Description="Response body", IsRequired=true)]
        public virtual Response_Person Response { get; set; }
    }

    public partial class Response_Person
    {
        ///<summary>
        ///Reponse status (Ok/Error)
        ///</summary>
        [ApiMember(Description="Reponse status (Ok/Error)", IsRequired=true)]
        public virtual string Status { get; set; }

        ///<summary>
        ///Errors summary
        ///</summary>
        [ApiMember(Description="Errors summary")]
        public virtual string Errors { get; set; }

        ///<summary>
        ///ID of the person in DigiOffice
        ///</summary>
        [ApiMember(Description="ID of the person in DigiOffice", IsRequired=true)]
        public virtual string DigiOfficePersoonID { get; set; }

        ///<summary>
        ///GlobalID (digiOfficeId) of the person in DigiOffice
        ///</summary>
        [ApiMember(Description="GlobalID (digiOfficeId) of the person in DigiOffice", IsRequired=true)]
        public virtual Guid DigiOfficeGlobalID { get; set; }
    }

}

C# 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-do-services.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
	}
}