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

namespace DO.Synchronization.IDB_4PSBC.DTO

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type Header() = 
        ///<summary>
        ///Inhoud van het bericht
        ///</summary>
        [<ApiMember(Description="Inhoud van het bericht")>]
        member val Contains:String = null with get,set

        ///<summary>
        ///Datum aanmaak bericht
        ///</summary>
        [<ApiMember(Description="Datum aanmaak bericht")>]
        member val Date:String = null with get,set

        ///<summary>
        ///ID voor het bericht
        ///</summary>
        [<ApiMember(Description="ID voor het bericht")>]
        member val MessageID:String = null with get,set

        ///<summary>
        ///Verzender van het bericht
        ///</summary>
        [<ApiMember(Description="Verzender van het bericht")>]
        member val Sender:String = null with get,set

    [<AllowNullLiteral>]
    type Response_Person() = 
        ///<summary>
        ///Reponse status (Ok/Error)
        ///</summary>
        [<ApiMember(Description="Reponse status (Ok/Error)", IsRequired=true)>]
        member val Status:String = null with get,set

        ///<summary>
        ///Errors summary
        ///</summary>
        [<ApiMember(Description="Errors summary")>]
        member val Errors:String = null with get,set

        ///<summary>
        ///ID of the person in DigiOffice
        ///</summary>
        [<ApiMember(Description="ID of the person in DigiOffice", IsRequired=true)>]
        member val DigiOfficePersoonID:String = null with get,set

        ///<summary>
        ///GlobalID (digiOfficeId) of the person in DigiOffice
        ///</summary>
        [<ApiMember(Description="GlobalID (digiOfficeId) of the person in DigiOffice", IsRequired=true)>]
        member val DigiOfficeGlobalID:Guid = new Guid() with get,set

    [<AllowNullLiteral>]
    type IDB_4PSBC_Response_Persoon() = 
        ///<summary>
        ///Header of the response
        ///</summary>
        [<ApiMember(Description="Header of the response", IsRequired=true)>]
        member val Header:Header = null with get,set

        ///<summary>
        ///Response body
        ///</summary>
        [<ApiMember(Description="Response body", IsRequired=true)>]
        member val Response:Response_Person = null with get,set

    [<AllowNullLiteral>]
    type Data_Person() = 
        member val systemId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val digiOfficeId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val companyName4ps:String = null with get,set
        member val no:String = null with get,set
        member val firstName:String = null with get,set
        member val middleName:String = null with get,set
        member val surname:String = null with get,set
        member val gender:String = null with get,set
        member val initials:String = null with get,set
        member val nameAbbreviation:String = null with get,set
        member val title:String = null with get,set
        member val titleBehindTheName:String = null with get,set
        member val phoneNo:String = null with get,set
        member val mobilePhoneNo:String = null with get,set
        member val eMail:String = null with get,set
        member val visitAddress:String = null with get,set
        member val visitAddress2:String = null with get,set
        member val visitAddressPostCode:String = null with get,set
        member val visitAddressCity:String = null with get,set
        member val visitAddressCountryRegionId:String = null with get,set
        member val companyId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val blocked:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val cocCity:String = null with get,set

    ///<summary>
    ///Import persoon record vanuit 4PS
    ///</summary>
    [<Api(Description="Import persoon record vanuit 4PS")>]
    [<AllowNullLiteral>]
    type IDB_4PSBC_Import_Persoon() = 
        ///<summary>
        ///Message header
        ///</summary>
        [<ApiMember(Description="Message header", IsRequired=true)>]
        member val Header:Header = null with get,set

        ///<summary>
        ///Message data
        ///</summary>
        [<ApiMember(Description="Message data", IsRequired=true)>]
        member val Data:Data_Person = null with get,set

F# IDB_4PSBC_Import_Persoon DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
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/csv
Content-Length: length

{"Header":{"Contains":"String","Date":"String","MessageID":"String","Sender":"String"},"Response":{"Status":"String","Errors":"String","DigiOfficePersoonID":"String","DigiOfficeGlobalID":"00000000-0000-0000-0000-000000000000"}}