DigiOffice Gateway Web Services

<back to all web services

GetContacts

Get all contacts based on CustomerQuery ID

Requires Authentication
import Foundation
import ServiceStack

/**
* Get all contacts based on CustomerQuery ID
*/
public class GetContacts : Codable
{
    public var queryID:Int?

    required public init(){}
}


Swift GetContacts 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 /xml/reply/GetContacts HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetContacts xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Outlook.CRM">
  <QueryID>0</QueryID>
</GetContacts>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfOutlookContactItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Outlook.CRM">
  <OutlookContactItem>
    <Birthday>0001-01-01T00:00:00</Birthday>
    <Business2TelephoneNumber>String</Business2TelephoneNumber>
    <BusinessAddressCity>String</BusinessAddressCity>
    <BusinessAddressCountry>String</BusinessAddressCountry>
    <BusinessAddressPostalCode>String</BusinessAddressPostalCode>
    <BusinessAddressStreet>String</BusinessAddressStreet>
    <BusinessFaxNumber>String</BusinessFaxNumber>
    <BusinessHomePage>String</BusinessHomePage>
    <BusinessTelephoneNumber>String</BusinessTelephoneNumber>
    <Categories>String</Categories>
    <CompanyName>String</CompanyName>
    <Department>String</Department>
    <Email1Address>String</Email1Address>
    <Email1DisplayName>String</Email1DisplayName>
    <Email2Address>String</Email2Address>
    <Email2DisplayName>String</Email2DisplayName>
    <Email3Address>String</Email3Address>
    <Email3DisplayName>String</Email3DisplayName>
    <FileAs>String</FileAs>
    <FirstName>String</FirstName>
    <FullName>String</FullName>
    <Gender>String</Gender>
    <GlobalID>00000000-0000-0000-0000-000000000000</GlobalID>
    <Home2TelephoneNumber>String</Home2TelephoneNumber>
    <HomeAddressCity>String</HomeAddressCity>
    <HomeAddressCountry>String</HomeAddressCountry>
    <HomeAddressPostalCode>String</HomeAddressPostalCode>
    <HomeAddressStreet>String</HomeAddressStreet>
    <HomeFaxNumber>String</HomeFaxNumber>
    <HomeTelephoneNumber>String</HomeTelephoneNumber>
    <ImageID>String</ImageID>
    <ImageLastUpdate>0001-01-01T00:00:00</ImageLastUpdate>
    <Inactief>false</Inactief>
    <JobTitle>String</JobTitle>
    <LastName>String</LastName>
    <MiddleName>String</MiddleName>
    <MobileTelephoneNumber>String</MobileTelephoneNumber>
    <OtherAddressCity>String</OtherAddressCity>
    <OtherAddressCountry>String</OtherAddressCountry>
    <OtherAddressPostalCode>String</OtherAddressPostalCode>
    <OtherAddressStreet>String</OtherAddressStreet>
    <OtherFaxNumber>String</OtherFaxNumber>
    <Profession>String</Profession>
    <Spouse>String</Spouse>
    <Suffix>String</Suffix>
    <Title>String</Title>
    <User1>String</User1>
    <User2>String</User2>
    <User3>String</User3>
    <User4>String</User4>
  </OutlookContactItem>
</ArrayOfOutlookContactItem>