Tax Filing Service
| Required role: | Admin | Required permission: | CanAccess |
| GET | /sync/accounts |
|---|
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';
/**
* The number of query results to skip.
*/
// @Api(Description="The number of query results to skip.")
abstract class PaginationBase implements IPaginate
{
/**
* The number of query results to skip.
*/
// @ApiMember(Description="The number of query results to skip.")
int? skip;
/**
* The number of query results to include.
*/
// @ApiMember(Description="The number of query results to include.")
int? take;
PaginationBase({this.skip,this.take});
PaginationBase.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
skip = json['skip'];
take = json['take'];
return this;
}
Map<String, dynamic> toJson() => {
'skip': skip,
'take': take
};
getTypeName() => "PaginationBase";
TypeContext? context = _ctx;
}
/**
* Specifies a service to retrieve all accounts.
*/
// @Api(Description="Specifies a service to retrieve all accounts.")
abstract class RetrieveAllAccountsBase extends PaginationBase implements IGet
{
/**
* Should the related products of the accounts be included in the retrieved results?
*/
// @ApiMember(Description="Should the related products of the accounts be included in the retrieved results?")
bool? includeProducts;
/**
* Should the related orders of the accounts be included in the retrieved results?
*/
// @ApiMember(Description="Should the related orders of the accounts be included in the retrieved results?")
bool? includeOrders;
/**
* Specifies the number of products to skip per account. Applicable only when 'IncludeProducts' is true.
*/
// @ApiMember(Description="Specifies the number of products to skip per account. Applicable only when 'IncludeProducts' is true. ")
int? skipProducts;
/**
* Specifies the number of products to include per account. Applicable only when 'IncludeProducts' is true.
*/
// @ApiMember(Description="Specifies the number of products to include per account. Applicable only when 'IncludeProducts' is true. ")
int? takeProducts;
/**
* Specifies the number of orders to skip per account. Applicable only when 'IncludeOrders' is true.
*/
// @ApiMember(Description="Specifies the number of orders to skip per account. Applicable only when 'IncludeOrders' is true. ")
int? skipOrders;
/**
* Specifies the number of orders to include per account. Applicable only when 'IncludeOrders' is true.
*/
// @ApiMember(Description="Specifies the number of orders to include per account. Applicable only when 'IncludeOrders' is true. ")
int? takeOrders;
RetrieveAllAccountsBase({this.includeProducts,this.includeOrders,this.skipProducts,this.takeProducts,this.skipOrders,this.takeOrders});
RetrieveAllAccountsBase.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
includeProducts = json['includeProducts'];
includeOrders = json['includeOrders'];
skipProducts = json['skipProducts'];
takeProducts = json['takeProducts'];
skipOrders = json['skipOrders'];
takeOrders = json['takeOrders'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'includeProducts': includeProducts,
'includeOrders': includeOrders,
'skipProducts': skipProducts,
'takeProducts': takeProducts,
'skipOrders': skipOrders,
'takeOrders': takeOrders
});
getTypeName() => "RetrieveAllAccountsBase";
TypeContext? context = _ctx;
}
/**
* Represents a user account.
*/
// @Api(Description="Represents a user account.")
class Account implements IHasUserName, IConvertible
{
/**
* The unique identifier of the user account.
*/
// @ApiMember(Description="The unique identifier of the user account.", IsRequired=true)
int? id;
/**
* The position of this instance in a collection of 'Account' instances
*/
// @ApiMember(Description="The position of this instance in a collection of 'Account' instances", IsRequired=true)
int? index;
/**
* The unique identifier of the customer associated with this account.
*/
// @ApiMember(Description="The unique identifier of the customer associated with this account.", IsRequired=true)
int? refId;
/**
* The string representation of the unique identifier of a reference that associates with this user account. This should have the same value as 'RefId'.
*/
// @ApiMember(Description="The string representation of the unique identifier of a reference that associates with this user account. This should have the same value as 'RefId'.")
String? refIdStr;
/**
* The unique user name of the user account.
*/
// @ApiMember(Description="The unique user name of the user account.", IsRequired=true)
String? userName;
/**
* The electronic mail address of the user account.
*/
// @ApiMember(Description="The electronic mail address of the user account.")
String? email;
/**
* The friendly name of the user account.
*/
// @ApiMember(Description="The friendly name of the user account.")
String? displayName;
/**
* The first name of the owner (natural person) of the user account.
*/
// @ApiMember(Description="The first name of the owner (natural person) of the user account.")
String? firstName;
/**
* The last name of the owner (natural person) of the user account.
*/
// @ApiMember(Description="The last name of the owner (natural person) of the user account.")
String? lastName;
/**
* The unique identifier of the customer associated with this account.
*/
// @ApiMember(Description="The unique identifier of the customer associated with this account.")
String? fullName;
/**
* The gender of the owner (natural person) of the user account.
*/
// @ApiMember(Description="The gender of the owner (natural person) of the user account.")
String? gender;
/**
* The language of the owner of teh user account.
*/
// @ApiMember(Description="The language of the owner of teh user account.")
String? language;
/**
* The company, where the user is an employee.
*/
// @ApiMember(Description="The company, where the user is an employee.")
String? company;
/**
* The profile URL of the user account.
*/
// @ApiMember(Description="The profile URL of the user account.", IsRequired=true)
String? profileUrl;
/**
* The roles assigned to the user account.
*/
// @ApiMember(Description="The roles assigned to the user account.")
List<String>? roles = [];
/**
* The permissions assigned to the user account.
*/
// @ApiMember(Description="The permissions assigned to the user account.")
List<String>? permissions = [];
/**
* The primary e-mail address of the user.
*/
// @ApiMember(Description="The primary e-mail address of the user.")
String? primaryEmail;
/**
* Random data to enhance the security of the user password.
*/
// @ApiMember(Description="Random data to enhance the security of the user password.")
String? salt;
/**
* The hash value of the user password that the PBKDF2 algorithm produces.
*/
// @ApiMember(Description="The hash value of the user password that the PBKDF2 algorithm produces.")
String? passwordHash;
/**
* The hash value of the user password that the DigestHa1 algorithm produces.
*/
// @ApiMember(Description="The hash value of the user password that the DigestHa1 algorithm produces.")
String? digestHa1Hash;
/**
* The number of times the user account tried to sign in but failed.
*/
// @ApiMember(Description="The number of times the user account tried to sign in but failed.")
int? invalidLoginAttempts;
/**
* The last time the user account attempted a sign in.
*/
// @ApiMember(Description="The last time the user account attempted a sign in.")
DateTime? lastLoginAttempt;
/**
* The date and time when the user acount was denied access.
*/
// @ApiMember(Description="The date and time when the user acount was denied access.")
DateTime? lockedDate;
/**
* The date and time when the user account was created.
*/
// @ApiMember(Description="The date and time when the user account was created.")
DateTime? createdDate;
/**
* The date and time when the user account was last modified.
*/
// @ApiMember(Description="The date and time when the user account was last modified.")
DateTime? modifiedDate;
/**
* The telephone number of the owner of the user account.
*/
// @ApiMember(Description="The telephone number of the owner of the user account.")
String? phoneNumber;
/**
* The birth date of the owner of the user account
*/
// @ApiMember(Description="The birth date of the owner of the user account")
DateTime? birthDate;
/**
* The string representation of the birth date of the user account.
*/
// @ApiMember(Description="The string representation of the birth date of the user account.")
String? birthDateRaw;
/**
* The mail address of the user account.
*/
// @ApiMember(Description="The mail address of the user account.")
String? address;
/**
* Additional information for the specified 'Address' of the user.
*/
// @ApiMember(Description="Additional information for the specified 'Address' of the user.")
String? address2;
/**
* The city of the owner of the user account.
*/
// @ApiMember(Description="The city of the owner of the user account.")
String? city;
/**
* The state of the owner of the user account.
*/
// @ApiMember(Description="The state of the owner of the user account.")
String? state;
/**
* The country of the owner of the user account. It is recommended to use the name of the associated 'Customer'.
*/
// @ApiMember(Description="The country of the owner of the user account. It is recommended to use the name of the associated 'Customer'.")
String? country;
/**
* The locale of the user account.
*/
// @ApiMember(Description="The locale of the user account.")
String? culture;
/**
* The mail address of the user account.
*/
// @ApiMember(Description="The mail address of the user account.")
String? mailAddress;
/**
* The nickname of the user of the user account.
*/
// @ApiMember(Description="The nickname of the user of the user account.")
String? nickname;
/**
* The postal code of the user account.
*/
// @ApiMember(Description="The postal code of the user account.")
String? postalCode;
/**
* The time zone of the user of the user account.
*/
// @ApiMember(Description="The time zone of the user of the user account.")
String? timeZone;
/**
* Additional information to attach to the user account.
*/
// @ApiMember(Description="Additional information to attach to the user account.")
Map<String,String?>? meta;
Account({this.id,this.index,this.refId,this.refIdStr,this.userName,this.email,this.displayName,this.firstName,this.lastName,this.fullName,this.gender,this.language,this.company,this.profileUrl,this.roles,this.permissions,this.primaryEmail,this.salt,this.passwordHash,this.digestHa1Hash,this.invalidLoginAttempts,this.lastLoginAttempt,this.lockedDate,this.createdDate,this.modifiedDate,this.phoneNumber,this.birthDate,this.birthDateRaw,this.address,this.address2,this.city,this.state,this.country,this.culture,this.mailAddress,this.nickname,this.postalCode,this.timeZone,this.meta});
Account.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
id = json['id'];
index = json['index'];
refId = json['refId'];
refIdStr = json['refIdStr'];
userName = json['userName'];
email = json['email'];
displayName = json['displayName'];
firstName = json['firstName'];
lastName = json['lastName'];
fullName = json['fullName'];
gender = json['gender'];
language = json['language'];
company = json['company'];
profileUrl = json['profileUrl'];
roles = JsonConverters.fromJson(json['roles'],'List<String>',context!);
permissions = JsonConverters.fromJson(json['permissions'],'List<String>',context!);
primaryEmail = json['primaryEmail'];
salt = json['salt'];
passwordHash = json['passwordHash'];
digestHa1Hash = json['digestHa1Hash'];
invalidLoginAttempts = json['invalidLoginAttempts'];
lastLoginAttempt = JsonConverters.fromJson(json['lastLoginAttempt'],'DateTime',context!);
lockedDate = JsonConverters.fromJson(json['lockedDate'],'DateTime',context!);
createdDate = JsonConverters.fromJson(json['createdDate'],'DateTime',context!);
modifiedDate = JsonConverters.fromJson(json['modifiedDate'],'DateTime',context!);
phoneNumber = json['phoneNumber'];
birthDate = JsonConverters.fromJson(json['birthDate'],'DateTime',context!);
birthDateRaw = json['birthDateRaw'];
address = json['address'];
address2 = json['address2'];
city = json['city'];
state = json['state'];
country = json['country'];
culture = json['culture'];
mailAddress = json['mailAddress'];
nickname = json['nickname'];
postalCode = json['postalCode'];
timeZone = json['timeZone'];
meta = JsonConverters.toStringMap(json['meta']);
return this;
}
Map<String, dynamic> toJson() => {
'id': id,
'index': index,
'refId': refId,
'refIdStr': refIdStr,
'userName': userName,
'email': email,
'displayName': displayName,
'firstName': firstName,
'lastName': lastName,
'fullName': fullName,
'gender': gender,
'language': language,
'company': company,
'profileUrl': profileUrl,
'roles': JsonConverters.toJson(roles,'List<String>',context!),
'permissions': JsonConverters.toJson(permissions,'List<String>',context!),
'primaryEmail': primaryEmail,
'salt': salt,
'passwordHash': passwordHash,
'digestHa1Hash': digestHa1Hash,
'invalidLoginAttempts': invalidLoginAttempts,
'lastLoginAttempt': JsonConverters.toJson(lastLoginAttempt,'DateTime',context!),
'lockedDate': JsonConverters.toJson(lockedDate,'DateTime',context!),
'createdDate': JsonConverters.toJson(createdDate,'DateTime',context!),
'modifiedDate': JsonConverters.toJson(modifiedDate,'DateTime',context!),
'phoneNumber': phoneNumber,
'birthDate': JsonConverters.toJson(birthDate,'DateTime',context!),
'birthDateRaw': birthDateRaw,
'address': address,
'address2': address2,
'city': city,
'state': state,
'country': country,
'culture': culture,
'mailAddress': mailAddress,
'nickname': nickname,
'postalCode': postalCode,
'timeZone': timeZone,
'meta': meta
};
getTypeName() => "Account";
TypeContext? context = _ctx;
}
/**
* Represents a query response that contains a structured error information and encapsulates user accounts.
*/
// @Api(Description="Represents a query response that contains a structured error information and encapsulates user accounts.")
class AccountQueryResponse extends QueryResponse<Account> implements IConvertible
{
/**
* The dictionary of products associated to found user accounts.
*/
// @ApiMember(Description="The dictionary of products associated to found user accounts.")
Map<int,List<Product>?>? productsMap = {};
/**
* The dictionary of orders associated with each found user account.
*/
// @ApiMember(Description="The dictionary of orders associated with each found user account.")
Map<int,List<Order>?>? ordersMap = {};
AccountQueryResponse({this.productsMap,this.ordersMap});
AccountQueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
productsMap = JsonConverters.fromJson(json['productsMap'],'Map<int,List<Product>?>',context!);
ordersMap = JsonConverters.fromJson(json['ordersMap'],'Map<int,List<Order>?>',context!);
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'productsMap': JsonConverters.toJson(productsMap,'Map<int,List<Product>?>',context!),
'ordersMap': JsonConverters.toJson(ordersMap,'Map<int,List<Order>?>',context!)
});
getTypeName() => "AccountQueryResponse";
TypeContext? context = _ctx;
}
/**
* Represents a service request to retrieve all accounts.
*/
// @Api(Description="Represents a service request to retrieve all accounts.")
class RetrieveAllAccounts extends RetrieveAllAccountsBase implements IConvertible
{
RetrieveAllAccounts();
RetrieveAllAccounts.fromJson(Map<String, dynamic> json) : super.fromJson(json);
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
return this;
}
Map<String, dynamic> toJson() => super.toJson();
getTypeName() => "RetrieveAllAccounts";
TypeContext? context = _ctx;
}
// @DataContract
class QueryResponse<T> implements IConvertible
{
// @DataMember(Order=1)
int? offset;
// @DataMember(Order=2)
int? total;
// @DataMember(Order=3)
List<T>? results;
// @DataMember(Order=4)
Map<String,String?>? meta;
// @DataMember(Order=5)
ResponseStatus? responseStatus;
QueryResponse({this.offset,this.total,this.results,this.meta,this.responseStatus});
QueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
offset = json['offset'];
total = json['total'];
results = JsonConverters.fromJson(json['results'],'List<${runtimeGenericTypeDefs(this,[0]).join(",")}>',context!);
meta = JsonConverters.toStringMap(json['meta']);
responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
return this;
}
Map<String, dynamic> toJson() => {
'offset': offset,
'total': total,
'results': JsonConverters.toJson(results,'List<T>',context!),
'meta': meta,
'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
};
getTypeName() => "QueryResponse<$T>";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'taxfiling.pwc.de', types: <String, TypeInfo> {
'PaginationBase': TypeInfo(TypeOf.AbstractClass),
'RetrieveAllAccountsBase': TypeInfo(TypeOf.AbstractClass),
'Account': TypeInfo(TypeOf.Class, create:() => Account()),
'AccountQueryResponse': TypeInfo(TypeOf.Class, create:() => AccountQueryResponse()),
'Map<int,List<Product>?>': TypeInfo(TypeOf.Class, create:() => Map<int,List<Product>?>()),
'List<Product>': TypeInfo(TypeOf.Class, create:() => <Product>[]),
'Product': TypeInfo(TypeOf.Class, create:() => Product()),
'Map<int,List<Order>?>': TypeInfo(TypeOf.Class, create:() => Map<int,List<Order>?>()),
'List<Order>': TypeInfo(TypeOf.Class, create:() => <Order>[]),
'Order': TypeInfo(TypeOf.Class, create:() => Order()),
'RetrieveAllAccounts': TypeInfo(TypeOf.Class, create:() => RetrieveAllAccounts()),
});
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.
GET /sync/accounts HTTP/1.1 Host: taxfiling.pwc.de Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
productsMap:
{
0:
[
{
id: 0,
index: 0,
name: String,
version: String,
description: String,
tags:
[
String
]
}
]
},
ordersMap:
{
0:
[
{
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
}
]
},
offset: 0,
total: 0,
results:
[
{
id: 0,
index: 0,
refId: 0,
refIdStr: String,
userName: String,
email: String,
displayName: String,
firstName: String,
lastName: String,
fullName: String,
gender: String,
language: String,
company: String,
profileUrl: String,
roles:
[
String
],
permissions:
[
String
],
primaryEmail: String,
salt: String,
passwordHash: String,
digestHa1Hash: String,
invalidLoginAttempts: 0,
lastLoginAttempt: 0001-01-01,
lockedDate: 0001-01-01,
createdDate: 0001-01-01,
modifiedDate: 0001-01-01,
phoneNumber: String,
birthDate: 0001-01-01,
birthDateRaw: String,
address: String,
address2: String,
city: String,
state: String,
country: String,
culture: String,
mailAddress: String,
nickname: String,
postalCode: String,
timeZone: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
},
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}