Tax Filing Service

<back to all web services

RetrieveProductAsync

RetrieveProductsAsync

Represents a service request to retrieve a product in an asynchronous operation.

Requires Authentication
Required role:AdminRequired permission:CanAccess
The following routes are available for this service:
GET/async/products/{Id}

/** @description Specifies a service request to retrieve a product. */
// @Api(Description="Specifies a service request to retrieve a product.")
export class RetrieveProductBase implements IGet
{
    /** @description The unique identifier of the product. */
    // @ApiMember(Description="The unique identifier of the product.", Name="Id")
    public id: number;

    /** @description Should the related orders of the account be included in the retrieved product? */
    // @ApiMember(Description="Should the related orders of the account be included in the retrieved product?")
    public includeOrders?: boolean;

    /** @description Specifies the number of orders to skip. Applicable only when 'IncludeOrders' is true.  */
    // @ApiMember(Description="Specifies the number of orders to skip. Applicable only when 'IncludeOrders' is true. ")
    public skipOrders?: number;

    /** @description Specifies the number of orders to include. Applicable only when 'IncludeOrders' is true.  */
    // @ApiMember(Description="Specifies the number of orders to include. Applicable only when 'IncludeOrders' is true. ")
    public takeOrders?: number;

    public constructor(init?: Partial<RetrieveProductBase>) { (Object as any).assign(this, init); }
}

/** @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.")
export class ServiceResponseBase
{
    /** @description Data structure that holds error information from a service operation. */
    // @ApiMember(Description="Data structure that holds error information from a service operation.")
    public responseStatus?: ResponseStatus;

    public constructor(init?: Partial<ServiceResponseBase>) { (Object as any).assign(this, init); }
}

/** @description Represents a product. */
// @Api(Description="Represents a product.")
export class Product implements IHasName
{
    /** @description The unique identifier of the product. */
    // @ApiMember(Description="The unique identifier of the product.", IsRequired=true)
    public id: number;

    /** @description The position of this instance in a collection of 'Product' instances */
    // @ApiMember(Description="The position of this instance in a collection of 'Product' instances", IsRequired=true)
    public index: number;

    /** @description The name of the product. */
    // @ApiMember(Description="The name of the product.", IsRequired=true)
    // @Validate(Validator="NotEmpty")
    public name: string;

    /** @description The version of the product. */
    // @ApiMember(Description="The version of the product.", IsRequired=true)
    // @Validate(Validator="NotEmpty")
    public version: string;

    /** @description The version of the product. */
    // @ApiMember(Description="The version of the product.")
    public description?: string;

    /** @description Tags associated with the product. */
    // @ApiMember(Description="Tags associated with the product.")
    public tags: string[];

    public constructor(init?: Partial<Product>) { (Object as any).assign(this, init); }
}

/** @description Represents a commission to consume services. */
// @Api(Description="Represents a commission to consume services.")
export class Order implements IHasName
{
    /** @description The unique identifier of the order. */
    // @ApiMember(Description="The unique identifier of the order.", IsRequired=true)
    public id: number;

    /** @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)
    public productId: number;

    /** @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)
    public accountId: number;

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

    /** @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.")
    public serviceName?: string;

    /** @description The time stamp at which the order was initiated. */
    // @ApiMember(Description="The time stamp at which the order was initiated.")
    public requestTimestamp?: string;

    /** @description The time stamp at which the order was completed. */
    // @ApiMember(Description="The time stamp at which the order was completed.")
    public responseTimestamp?: string;

    /** @description The URI from which the order was initiated. */
    // @ApiMember(Description="The URI from which the order was initiated.")
    public requestUri?: string;

    /** @description The HTTP method of the order request. */
    // @ApiMember(Description="The HTTP method of the order request.")
    public requestHttpMethod?: string;

    /** @description The duration of the order request. */
    // @ApiMember(Description="The duration of the order request.")
    public requestDuration?: string;

    /** @description The HTTP status code of the order request. */
    // @ApiMember(Description="The HTTP status code of the order request.")
    public responseStatusCode: HttpStatusCode;

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

    /** @description The unit of measurement for the order. */
    // @ApiMember(Description="The unit of measurement for the order.")
    public unitOfMeasurement?: string;

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

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

    /** @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.")
    public dataName?: string;

    /** @description The date of creation of the order. */
    // @ApiMember(Description="The date of creation of the order.")
    public creationDate: string;

    /** @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.")
    public expiryDate?: string;

    /** @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.")
    public isTest: boolean;

    public constructor(init?: Partial<Order>) { (Object as any).assign(this, init); }
}

/** @description Represents a service response that encapsulates product data. */
// @Api(Description="Represents a service response that encapsulates product data.")
export class ProductResponse extends ServiceResponseBase
{
    /** @description The product data of the response. */
    // @ApiMember(Description="The product data of the response.")
    public product?: Product;

    /** @description The list of orders associated with the encapsulated product. */
    // @ApiMember(Description="The list of orders associated with the encapsulated product.")
    public orders: Order[];

    /** @description Data structure that holds error information from a service operation. */
    // @ApiMember(Description="Data structure that holds error information from a service operation.")
    public responseStatus?: ResponseStatus;

    public constructor(init?: Partial<ProductResponse>) { super(init); (Object as any).assign(this, init); }
}

/** @description Represents a service request to retrieve a product in an asynchronous operation. */
// @Api(Description="Represents a service request to retrieve a product in an asynchronous operation.")
export class RetrieveProductAsync extends RetrieveProductBase
{
    /** @description The unique identifier of the product. */
    // @ApiMember(Description="The unique identifier of the product.", Name="Id")
    public id: number;

    /** @description Should the related orders of the account be included in the retrieved product? */
    // @ApiMember(Description="Should the related orders of the account be included in the retrieved product?")
    public includeOrders?: boolean;

    /** @description Specifies the number of orders to skip. Applicable only when 'IncludeOrders' is true.  */
    // @ApiMember(Description="Specifies the number of orders to skip. Applicable only when 'IncludeOrders' is true. ")
    public skipOrders?: number;

    /** @description Specifies the number of orders to include. Applicable only when 'IncludeOrders' is true.  */
    // @ApiMember(Description="Specifies the number of orders to include. Applicable only when 'IncludeOrders' is true. ")
    public takeOrders?: number;

    public constructor(init?: Partial<RetrieveProductAsync>) { super(init); (Object as any).assign(this, init); }
}

TypeScript RetrieveProductAsync DTOs

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

HTTP + OTHER

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

GET /async/products/{Id} HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: text/jsonl

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

{"product":{"id":0,"index":0,"name":"String","version":"String","description":"String","tags":["String"]},"orders":[{"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.