HostFact API versie 3.1



Overige diensten

Overige diensten zijn te beheren via de controller 'service'.



list

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


Invoerparameters:
Veldnaam Waarde Omschrijving
status string Abonnement status, zie variabelen-lijst
Standaard: 'active'
offset int Standaard: 0
limit int Standaard: 1000
sort string Standaard: NextDate
order 'ASC' of 'DESC' Standaard: ASC
searchat string Welke velden doorzocht moeten worden.
Standaard: DebtorCode|ProductCode|Description
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();

$serviceParams = array(
				'searchfor'			=> ''
);

$response = $api->sendRequest('service', 'list', $serviceParams);

print_r_pre($response);

?>

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

    [services] => Array
        (
            [0] => Array
                (
                    [Identifier] => 1
                    [Debtor] => 1
                    [DebtorCode] => DB0001
                    [CompanyName] => Company X
                    [Initials] => John
                    [SurName] => Jackson
                    [Status] => active
                    [Subscription] => Array
                        (
                            [ProductCode] => P001
                            [Description] => Default product
                            [Number] => 1
                            [NumberSuffix] => 
                            [PriceExcl] => 250
                            [TaxPercentage] => 21
                            [DiscountPercentage] => 0
                            [Periods] => 1
                            [Periodic] => m
                            [StartPeriod] => 2018-03-14
                            [EndPeriod] => 2018-04-14
                            [NextDate] => 2018-02-28
                            [TerminationDate] => 
                            [AmountExcl] => 250
                            [AmountIncl] => 302.5
                        )

                    [Modified] => 2022-11-24 11:00:00
                )

            [1] => Array
                (
                    [Identifier] => 6
                    [Debtor] => 1
                    [DebtorCode] => DB0001
                    [CompanyName] => Company X
                    [Initials] => John
                    [SurName] => Jackson
                    [Status] => active
                    [Subscription] => Array
                        (
                            [ProductCode] => P003
                            [Description] => Domain example.com
                            [Number] => 1
                            [NumberSuffix] => 
                            [PriceExcl] => 15
                            [TaxPercentage] => 21
                            [DiscountPercentage] => 0
                            [Periods] => 1
                            [Periodic] => j
                            [StartPeriod] => 2018-01-14
                            [EndPeriod] => 2019-07-14
                            [NextDate] => 2018-06-30
                            [TerminationDate] => 
                            [AmountExcl] => 15
                            [AmountIncl] => 18.15
                        )

                    [Modified] => 2022-11-24 11:00:00
                )

            [2] => Array
                (
                    [Identifier] => 7
                    [Debtor] => 1
                    [DebtorCode] => DB0001
                    [CompanyName] => Company X
                    [Initials] => John
                    [SurName] => Jackson
                    [Status] => active
                    [Subscription] => Array
                        (
                            [ProductCode] => P003
                            [Description] => Domain example.com
                            [Number] => 1
                            [NumberSuffix] => 
                            [PriceExcl] => 15
                            [TaxPercentage] => 21
                            [DiscountPercentage] => 0
                            [Periods] => 1
                            [Periodic] => j
                            [StartPeriod] => 2018-01-14
                            [EndPeriod] => 2019-07-14
                            [NextDate] => 2018-06-30
                            [TerminationDate] => 
                            [AmountExcl] => 15
                            [AmountIncl] => 18.15
                        )

                    [Modified] => 2022-11-24 11:00:00
                )

        )

)