Tax Filing Service

<back to all web services

BatchRegisterProductsAsync

RegisterProductsBatchAsync

Represents a service request to register one or more products in a batch operation.

Requires Authentication
Required role:AdminRequired permissions:CanAccess, CanAdd
The following routes are available for this service:
POST/async/products/batch
namespace PwC.Metering.Core.Domain.Concretes.Models

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    ///<summary>
    ///Represents a product.
    ///</summary>
    [<Api(Description="Represents a product.")>]
    [<AllowNullLiteral>]
    type Product() = 
        ///<summary>
        ///The unique identifier of the product.
        ///</summary>
        [<ApiMember(Description="The unique identifier of the product.", IsRequired=true)>]
        member val Id:Int32 = new Int32() with get,set

        ///<summary>
        ///The position of this instance in a collection of 'Product' instances
        ///</summary>
        [<ApiMember(Description="The position of this instance in a collection of 'Product' instances", IsRequired=true)>]
        member val Index:Int32 = new Int32() with get,set

        ///<summary>
        ///The name of the product.
        ///</summary>
        [<ApiMember(Description="The name of the product.", IsRequired=true)>]
        [<Validate(Validator="NotEmpty")>]
        member val Name:String = null with get,set

        ///<summary>
        ///The version of the product.
        ///</summary>
        [<ApiMember(Description="The version of the product.", IsRequired=true)>]
        [<Validate(Validator="NotEmpty")>]
        member val Version:String = null with get,set

        ///<summary>
        ///The version of the product.
        ///</summary>
        [<ApiMember(Description="The version of the product.")>]
        member val Description:String = null with get,set

        ///<summary>
        ///Tags associated with the product.
        ///</summary>
        [<ApiMember(Description="Tags associated with the product.")>]
        member val Tags:ResizeArray<String> = new ResizeArray<String>() with get,set

    ///<summary>
    ///Specifies a base service request to register one or more products in a batch operation.
    ///</summary>
    [<Api(Description="Specifies a base service request to register one or more products in a batch operation.")>]
    [<AllowNullLiteral>]
    type BatchRegisterProductsBase() = 
        interface IPost
        ///<summary>
        ///The products to register.
        ///</summary>
        [<ApiMember(Description="The products to register.", IsRequired=true)>]
        member val Products:ResizeArray<Product> = new ResizeArray<Product>() with get,set

    ///<summary>
    ///Represents a service request to register one or more products in a batch operation.
    ///</summary>
    [<Api(Description="Represents a service request to register one or more products in a batch operation.")>]
    [<AllowNullLiteral>]
    type BatchRegisterProductsAsync() = 
        inherit BatchRegisterProductsBase()
        ///<summary>
        ///The products to register.
        ///</summary>
        [<ApiMember(Description="The products to register.", IsRequired=true)>]
        member val Products:ResizeArray<Product> = new ResizeArray<Product>() with get,set

F# BatchRegisterProductsAsync DTOs

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

HTTP + X-MSGPACK

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

POST /async/products/batch HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: application/x-msgpack
Content-Type: application/x-msgpack
Content-Length: length

{"products":[{"id":0,"index":0,"name":"String","version":"String","description":"String","tags":["String"]}]}
HTTP/1.1 200 OK
Content-Type: application/x-msgpack
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"}}}]