DigiOffice Gateway Web Services

<back to all web services

IDB_4PSBC_Import_ContactPerson

Import bedrijf record vanuit 4PS

Requires Authentication
The following routes are available for this service:
POST/api/4PSBC/ImportContactpersoon
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports DO.Synchronization.IDB_4PSBC.DTO

Namespace Global

    Namespace DO.Synchronization.IDB_4PSBC.DTO

        Public Partial Class Data_ContactPerson
            Public Overridable Property systemId As Guid?
            Public Overridable Property digiOfficeId As Guid?
            Public Overridable Property companyName4ps As String
            Public Overridable Property no As String
            Public Overridable Property crmCompanyId As Guid
            Public Overridable Property crmPersonId As Guid
            Public Overridable Property jobTitle As String
            Public Overridable Property phoneNo As String
            Public Overridable Property mobilePhoneNo As String
            Public Overridable Property eMail As String
            Public Overridable Property companyId As Guid?
            Public Overridable Property blocked As Boolean?
        End Class

        Public Partial Class Header
            '''<Summary>
            '''Inhoud van het bericht
            '''</Summary>
            <ApiMember(Description:="Inhoud van het bericht")>
            Public Overridable Property Contains As String

            '''<Summary>
            '''Datum aanmaak bericht
            '''</Summary>
            <ApiMember(Description:="Datum aanmaak bericht")>
            Public Overridable Property [Date] As String

            '''<Summary>
            '''ID voor het bericht
            '''</Summary>
            <ApiMember(Description:="ID voor het bericht")>
            Public Overridable Property MessageID As String

            '''<Summary>
            '''Verzender van het bericht
            '''</Summary>
            <ApiMember(Description:="Verzender van het bericht")>
            Public Overridable Property Sender As String
        End Class

        '''<Summary>
        '''Import bedrijf record vanuit 4PS
        '''</Summary>
        <Api(Description:="Import bedrijf record vanuit 4PS")>
        Public Partial Class IDB_4PSBC_Import_ContactPerson
            '''<Summary>
            '''Message header
            '''</Summary>
            <ApiMember(Description:="Message header", IsRequired:=true)>
            Public Overridable Property Header As Header

            '''<Summary>
            '''Message data
            '''</Summary>
            <ApiMember(Description:="Message data", IsRequired:=true)>
            Public Overridable Property Data As Data_ContactPerson
        End Class

        Public Partial Class IDB_4PSBC_Response_ContactPerson
            '''<Summary>
            '''Header of the response
            '''</Summary>
            <ApiMember(Description:="Header of the response", IsRequired:=true)>
            Public Overridable Property Header As Header

            '''<Summary>
            '''Response body
            '''</Summary>
            <ApiMember(Description:="Response body", IsRequired:=true)>
            Public Overridable Property Response As Response_ContactPerson
        End Class

        Public Partial Class Response_ContactPerson
            '''<Summary>
            '''Reponse status (Ok/Error)
            '''</Summary>
            <ApiMember(Description:="Reponse status (Ok/Error)", IsRequired:=true)>
            Public Overridable Property Status As String

            '''<Summary>
            '''Errors summary
            '''</Summary>
            <ApiMember(Description:="Errors summary")>
            Public Overridable Property Errors As String

            '''<Summary>
            '''ID of the contactperson in DigiOffice
            '''</Summary>
            <ApiMember(Description:="ID of the contactperson in DigiOffice", IsRequired:=true)>
            Public Overridable Property DigiOfficeContactPersonID As String

            '''<Summary>
            '''GlobalID (digiOfficeId) of the contactperson in DigiOffice
            '''</Summary>
            <ApiMember(Description:="GlobalID (digiOfficeId) of the contactperson in DigiOffice", IsRequired:=true)>
            Public Overridable Property DigiOfficeGlobalID As Guid
        End Class
    End Namespace
End Namespace

VB.NET IDB_4PSBC_Import_ContactPerson DTOs

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/4PSBC/ImportContactpersoon HTTP/1.1 
Host: test-dogw.klokgroep.nl 
Accept: text/jsonl
Content-Type: text/jsonl
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","crmCompanyId":"00000000-0000-0000-0000-000000000000","crmPersonId":"00000000-0000-0000-0000-000000000000","jobTitle":"String","phoneNo":"String","mobilePhoneNo":"String","eMail":"String","companyId":"00000000-0000-0000-0000-000000000000","blocked":false}}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

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