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
import Foundation
import ServiceStack

/**
* Import bedrijf record vanuit 4PS
*/
// @Api(Description="Import bedrijf record vanuit 4PS")
public class IDB_4PSBC_Import_ContactPerson : Codable
{
    /**
    * Message header
    */
    // @ApiMember(Description="Message header", IsRequired=true)
    public var header:Header

    /**
    * Message data
    */
    // @ApiMember(Description="Message data", IsRequired=true)
    public var data:Data_ContactPerson

    required public init(){}
}

public class Header : Codable
{
    /**
    * Inhoud van het bericht
    */
    // @ApiMember(Description="Inhoud van het bericht")
    public var contains:String

    /**
    * Datum aanmaak bericht
    */
    // @ApiMember(Description="Datum aanmaak bericht")
    public var date:String

    /**
    * ID voor het bericht
    */
    // @ApiMember(Description="ID voor het bericht")
    public var messageID:String

    /**
    * Verzender van het bericht
    */
    // @ApiMember(Description="Verzender van het bericht")
    public var sender:String

    required public init(){}
}

public class Data_ContactPerson : Codable
{
    public var systemId:String?
    public var digiOfficeId:String?
    public var companyName4ps:String
    public var no:String
    public var crmCompanyId:String
    public var crmPersonId:String
    public var jobTitle:String
    public var phoneNo:String
    public var mobilePhoneNo:String
    public var eMail:String
    public var companyId:String?
    public var blocked:Bool?

    required public init(){}
}

public class IDB_4PSBC_Response_ContactPerson : Codable
{
    /**
    * Header of the response
    */
    // @ApiMember(Description="Header of the response", IsRequired=true)
    public var header:Header

    /**
    * Response body
    */
    // @ApiMember(Description="Response body", IsRequired=true)
    public var response:Response_ContactPerson

    required public init(){}
}

public class Response_ContactPerson : Codable
{
    /**
    * Reponse status (Ok/Error)
    */
    // @ApiMember(Description="Reponse status (Ok/Error)", IsRequired=true)
    public var status:String

    /**
    * Errors summary
    */
    // @ApiMember(Description="Errors summary")
    public var errors:String

    /**
    * ID of the contactperson in DigiOffice
    */
    // @ApiMember(Description="ID of the contactperson in DigiOffice", IsRequired=true)
    public var digiOfficeContactPersonID:String

    /**
    * GlobalID (digiOfficeId) of the contactperson in DigiOffice
    */
    // @ApiMember(Description="GlobalID (digiOfficeId) of the contactperson in DigiOffice", IsRequired=true)
    public var digiOfficeGlobalID:String

    required public init(){}
}


Swift IDB_4PSBC_Import_ContactPerson 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/ImportContactpersoon HTTP/1.1 
Host: test-dogw.klokgroep.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<IDB_4PSBC_Import_ContactPerson 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>
    <companyId>00000000-0000-0000-0000-000000000000</companyId>
    <companyName4ps>String</companyName4ps>
    <crmCompanyId>00000000-0000-0000-0000-000000000000</crmCompanyId>
    <crmPersonId>00000000-0000-0000-0000-000000000000</crmPersonId>
    <digiOfficeId>00000000-0000-0000-0000-000000000000</digiOfficeId>
    <eMail>String</eMail>
    <jobTitle>String</jobTitle>
    <mobilePhoneNo>String</mobilePhoneNo>
    <no>String</no>
    <phoneNo>String</phoneNo>
    <systemId>00000000-0000-0000-0000-000000000000</systemId>
  </Data>
  <Header>
    <Contains>String</Contains>
    <Date>String</Date>
    <MessageID>String</MessageID>
    <Sender>String</Sender>
  </Header>
</IDB_4PSBC_Import_ContactPerson>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<IDB_4PSBC_Response_ContactPerson 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>
    <DigiOfficeContactPersonID>String</DigiOfficeContactPersonID>
    <DigiOfficeGlobalID>00000000-0000-0000-0000-000000000000</DigiOfficeGlobalID>
    <Errors>String</Errors>
    <Status>String</Status>
  </Response>
</IDB_4PSBC_Response_ContactPerson>