DigiOffice Gateway Web Services

<back to all web services

GetContacts

Get all contacts based on CustomerQuery ID

Requires Authentication
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 GetContacts:
    """
    Get all contacts based on CustomerQuery ID
    """

    query_i_d: Optional[int] = None

Python GetContacts DTOs

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

HTTP + JSV

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

POST /jsv/reply/GetContacts HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	QueryID: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		Inactief: False,
		Title: String,
		FirstName: String,
		MiddleName: String,
		LastName: String,
		FullName: String,
		Suffix: String,
		Birthday: 0001-01-01,
		Gender: String,
		Categories: String,
		CompanyName: String,
		BusinessAddressStreet: String,
		BusinessAddressPostalCode: String,
		BusinessAddressCity: String,
		BusinessAddressCountry: String,
		OtherAddressStreet: String,
		OtherAddressPostalCode: String,
		OtherAddressCity: String,
		OtherAddressCountry: String,
		Home2TelephoneNumber: String,
		HomeAddressStreet: String,
		HomeAddressPostalCode: String,
		HomeAddressCity: String,
		HomeAddressCountry: String,
		BusinessTelephoneNumber: String,
		Business2TelephoneNumber: String,
		MobileTelephoneNumber: String,
		HomeTelephoneNumber: String,
		Department: String,
		JobTitle: String,
		Profession: String,
		Email1Address: String,
		Email1DisplayName: String,
		Email2Address: String,
		Email2DisplayName: String,
		Email3Address: String,
		Email3DisplayName: String,
		BusinessHomePage: String,
		FileAs: String,
		Spouse: String,
		User1: String,
		User2: String,
		User3: String,
		User4: String,
		ImageID: String,
		ImageLastUpdate: 0001-01-01,
		BusinessFaxNumber: String,
		OtherFaxNumber: String,
		HomeFaxNumber: String
	}
]