<back to all web services

BatchRetrieveElmaCredentialsAsync

Represents a service to retrieve ELMA credentials in an asynchronous operation by using search criteria.

<?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 Represents the search criteria for an ELMA credential. */
// @Api(Description="Represents the search criteria for an ELMA credential.")
class CredentialSearchCriteria implements JsonSerializable
{
    public function __construct(
        /** @description The unique identifier of the credential. */
        // @ApiMember(Description="The unique identifier of the credential.", Name="Id")
        /** @var string|null */
        public ?string $id=null,

        /** @description The BZSt (Bundeszentralamt für Steuern) - tax number of the user.  11-character text field that may only consist of two capital letters and 9 digits (0-9).  The fiscal authority BZSt provides this number during registration at the BOP (BZSt-Online Portal - https://www.elster.de/bportal/start).  The number is available in the private area of the BOP user account under "My BOP" under the "Registration Information" */
        // @ApiMember(Description="The BZSt (Bundeszentralamt für Steuern) - tax number of the user.  11-character text field that may only consist of two capital letters and 9 digits (0-9).  The fiscal authority BZSt provides this number during registration at the BOP (BZSt-Online Portal - https://www.elster.de/bportal/start).  The number is available in the private area of the BOP user account under \"My BOP\" under the \"Registration Information\"", Name="AuthSteuernummer")
        /** @var string|null */
        public ?string $authSteuernummer=null,

        /** @description The account identifier of a BZSt-Online Portal (BOP) user.  10-character text field that may only contain numbers (0-9). */
        // @ApiMember(Description="The account identifier of a BZSt-Online Portal (BOP) user.  10-character text field that may only contain numbers (0-9).", Name="AccountId")
        /** @var string|null */
        public ?string $accountId=null
    ) {
    }

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

/** @description Specfies a service to retrieve ELMA credentials. */
// @Api(Description="Specfies a service to retrieve ELMA credentials.")
class BatchRetrieveElmaCredentialsBase implements IPost, JsonSerializable
{
    public function __construct(
        /** @description The parameters used to search for credentials. */
        // @ApiMember(Description="The parameters used to search for credentials.", IsRequired=true, Name="SearchCriteria")
        /** @var array<CredentialSearchCriteria>|null */
        public ?array $searchCriteria=null
    ) {
    }

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

/** @description Represents a service to retrieve ELMA credentials in an asynchronous operation by using search criteria. */
// @Api(Description="Represents a service to retrieve ELMA credentials in an asynchronous operation by using search criteria.")
class BatchRetrieveElmaCredentialsAsync extends BatchRetrieveElmaCredentialsBase implements JsonSerializable
{
    /**
     * @param array<CredentialSearchCriteria>|null $searchCriteria
     */
    public function __construct(
        ?array $searchCriteria=null
    ) {
        parent::__construct($searchCriteria);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['searchCriteria'])) $this->searchCriteria = JsonConverters::fromArray('CredentialSearchCriteria', $o['searchCriteria']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->searchCriteria)) $o['searchCriteria'] = JsonConverters::toArray('CredentialSearchCriteria', $this->searchCriteria);
        return empty($o) ? new class(){} : $o;
    }
}

PHP BatchRetrieveElmaCredentialsAsync DTOs

POST /async/elma/credentials/batch HTTP/1.1 
Host: reportfiling.staging.pwc.de 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"searchCriteria":[{"id":"String","authSteuernummer":"String","accountId":"String"}]}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

[{"id":"String","credential":{"id":"String_String","certificate":{"id":"String","content":"String","description":"String","tags":["String"]},"authSteuernummer":"String","accountId":"String","password":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}]