HostFact API versie 3.1



Contacten

Contacten zijn te beheren via de controller 'handle'.



list

Middels deze functie kunt u een lijst met contacten ophalen die voldoen aan de meegegeven parameters.
Voorbeeldbestand: /voorbeelden/handle/handle.list.php


Invoerparameters:
Veldnaam Waarde Omschrijving
offset int Standaard: 0
limit int Standaard: 1000
sort string Standaard: Handle
order 'ASC' of 'DESC' Standaard: ASC
searchat string Welke velden doorzocht moeten worden.
Standaard: Handle|RegistrarHandle|DebtorCode
searchfor string Zoekterm
created filter_datetime Filtermogelijkheid op aanmaakdatum
modified filter_datetime Filtermogelijkheid op wijzigingsdatum

Voorbeeld invoer:
<?php

require_once("../hostfact_api.php");

$api = new HostFactAPI();

$handleParams = array(
				// Get all handles of customer DB0001
				'searchfor'			=> 'DB0001'
);

$response = $api->sendRequest('handle', 'list', $handleParams);

print_r_pre($response);

?>

Voorbeeld uitvoer:
Array
(
    [controller] => handle
    [action] => list
    [status] => success
    [date] => 2022-11-24T12:00:00+02:00
    [totalresults] => 1
    [currentresults] => 1
    [offset] => 0
    [filters] => Array
        (
            [searchfor] => DB0001
        )

    [handles] => Array
        (
            [0] => Array
                (
                    [Identifier] => 1
                    [Handle] => DB0001-001
                    [Registrar] => 1
                    [RegistrarHandle] => 
                    [Debtor] => 1
                    [CompanyName] => Company X
                    [Initials] => John
                    [SurName] => Jackson
                    [EmailAddress] => info@company.com
                    [Modified] => 2022-11-24 11:00:00
                )

        )

)