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