Tax Filing Service
| Required role: | Admin | Required permissions: | CanAccess, CanAdd |
| POST | /sync/products |
|---|
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';
/**
* Specifies a base service request to register a product.
*/
// @Api(Description="Specifies a base service request to register a product.")
abstract class RegisterProductBase implements IPost
{
/**
* The name of the product.
*/
// @ApiMember(Description="The name of the product.")
String? name;
/**
* The description of the product.
*/
// @ApiMember(Description="The description of the product.")
String? description;
/**
* The version of the product.
*/
// @ApiMember(Description="The version of the product.")
String? version;
/**
* Tags associated with the product.
*/
// @ApiMember(Description="Tags associated with the product.")
List<String>? tags;
RegisterProductBase({this.name,this.description,this.version,this.tags});
RegisterProductBase.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
name = json['name'];
description = json['description'];
version = json['version'];
tags = JsonConverters.fromJson(json['tags'],'List<String>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'name': name,
'description': description,
'version': version,
'tags': JsonConverters.toJson(tags,'List<String>',context!)
};
getTypeName() => "RegisterProductBase";
TypeContext? context = _ctx;
}
/**
* 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.")
abstract class ServiceResponseBase
{
/**
* Data structure that holds error information from a service operation.
*/
// @ApiMember(Description="Data structure that holds error information from a service operation.")
ResponseStatus? responseStatus;
ServiceResponseBase({this.responseStatus});
ServiceResponseBase.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
return this;
}
Map<String, dynamic> toJson() => {
'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
};
getTypeName() => "ServiceResponseBase";
TypeContext? context = _ctx;
}
/**
* Represents a product.
*/
// @Api(Description="Represents a product.")
class Product implements IHasName, IConvertible
{
/**
* The unique identifier of the product.
*/
// @ApiMember(Description="The unique identifier of the product.", IsRequired=true)
int? id;
/**
* 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)
int? index;
/**
* The name of the product.
*/
// @ApiMember(Description="The name of the product.", IsRequired=true)
// @Validate(Validator="NotEmpty")
String? name;
/**
* The version of the product.
*/
// @ApiMember(Description="The version of the product.", IsRequired=true)
// @Validate(Validator="NotEmpty")
String? version;
/**
* The version of the product.
*/
// @ApiMember(Description="The version of the product.")
String? description;
/**
* Tags associated with the product.
*/
// @ApiMember(Description="Tags associated with the product.")
List<String>? tags;
Product({this.id,this.index,this.name,this.version,this.description,this.tags});
Product.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
id = json['id'];
index = json['index'];
name = json['name'];
version = json['version'];
description = json['description'];
tags = JsonConverters.fromJson(json['tags'],'List<String>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'id': id,
'index': index,
'name': name,
'version': version,
'description': description,
'tags': JsonConverters.toJson(tags,'List<String>',context!)
};
getTypeName() => "Product";
TypeContext? context = _ctx;
}
/**
* Represents a commission to consume services.
*/
// @Api(Description="Represents a commission to consume services.")
class Order implements IHasName, IConvertible
{
/**
* The unique identifier of the order.
*/
// @ApiMember(Description="The unique identifier of the order.", IsRequired=true)
int? id;
/**
* 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)
int? productId;
/**
* 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)
int? accountId;
/**
* A name to identify the order.
*/
// @ApiMember(Description="A name to identify the order.", IsRequired=true)
// @Validate(Validator="NotEmpty")
String? name;
/**
* The name of the service, for which the order was made.
*/
// @ApiMember(Description="The name of the service, for which the order was made.")
String? serviceName;
/**
* The time stamp at which the order was initiated.
*/
// @ApiMember(Description="The time stamp at which the order was initiated.")
DateTime? requestTimestamp;
/**
* The time stamp at which the order was completed.
*/
// @ApiMember(Description="The time stamp at which the order was completed.")
DateTime? responseTimestamp;
/**
* The URI from which the order was initiated.
*/
// @ApiMember(Description="The URI from which the order was initiated.")
String? requestUri;
/**
* The HTTP method of the order request.
*/
// @ApiMember(Description="The HTTP method of the order request.")
String? requestHttpMethod;
/**
* The duration of the order request.
*/
// @ApiMember(Description="The duration of the order request.")
Duration? requestDuration;
/**
* The HTTP status code of the order request.
*/
// @ApiMember(Description="The HTTP status code of the order request.")
HttpStatusCode? responseStatusCode;
/**
* The IP address of client, who placed the order.
*/
// @ApiMember(Description="The IP address of client, who placed the order.")
String? clientIPAddress;
/**
* The unit of measurement for the order.
*/
// @ApiMember(Description="The unit of measurement for the order.")
String? unitOfMeasurement;
/**
* The type of process, for which the order is charged.
*/
// @ApiMember(Description="The type of process, for which the order is charged.")
String? processType;
/**
* The type of data, for which the order is charged.
*/
// @ApiMember(Description="The type of data, for which the order is charged.")
String? dataType;
/**
* The name of the data, for which the order is charged.
*/
// @ApiMember(Description="The name of the data, for which the order is charged.")
String? dataName;
/**
* The date of creation of the order.
*/
// @ApiMember(Description="The date of creation of the order.")
DateTime? creationDate;
/**
* 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.")
DateTime? expiryDate;
/**
* 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.")
bool? isTest;
Order({this.id,this.productId,this.accountId,this.name,this.serviceName,this.requestTimestamp,this.responseTimestamp,this.requestUri,this.requestHttpMethod,this.requestDuration,this.responseStatusCode,this.clientIPAddress,this.unitOfMeasurement,this.processType,this.dataType,this.dataName,this.creationDate,this.expiryDate,this.isTest});
Order.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
id = json['id'];
productId = json['productId'];
accountId = json['accountId'];
name = json['name'];
serviceName = json['serviceName'];
requestTimestamp = JsonConverters.fromJson(json['requestTimestamp'],'DateTime',context!);
responseTimestamp = JsonConverters.fromJson(json['responseTimestamp'],'DateTime',context!);
requestUri = json['requestUri'];
requestHttpMethod = json['requestHttpMethod'];
requestDuration = JsonConverters.fromJson(json['requestDuration'],'Duration',context!);
responseStatusCode = JsonConverters.fromJson(json['responseStatusCode'],'HttpStatusCode',context!);
clientIPAddress = json['clientIPAddress'];
unitOfMeasurement = json['unitOfMeasurement'];
processType = json['processType'];
dataType = json['dataType'];
dataName = json['dataName'];
creationDate = JsonConverters.fromJson(json['creationDate'],'DateTime',context!);
expiryDate = JsonConverters.fromJson(json['expiryDate'],'DateTime',context!);
isTest = json['isTest'];
return this;
}
Map<String, dynamic> toJson() => {
'id': id,
'productId': productId,
'accountId': accountId,
'name': name,
'serviceName': serviceName,
'requestTimestamp': JsonConverters.toJson(requestTimestamp,'DateTime',context!),
'responseTimestamp': JsonConverters.toJson(responseTimestamp,'DateTime',context!),
'requestUri': requestUri,
'requestHttpMethod': requestHttpMethod,
'requestDuration': JsonConverters.toJson(requestDuration,'Duration',context!),
'responseStatusCode': JsonConverters.toJson(responseStatusCode,'HttpStatusCode',context!),
'clientIPAddress': clientIPAddress,
'unitOfMeasurement': unitOfMeasurement,
'processType': processType,
'dataType': dataType,
'dataName': dataName,
'creationDate': JsonConverters.toJson(creationDate,'DateTime',context!),
'expiryDate': JsonConverters.toJson(expiryDate,'DateTime',context!),
'isTest': isTest
};
getTypeName() => "Order";
TypeContext? context = _ctx;
}
/**
* Represents a service response that encapsulates product data.
*/
// @Api(Description="Represents a service response that encapsulates product data.")
class ProductResponse extends ServiceResponseBase implements IConvertible
{
/**
* The product data of the response.
*/
// @ApiMember(Description="The product data of the response.")
Product? product;
/**
* The list of orders associated with the encapsulated product.
*/
// @ApiMember(Description="The list of orders associated with the encapsulated product.")
List<Order>? orders;
/**
* Data structure that holds error information from a service operation.
*/
// @ApiMember(Description="Data structure that holds error information from a service operation.")
ResponseStatus? responseStatus;
ProductResponse({this.product,this.orders,this.responseStatus});
ProductResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
product = JsonConverters.fromJson(json['product'],'Product',context!);
orders = JsonConverters.fromJson(json['orders'],'List<Order>',context!);
responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'product': JsonConverters.toJson(product,'Product',context!),
'orders': JsonConverters.toJson(orders,'List<Order>',context!),
'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
});
getTypeName() => "ProductResponse";
TypeContext? context = _ctx;
}
/**
* Represents a service request to register a product.
*/
// @Api(Description="Represents a service request to register a product.")
class RegisterProduct extends RegisterProductBase implements IConvertible
{
/**
* The name of the product.
*/
// @ApiMember(Description="The name of the product.")
String? name;
/**
* The description of the product.
*/
// @ApiMember(Description="The description of the product.")
String? description;
/**
* The version of the product.
*/
// @ApiMember(Description="The version of the product.")
String? version;
/**
* Tags associated with the product.
*/
// @ApiMember(Description="Tags associated with the product.")
List<String>? tags;
RegisterProduct({this.name,this.description,this.version,this.tags});
RegisterProduct.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
name = json['name'];
description = json['description'];
version = json['version'];
tags = JsonConverters.fromJson(json['tags'],'List<String>',context!);
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'name': name,
'description': description,
'version': version,
'tags': JsonConverters.toJson(tags,'List<String>',context!)
});
getTypeName() => "RegisterProduct";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'taxfiling.pwc.de', types: <String, TypeInfo> {
'RegisterProductBase': TypeInfo(TypeOf.AbstractClass),
'ServiceResponseBase': TypeInfo(TypeOf.AbstractClass),
'Product': TypeInfo(TypeOf.Class, create:() => Product()),
'Order': TypeInfo(TypeOf.Class, create:() => Order()),
'HttpStatusCode': TypeInfo(TypeOf.Class, create:() => HttpStatusCode()),
'ProductResponse': TypeInfo(TypeOf.Class, create:() => ProductResponse()),
'List<Order>': TypeInfo(TypeOf.Class, create:() => <Order>[]),
'RegisterProduct': TypeInfo(TypeOf.Class, create:() => RegisterProduct()),
});
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /sync/products HTTP/1.1
Host: taxfiling.pwc.de
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"name":"String","description":"String","version":"String","tags":["String"]}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}