Tax Filing Service
| Required role: | Admin | Required permissions: | CanAccess, CanAdd |
| POST | /sync/products/batch |
|---|
import Foundation
import ServiceStack
/**
* Represents a service request to register one or more products in a batch operation.
*/
// @Api(Description="Represents a service request to register one or more products in a batch operation.")
public class BatchRegisterProducts : BatchRegisterProductsBase
{
/**
* The products to register.
*/
// @ApiMember(Description="The products to register.", IsRequired=true)
public var products:[Product] = []
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case products
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
products = try container.decodeIfPresent([Product].self, forKey: .products) ?? []
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if products.count > 0 { try container.encode(products, forKey: .products) }
}
}
/**
* Specifies a base service request to register one or more products in a batch operation.
*/
// @Api(Description="Specifies a base service request to register one or more products in a batch operation.")
public class BatchRegisterProductsBase : IPost, Codable
{
/**
* The products to register.
*/
// @ApiMember(Description="The products to register.", IsRequired=true)
public var products:[Product] = []
required public init(){}
}
/**
* Represents a product.
*/
// @Api(Description="Represents a product.")
public class Product : IHasName, Codable
{
/**
* The unique identifier of the product.
*/
// @ApiMember(Description="The unique identifier of the product.", IsRequired=true)
public var id:Int
/**
* 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 var index:Int
/**
* The name of the product.
*/
// @ApiMember(Description="The name of the product.", IsRequired=true)
// @Validate(Validator="NotEmpty")
public var name:String
/**
* The version of the product.
*/
// @ApiMember(Description="The version of the product.", IsRequired=true)
// @Validate(Validator="NotEmpty")
public var version:String
/**
* The version of the product.
*/
// @ApiMember(Description="The version of the product.")
public var Description:String
/**
* Tags associated with the product.
*/
// @ApiMember(Description="Tags associated with the product.")
public var tags:[String] = []
required public init(){}
}
Swift BatchRegisterProducts DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /sync/products/batch HTTP/1.1
Host: taxfiling.pwc.de
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
products:
[
{
id: 0,
index: 0,
name: String,
version: String,
description: String,
tags:
[
String
]
}
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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: 0001-01-01,
responseTimestamp: 0001-01-01,
requestUri: String,
requestHttpMethod: String,
requestDuration: PT0S,
responseStatusCode: Continue,
clientIPAddress: String,
unitOfMeasurement: String,
processType: String,
dataType: String,
dataName: String,
creationDate: 0001-01-01,
expiryDate: 0001-01-01,
isTest: False
}
],
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}
]