Tax Filing Service

RetrieveProduct

RetrieveProductsSync

Represents a service request to retrieve a product.

**Requires Authentication**
Required role:	Admin	Required permission:	CanAccess

The following routes are available for this service:
GET	/sync/products/{Id}

import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* Represents a service request to retrieve a product.
*/
@Api(Description="Represents a service request to retrieve a product.")
open class RetrieveProduct : RetrieveProductBase()
{
    /**
    * The unique identifier of the product.
    */
    @ApiMember(Description="The unique identifier of the product.", Name="Id")
    var id:Int? = null

    /**
    * 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?")
    var includeOrders:Boolean? = null

    /**
    * 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. ")
    var skipOrders:Int? = null

    /**
    * 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. ")
    var takeOrders:Int? = null
}

/**
* Specifies a service request to retrieve a product.
*/
@Api(Description="Specifies a service request to retrieve a product.")
open class RetrieveProductBase : IGet
{
    /**
    * The unique identifier of the product.
    */
    @ApiMember(Description="The unique identifier of the product.", Name="Id")
    var id:Int? = null

    /**
    * 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?")
    var includeOrders:Boolean? = null

    /**
    * 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. ")
    var skipOrders:Int? = null

    /**
    * 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. ")
    var takeOrders:Int? = null
}

/**
* Represents a service response that encapsulates product data.
*/
@Api(Description="Represents a service response that encapsulates product data.")
open class ProductResponse : ServiceResponseBase()
{
    /**
    * The product data of the response.
    */
    @ApiMember(Description="The product data of the response.")
    var product:Product? = null

    /**
    * The list of orders associated with the encapsulated product.
    */
    @ApiMember(Description="The list of orders associated with the encapsulated product.")
    var orders:ArrayList<Order> = ArrayList<Order>()

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

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

/**
* Represents a product.
*/
@Api(Description="Represents a product.")
open class Product : IHasName
{
    /**
    * The unique identifier of the product.
    */
    @ApiMember(Description="The unique identifier of the product.", IsRequired=true)
    var id:Int? = null

    /**
    * 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)
    var index:Int? = null

    /**
    * The name of the product.
    */
    @ApiMember(Description="The name of the product.", IsRequired=true)
    @Validate(Validator="NotEmpty")
    var name:String? = null

    /**
    * The version of the product.
    */
    @ApiMember(Description="The version of the product.", IsRequired=true)
    @Validate(Validator="NotEmpty")
    var version:String? = null

    /**
    * The version of the product.
    */
    @ApiMember(Description="The version of the product.")
    var description:String? = null

    /**
    * Tags associated with the product.
    */
    @ApiMember(Description="Tags associated with the product.")
    var tags:ArrayList<String> = ArrayList<String>()
}

/**
* Represents a commission to consume services.
*/
@Api(Description="Represents a commission to consume services.")
open class Order : IHasName
{
    /**
    * The unique identifier of the order.
    */
    @ApiMember(Description="The unique identifier of the order.", IsRequired=true)
    var id:Int? = null

    /**
    * 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 productId:Int? = null

    /**
    * 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 accountId:Int? = null

    /**
    * A name to identify the order.
    */
    @ApiMember(Description="A name to identify the order.", IsRequired=true)
    @Validate(Validator="NotEmpty")
    var name:String? = null

    /**
    * 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 serviceName:String? = null

    /**
    * The time stamp at which the order was initiated.
    */
    @ApiMember(Description="The time stamp at which the order was initiated.")
    var requestTimestamp:Date? = null

    /**
    * The time stamp at which the order was completed.
    */
    @ApiMember(Description="The time stamp at which the order was completed.")
    var responseTimestamp:Date? = null

    /**
    * The URI from which the order was initiated.
    */
    @ApiMember(Description="The URI from which the order was initiated.")
    var requestUri:String? = null

    /**
    * The HTTP method of the order request.
    */
    @ApiMember(Description="The HTTP method of the order request.")
    var requestHttpMethod:String? = null

    /**
    * The duration of the order request.
    */
    @ApiMember(Description="The duration of the order request.")
    var requestDuration:TimeSpan? = null

    /**
    * The HTTP status code of the order request.
    */
    @ApiMember(Description="The HTTP status code of the order request.")
    var responseStatusCode:HttpStatusCode? = null

    /**
    * The IP address of client, who placed the order.
    */
    @ApiMember(Description="The IP address of client, who placed the order.")
    var clientIPAddress:String? = null

    /**
    * The unit of measurement for the order.
    */
    @ApiMember(Description="The unit of measurement for the order.")
    var unitOfMeasurement:String? = null

    /**
    * The type of process, for which the order is charged.
    */
    @ApiMember(Description="The type of process, for which the order is charged.")
    var processType:String? = null

    /**
    * The type of data, for which the order is charged.
    */
    @ApiMember(Description="The type of data, for which the order is charged.")
    var dataType:String? = null

    /**
    * 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 dataName:String? = null

    /**
    * The date of creation of the order.
    */
    @ApiMember(Description="The date of creation of the order.")
    var creationDate:Date? = null

    /**
    * 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 expiryDate:Date? = null

    /**
    * 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 isTest:Boolean? = null
}

Kotlin RetrieveProduct DTOs

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

HTTP + CSV

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

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

HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}