DigiOffice API Services Services

IDB_4PSBC_Import_Bouwnummer

Import bouwnummer record vanuit 4PS

The following routes are available for this service:
POST	/api/4PSBC/ImportBouwnummer

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_Bouwnummer
            Public Overridable Property systemId As Guid?
            Public Overridable Property digiOfficeId As Guid?
            Public Overridable Property projectId As Guid
            Public Overridable Property plotNo As String
            Public Overridable Property address As String
            Public Overridable Property address2 As String
            Public Overridable Property postCode As String
            Public Overridable Property city As String
            Public Overridable Property countryRegionId As String
            Public Overridable Property systemModifiedBy As String
            Public Overridable Property companyName4ps As String
        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 bouwnummer record vanuit 4PS
        '''</Summary>
        <Api(Description:="Import bouwnummer record vanuit 4PS")>
        Public Partial Class IDB_4PSBC_Import_Bouwnummer
            '''<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_Bouwnummer
        End Class

        Public Partial Class IDB_4PSBC_Response_Bouwnummer
            '''<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_Bouwnummer
        End Class

        Public Partial Class Response_Bouwnummer
            '''<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 bouwnummer in DigiOffice
            '''</Summary>
            <ApiMember(Description:="ID of the bouwnummer in DigiOffice", IsRequired:=true)>
            Public Overridable Property DigiOfficeBouwnummerID As String

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

VB.NET IDB_4PSBC_Import_Bouwnummer DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /api/4PSBC/ImportBouwnummer HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: application/json
Content-Type: application/json
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","projectId":"00000000-0000-0000-0000-000000000000","plotNo":"String","address":"String","address2":"String","postCode":"String","city":"String","countryRegionId":"String","systemModifiedBy":"String","companyName4ps":"String"}}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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