DigiOffice API Services Services

<back to all web services

Get4PSBCPersons

Get persons mapped to 4PS specific result set

<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


/** @description Get persons mapped to 4PS specific result set */
// @Api(Description="Get persons mapped to 4PS specific result set")
// @ApiResponse(Description="Persons are returned in the message body", IsDefaultResponse=true, StatusCode=200)
class Get4PSBCPersons implements JsonSerializable
{
    public function __construct(
        /** @description Number of items in the resultset per page. Default = 100 */
        // @ApiMember(Description="Number of items in the resultset per page. Default = 100")
        /** @var int */
        public int $PageSize=0,

        /** @description Page number of paged resultset. Default = 1 */
        // @ApiMember(Description="Page number of paged resultset. Default = 1")
        /** @var int */
        public int $PageNumber=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['PageSize'])) $this->PageSize = $o['PageSize'];
        if (isset($o['PageNumber'])) $this->PageNumber = $o['PageNumber'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->PageSize)) $o['PageSize'] = $this->PageSize;
        if (isset($this->PageNumber)) $o['PageNumber'] = $this->PageNumber;
        return empty($o) ? new class(){} : $o;
    }
}

PHP Get4PSBCPersons DTOs

GET /api/4PSBC/persons HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfData_Person xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DO.Synchronization.IDB_4PSBC.DTO">
  <Data_Person>
    <blocked>false</blocked>
    <cocCity>String</cocCity>
    <companyId>00000000-0000-0000-0000-000000000000</companyId>
    <companyName4ps>String</companyName4ps>
    <digiOfficeId>00000000-0000-0000-0000-000000000000</digiOfficeId>
    <eMail>String</eMail>
    <firstName>String</firstName>
    <gender>String</gender>
    <initials>String</initials>
    <middleName>String</middleName>
    <mobilePhoneNo>String</mobilePhoneNo>
    <nameAbbreviation>String</nameAbbreviation>
    <no>String</no>
    <phoneNo>String</phoneNo>
    <surname>String</surname>
    <systemId>00000000-0000-0000-0000-000000000000</systemId>
    <title>String</title>
    <titleBehindTheName>String</titleBehindTheName>
    <visitAddress>String</visitAddress>
    <visitAddress2>String</visitAddress2>
    <visitAddressCity>String</visitAddressCity>
    <visitAddressCountryRegionId>String</visitAddressCountryRegionId>
    <visitAddressPostCode>String</visitAddressPostCode>
  </Data_Person>
</ArrayOfData_Person>