Tax Filing Service

<back to all web services

RevokeOrder

RevokeOrdersSync

Represents a service request to revoke an existing order.

Requires Authentication
Required role:AdminRequired permissions:CanAccess, CanDelete
The following routes are available for this service:
DELETE/sync/orders/{Id}
<?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 Specifies a base service to revoke an existing order. */
// @Api(Description="Specifies a base service to revoke an existing order.")
class RevokeOrderBase implements IDelete, JsonSerializable
{
    public function __construct(
        /** @description The unique identifier of the order. */
        // @ApiMember(Description="The unique identifier of the order.")
        /** @var int */
        public int $id=0
    ) {
    }

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

/** @description Specifies a base service response class that contains a structured error information. */
// @Api(Description="Specifies a base service response class that contains a structured error information.")
class ServiceResponseBase implements JsonSerializable
{
    public function __construct(
        /** @description Data structure that holds error information from a service operation. */
        // @ApiMember(Description="Data structure that holds error information from a service operation.")
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null
    ) {
    }

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

/** @description Represents a commission to consume services. */
// @Api(Description="Represents a commission to consume services.")
class Order implements IHasName, JsonSerializable
{
    public function __construct(
        /** @description The unique identifier of the order. */
        // @ApiMember(Description="The unique identifier of the order.", IsRequired=true)
        /** @var int */
        public int $id=0,

        /** @description The unique identifier of the product, for which the order is made. */
        // @ApiMember(Description="The unique identifier of the product, for which the order is made.", IsRequired=true)
        /** @var int */
        public int $productId=0,

        /** @description The unique identifier of the user account, who placed the order. */
        // @ApiMember(Description="The unique identifier of the user account, who placed the order.", IsRequired=true)
        /** @var int */
        public int $accountId=0,

        /** @description A name to identify the order. */
        // @ApiMember(Description="A name to identify the order.", IsRequired=true)
        // @Validate(Validator="NotEmpty")
        /** @var string */
        public string $name='',

        /** @description The name of the service, for which the order was made. */
        // @ApiMember(Description="The name of the service, for which the order was made.")
        /** @var string|null */
        public ?string $serviceName=null,

        /** @description The time stamp at which the order was initiated. */
        // @ApiMember(Description="The time stamp at which the order was initiated.")
        /** @var DateTime|null */
        public ?DateTime $requestTimestamp=null,

        /** @description The time stamp at which the order was completed. */
        // @ApiMember(Description="The time stamp at which the order was completed.")
        /** @var DateTime|null */
        public ?DateTime $responseTimestamp=null,

        /** @description The URI from which the order was initiated. */
        // @ApiMember(Description="The URI from which the order was initiated.")
        /** @var string|null */
        public ?string $requestUri=null,

        /** @description The HTTP method of the order request. */
        // @ApiMember(Description="The HTTP method of the order request.")
        /** @var string|null */
        public ?string $requestHttpMethod=null,

        /** @description The duration of the order request. */
        // @ApiMember(Description="The duration of the order request.")
        /** @var DateInterval|null */
        public ?DateInterval $requestDuration=null,

        /** @description The HTTP status code of the order request. */
        // @ApiMember(Description="The HTTP status code of the order request.")
        /** @var HttpStatusCode|null */
        public ?HttpStatusCode $responseStatusCode=null,

        /** @description The IP address of client, who placed the order. */
        // @ApiMember(Description="The IP address of client, who placed the order.")
        /** @var string|null */
        public ?string $clientIPAddress=null,

        /** @description The unit of measurement for the order. */
        // @ApiMember(Description="The unit of measurement for the order.")
        /** @var string|null */
        public ?string $unitOfMeasurement=null,

        /** @description The type of process, for which the order is charged. */
        // @ApiMember(Description="The type of process, for which the order is charged.")
        /** @var string|null */
        public ?string $processType=null,

        /** @description The type of data, for which the order is charged. */
        // @ApiMember(Description="The type of data, for which the order is charged.")
        /** @var string|null */
        public ?string $dataType=null,

        /** @description The name of the data, for which the order is charged. */
        // @ApiMember(Description="The name of the data, for which the order is charged.")
        /** @var string|null */
        public ?string $dataName=null,

        /** @description The date of creation of the order. */
        // @ApiMember(Description="The date of creation of the order.")
        /** @var DateTime */
        public DateTime $creationDate=new DateTime(),

        /** @description The final date to retain the order in the records. After this date, the order is expunged from the records. */
        // @ApiMember(Description="The final date to retain the order in the records. After this date, the order is expunged from the records.")
        /** @var DateTime|null */
        public ?DateTime $expiryDate=null,

        /** @description Indicates whether the order is simulated for test purposes. True if the order is simulated for test purposes; otherwise it is a false order for production purposes. */
        // @ApiMember(Description="Indicates whether the order is simulated for test purposes. True if the order is simulated for test purposes; otherwise it is a false order for production purposes.")
        /** @var bool|null */
        public ?bool $isTest=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['id'])) $this->id = $o['id'];
        if (isset($o['productId'])) $this->productId = $o['productId'];
        if (isset($o['accountId'])) $this->accountId = $o['accountId'];
        if (isset($o['name'])) $this->name = $o['name'];
        if (isset($o['serviceName'])) $this->serviceName = $o['serviceName'];
        if (isset($o['requestTimestamp'])) $this->requestTimestamp = JsonConverters::from('DateTime', $o['requestTimestamp']);
        if (isset($o['responseTimestamp'])) $this->responseTimestamp = JsonConverters::from('DateTime', $o['responseTimestamp']);
        if (isset($o['requestUri'])) $this->requestUri = $o['requestUri'];
        if (isset($o['requestHttpMethod'])) $this->requestHttpMethod = $o['requestHttpMethod'];
        if (isset($o['requestDuration'])) $this->requestDuration = JsonConverters::from('TimeSpan', $o['requestDuration']);
        if (isset($o['responseStatusCode'])) $this->responseStatusCode = JsonConverters::from('HttpStatusCode', $o['responseStatusCode']);
        if (isset($o['clientIPAddress'])) $this->clientIPAddress = $o['clientIPAddress'];
        if (isset($o['unitOfMeasurement'])) $this->unitOfMeasurement = $o['unitOfMeasurement'];
        if (isset($o['processType'])) $this->processType = $o['processType'];
        if (isset($o['dataType'])) $this->dataType = $o['dataType'];
        if (isset($o['dataName'])) $this->dataName = $o['dataName'];
        if (isset($o['creationDate'])) $this->creationDate = JsonConverters::from('DateTime', $o['creationDate']);
        if (isset($o['expiryDate'])) $this->expiryDate = JsonConverters::from('DateTime', $o['expiryDate']);
        if (isset($o['isTest'])) $this->isTest = $o['isTest'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->id)) $o['id'] = $this->id;
        if (isset($this->productId)) $o['productId'] = $this->productId;
        if (isset($this->accountId)) $o['accountId'] = $this->accountId;
        if (isset($this->name)) $o['name'] = $this->name;
        if (isset($this->serviceName)) $o['serviceName'] = $this->serviceName;
        if (isset($this->requestTimestamp)) $o['requestTimestamp'] = JsonConverters::to('DateTime', $this->requestTimestamp);
        if (isset($this->responseTimestamp)) $o['responseTimestamp'] = JsonConverters::to('DateTime', $this->responseTimestamp);
        if (isset($this->requestUri)) $o['requestUri'] = $this->requestUri;
        if (isset($this->requestHttpMethod)) $o['requestHttpMethod'] = $this->requestHttpMethod;
        if (isset($this->requestDuration)) $o['requestDuration'] = JsonConverters::to('TimeSpan', $this->requestDuration);
        if (isset($this->responseStatusCode)) $o['responseStatusCode'] = JsonConverters::to('HttpStatusCode', $this->responseStatusCode);
        if (isset($this->clientIPAddress)) $o['clientIPAddress'] = $this->clientIPAddress;
        if (isset($this->unitOfMeasurement)) $o['unitOfMeasurement'] = $this->unitOfMeasurement;
        if (isset($this->processType)) $o['processType'] = $this->processType;
        if (isset($this->dataType)) $o['dataType'] = $this->dataType;
        if (isset($this->dataName)) $o['dataName'] = $this->dataName;
        if (isset($this->creationDate)) $o['creationDate'] = JsonConverters::to('DateTime', $this->creationDate);
        if (isset($this->expiryDate)) $o['expiryDate'] = JsonConverters::to('DateTime', $this->expiryDate);
        if (isset($this->isTest)) $o['isTest'] = $this->isTest;
        return empty($o) ? new class(){} : $o;
    }
}

/** @description Represents a service response that encapsulates an order data. */
// @Api(Description="Represents a service response that encapsulates an order data.")
class OrderResponse extends ServiceResponseBase implements JsonSerializable
{
    /**
     * @param ResponseStatus|null $responseStatus
     */
    public function __construct(
        ?ResponseStatus $responseStatus=null,
        /** @description The order data of the response. */
        // @ApiMember(Description="The order data of the response.")
        /** @var Order|null */
        public ?Order $order=null
    ) {
        parent::__construct($responseStatus);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['order'])) $this->order = JsonConverters::from('Order', $o['order']);
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->order)) $o['order'] = JsonConverters::to('Order', $this->order);
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

/** @description Represents a service request to revoke an existing order. */
// @Api(Description="Represents a service request to revoke an existing order.")
class RevokeOrder extends RevokeOrderBase implements JsonSerializable
{
    /**
     * @param int $id
     */
    public function __construct(
        int $id=0
    ) {
        parent::__construct($id);
    }

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

PHP RevokeOrder DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

DELETE /sync/orders/{Id} HTTP/1.1 
Host: taxfiling.staging.pwc.de 
Accept: application/json

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

{"order":{"id":0,"productId":0,"accountId":0,"name":"String","serviceName":"String","requestTimestamp":"\/Date(-62135596800000-0000)\/","responseTimestamp":"\/Date(-62135596800000-0000)\/","requestUri":"String","requestHttpMethod":"String","requestDuration":"PT0S","responseStatusCode":"Continue","clientIPAddress":"String","unitOfMeasurement":"String","processType":"String","dataType":"String","dataName":"String","creationDate":"\/Date(-62135596800000-0000)\/","expiryDate":"\/Date(-62135596800000-0000)\/","isTest":false},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}
© 2021 - 2024 PwC. All rights reserved.
PwC refers to the PwC network and/or one or more of its member firms, each of which is a separate legal entity. Please see www.pwc.com/structure for further details. Any use of third party IP such as ELSTER is governed by the respective third party terms.