Tax Filing Service

<back to all web services

UpdateProduct

UpdateProductsSync

Represents a service request to update product data.

Requires Authentication
Required role:AdminRequired permissions:CanAccess, CanEdit
The following routes are available for this service:
PUT/sync/products/{Id}
"use strict";
export class UpdateProductBase {
    /** @param {{id?:number,name?:string,description?:string,version?:string,tags?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The unique identifier of the product. */
    id;
    /**
     * @type {?string}
     * @description The name of the product. */
    name;
    /**
     * @type {?string}
     * @description The description of the product. */
    description;
    /**
     * @type {?string}
     * @description The version of the product. */
    version;
    /**
     * @type {string[]}
     * @description Tags associated with the product. */
    tags;
}
export class ServiceResponseBase {
    /** @param {{responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?ResponseStatus}
     * @description Data structure that holds error information from a service operation. */
    responseStatus;
}
export class Product {
    /** @param {{id?:number,index?:number,name?:string,version?:string,description?:string,tags?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The unique identifier of the product. */
    id;
    /**
     * @type {number}
     * @description The position of this instance in a collection of 'Product' instances */
    index;
    /**
     * @type {string}
     * @description The name of the product. */
    name;
    /**
     * @type {string}
     * @description The version of the product. */
    version;
    /**
     * @type {?string}
     * @description The version of the product. */
    description;
    /**
     * @type {string[]}
     * @description Tags associated with the product. */
    tags;
}
export class Order {
    /** @param {{id?:number,productId?:number,accountId?:number,name?:string,serviceName?:string,requestTimestamp?:string,responseTimestamp?:string,requestUri?:string,requestHttpMethod?:string,requestDuration?:string,responseStatusCode?:HttpStatusCode,clientIPAddress?:string,unitOfMeasurement?:string,processType?:string,dataType?:string,dataName?:string,creationDate?:string,expiryDate?:string,isTest?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The unique identifier of the order. */
    id;
    /**
     * @type {number}
     * @description The unique identifier of the product, for which the order is made. */
    productId;
    /**
     * @type {number}
     * @description The unique identifier of the user account, who placed the order. */
    accountId;
    /**
     * @type {string}
     * @description A name to identify the order. */
    name;
    /**
     * @type {?string}
     * @description The name of the service, for which the order was made. */
    serviceName;
    /**
     * @type {?string}
     * @description The time stamp at which the order was initiated. */
    requestTimestamp;
    /**
     * @type {?string}
     * @description The time stamp at which the order was completed. */
    responseTimestamp;
    /**
     * @type {?string}
     * @description The URI from which the order was initiated. */
    requestUri;
    /**
     * @type {?string}
     * @description The HTTP method of the order request. */
    requestHttpMethod;
    /**
     * @type {?string}
     * @description The duration of the order request. */
    requestDuration;
    /**
     * @type {HttpStatusCode}
     * @description The HTTP status code of the order request. */
    responseStatusCode;
    /**
     * @type {?string}
     * @description The IP address of client, who placed the order. */
    clientIPAddress;
    /**
     * @type {?string}
     * @description The unit of measurement for the order. */
    unitOfMeasurement;
    /**
     * @type {?string}
     * @description The type of process, for which the order is charged. */
    processType;
    /**
     * @type {?string}
     * @description The type of data, for which the order is charged. */
    dataType;
    /**
     * @type {?string}
     * @description The name of the data, for which the order is charged. */
    dataName;
    /**
     * @type {string}
     * @description The date of creation of the order. */
    creationDate;
    /**
     * @type {?string}
     * @description The final date to retain the order in the records. After this date, the order is expunged from the records. */
    expiryDate;
    /**
     * @type {boolean}
     * @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. */
    isTest;
}
export class ProductResponse extends ServiceResponseBase {
    /** @param {{product?:Product,orders?:Order[],responseStatus?:ResponseStatus,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {?Product}
     * @description The product data of the response. */
    product;
    /**
     * @type {Order[]}
     * @description The list of orders associated with the encapsulated product. */
    orders;
    /**
     * @type {?ResponseStatus}
     * @description Data structure that holds error information from a service operation. */
    responseStatus;
}
export class UpdateProduct extends UpdateProductBase {
    /** @param {{id?:number,name?:string,description?:string,version?:string,tags?:string[],id?:number,name?:string,description?:string,version?:string,tags?:string[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {number}
     * @description The unique identifier of the product. */
    id;
    /**
     * @type {?string}
     * @description The name of the product. */
    name;
    /**
     * @type {?string}
     * @description The description of the product. */
    description;
    /**
     * @type {?string}
     * @description The version of the product. */
    version;
    /**
     * @type {string[]}
     * @description Tags associated with the product. */
    tags;
}

JavaScript UpdateProduct 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 /sync/products/{Id} HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateProduct 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>
</UpdateProduct>
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>