Tax Filing Service

<back to all web services

UpdateProductAsync

UpdateProductsAsync

Represents a service request to update product data in an asynchronous operation.

Requires Authentication
Required role:AdminRequired permissions:CanAccess, CanEdit
The following routes are available for this service:
PUT/async/products/{Id}

/** @description Specifies a service request to update product data. */
// @Api(Description="Specifies a service request to update product data.")
export class UpdateProductBase implements IPut
{
    /** @description The unique identifier of the product. */
    // @ApiMember(Description="The unique identifier of the product.")
    public id: number;

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

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

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

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

    public constructor(init?: Partial<UpdateProductBase>) { (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 update product data in an asynchronous operation. */
// @Api(Description="Represents a service request to update product data in an asynchronous operation.")
export class UpdateProductAsync extends UpdateProductBase
{
    /** @description The unique identifier of the product. */
    // @ApiMember(Description="The unique identifier of the product.")
    public id: number;

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

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

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

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

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

TypeScript UpdateProductAsync DTOs

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

HTTP + XML

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

PUT /async/products/{Id} HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateProductAsync xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Services.Contracts.Requests">
  <Description>String</Description>
  <Id>0</Id>
  <Name>String</Name>
  <Tags xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Tags>
  <Version>String</Version>
</UpdateProductAsync>

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

<ProductResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Services.Contracts.Responses">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Orders xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Domain.Concretes.Models">
    <d2p1:Order>
      <d2p1:AccountId>0</d2p1:AccountId>
      <d2p1:ClientIPAddress>String</d2p1:ClientIPAddress>
      <d2p1:CreationDate>0001-01-01T00:00:00</d2p1:CreationDate>
      <d2p1:DataName>String</d2p1:DataName>
      <d2p1:DataType>String</d2p1:DataType>
      <d2p1:ExpiryDate>0001-01-01T00:00:00</d2p1:ExpiryDate>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:IsTest>false</d2p1:IsTest>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:ProcessType>String</d2p1:ProcessType>
      <d2p1:ProductId>0</d2p1:ProductId>
      <d2p1:RequestDuration>PT0S</d2p1:RequestDuration>
      <d2p1:RequestHttpMethod>String</d2p1:RequestHttpMethod>
      <d2p1:RequestTimestamp>0001-01-01T00:00:00</d2p1:RequestTimestamp>
      <d2p1:RequestUri>String</d2p1:RequestUri>
      <d2p1:ResponseStatusCode>Continue</d2p1:ResponseStatusCode>
      <d2p1:ResponseTimestamp>0001-01-01T00:00:00</d2p1:ResponseTimestamp>
      <d2p1:ServiceName>String</d2p1:ServiceName>
      <d2p1:UnitOfMeasurement>String</d2p1:UnitOfMeasurement>
    </d2p1:Order>
  </Orders>
  <Product xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Domain.Concretes.Models">
    <d2p1:Description>String</d2p1:Description>
    <d2p1:Id>0</d2p1:Id>
    <d2p1:Index>0</d2p1:Index>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:Tags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:Tags>
    <d2p1:Version>String</d2p1:Version>
  </Product>
</ProductResponse>
© 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.