DigiOffice Gateway Web Services

<back to all web services

IDB_4PSBC_Import_Persoon

Import persoon record vanuit 4PS

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Header:
    # @ApiMember(Description="Inhoud van het bericht")
    contains: Optional[str] = None
    """
    Inhoud van het bericht
    """


    # @ApiMember(Description="Datum aanmaak bericht")
    date: Optional[str] = None
    """
    Datum aanmaak bericht
    """


    # @ApiMember(Description="ID voor het bericht")
    message_i_d: Optional[str] = None
    """
    ID voor het bericht
    """


    # @ApiMember(Description="Verzender van het bericht")
    sender: Optional[str] = None
    """
    Verzender van het bericht
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Response_Person:
    # @ApiMember(Description="Reponse status (Ok/Error)", IsRequired=true)
    status: Optional[str] = None
    """
    Reponse status (Ok/Error)
    """


    # @ApiMember(Description="Errors summary")
    errors: Optional[str] = None
    """
    Errors summary
    """


    # @ApiMember(Description="ID of the person in DigiOffice", IsRequired=true)
    digi_office_persoon_i_d: Optional[str] = None
    """
    ID of the person in DigiOffice
    """


    # @ApiMember(Description="GlobalID (digiOfficeId) of the person in DigiOffice", IsRequired=true)
    digi_office_global_i_d: Optional[str] = None
    """
    GlobalID (digiOfficeId) of the person in DigiOffice
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class IDB_4PSBC_Response_Persoon:
    # @ApiMember(Description="Header of the response", IsRequired=true)
    header: Optional[Header] = None
    """
    Header of the response
    """


    # @ApiMember(Description="Response body", IsRequired=true)
    response: Optional[Response_Person] = None
    """
    Response body
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Data_Person:
    system_id: Optional[str] = None
    digi_office_id: Optional[str] = None
    company_name4ps: Optional[str] = None
    no: Optional[str] = None
    first_name: Optional[str] = None
    middle_name: Optional[str] = None
    surname: Optional[str] = None
    gender: Optional[str] = None
    initials: Optional[str] = None
    name_abbreviation: Optional[str] = None
    title: Optional[str] = None
    title_behind_the_name: Optional[str] = None
    phone_no: Optional[str] = None
    mobile_phone_no: Optional[str] = None
    e_mail: Optional[str] = None
    visit_address: Optional[str] = None
    visit_address2: Optional[str] = None
    visit_address_post_code: Optional[str] = None
    visit_address_city: Optional[str] = None
    visit_address_country_region_id: Optional[str] = None
    company_id: Optional[str] = None
    blocked: Optional[bool] = None
    coc_city: Optional[str] = None


# @Api(Description="Import persoon record vanuit 4PS")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class IDB_4PSBC_Import_Persoon:
    """
    Import persoon record vanuit 4PS
    """

    # @ApiMember(Description="Message header", IsRequired=true)
    header: Optional[Header] = None
    """
    Message header
    """


    # @ApiMember(Description="Message data", IsRequired=true)
    data: Optional[Data_Person] = None
    """
    Message data
    """

Python IDB_4PSBC_Import_Persoon DTOs

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>