Tax Filing Service
| Requires any of the roles: | AllowAnyUser, Admin | Required permissions: | CanAccess, CanEdit |
| PUT | /async/accounts/update |
|---|
import Foundation
import ServiceStack
/**
* Represents a service request to update account data in an asynchronous operation.
*/
// @Api(Description="Represents a service request to update account data in an asynchronous operation.")
public class UpdateAccountAsync : UpdateAccountBase
{
/**
* The user name of the user account.
*/
// @ApiMember(Description="The user name of the user account.")
public var userName:String
/**
* The friendly name of the user account.
*/
// @ApiMember(Description="The friendly name of the user account.")
public var displayName:String
/**
* The e-mail address of the user account.
*/
// @ApiMember(Description="The e-mail address of the user account.")
// @Validate(Validator="Email")
public var email:String
/**
* The profile URL of the user account.
*/
// @ApiMember(Description="The profile URL of the user account.")
public var profileUrl:String
/**
* Extra information for the user account.
*/
// @ApiMember(Description="Extra information for the user account.")
public var meta:[String:String] = [:]
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case userName
case displayName
case email
case profileUrl
case meta
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
userName = try container.decodeIfPresent(String.self, forKey: .userName)
displayName = try container.decodeIfPresent(String.self, forKey: .displayName)
email = try container.decodeIfPresent(String.self, forKey: .email)
profileUrl = try container.decodeIfPresent(String.self, forKey: .profileUrl)
meta = try container.decodeIfPresent([String:String].self, forKey: .meta) ?? [:]
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if userName != nil { try container.encode(userName, forKey: .userName) }
if displayName != nil { try container.encode(displayName, forKey: .displayName) }
if email != nil { try container.encode(email, forKey: .email) }
if profileUrl != nil { try container.encode(profileUrl, forKey: .profileUrl) }
if meta.count > 0 { try container.encode(meta, forKey: .meta) }
}
}
/**
* Specifies a service request to update account data.
*/
// @Api(Description="Specifies a service request to update account data.")
public class UpdateAccountBase : IPut, Codable
{
/**
* The user name of the user account.
*/
// @ApiMember(Description="The user name of the user account.")
public var userName:String
/**
* The friendly name of the user account.
*/
// @ApiMember(Description="The friendly name of the user account.")
public var displayName:String
/**
* The e-mail address of the user account.
*/
// @ApiMember(Description="The e-mail address of the user account.")
// @Validate(Validator="Email")
public var email:String
/**
* The profile URL of the user account.
*/
// @ApiMember(Description="The profile URL of the user account.")
public var profileUrl:String
/**
* Extra information for the user account.
*/
// @ApiMember(Description="Extra information for the user account.")
public var meta:[String:String] = [:]
required public init(){}
}
/**
* Represents a service response that contains a structured error information and encapsulates a user account.
*/
// @Api(Description="Represents a service response that contains a structured error information and encapsulates a user account.")
public class AccountResponse : ServiceResponseBase
{
/**
* The user account encapsulated in the response.
*/
// @ApiMember(Description="The user account encapsulated in the response.")
public var account:Account
/**
* The index position of the reponse in a collection, if it were returned together with other responses.
*/
// @ApiMember(Description="The index position of the reponse in a collection, if it were returned together with other responses.")
public var index:Int
/**
* The list of products associated with the encapsulated user account.
*/
// @ApiMember(Description="The list of products associated with the encapsulated user account.")
public var products:[Product] = []
/**
* The list of orders associated with the encapsulated user account.
*/
// @ApiMember(Description="The list of orders associated with the encapsulated user account.")
public var orders:[Order] = []
/**
* Data structure that holds error information from a service operation.
*/
// @ApiMember(Description="Data structure that holds error information from a service operation.")
public var responseStatus:ResponseStatus
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case account
case index
case products
case orders
case responseStatus
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
account = try container.decodeIfPresent(Account.self, forKey: .account)
index = try container.decodeIfPresent(Int.self, forKey: .index)
products = try container.decodeIfPresent([Product].self, forKey: .products) ?? []
orders = try container.decodeIfPresent([Order].self, forKey: .orders) ?? []
responseStatus = try container.decodeIfPresent(ResponseStatus.self, forKey: .responseStatus)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if account != nil { try container.encode(account, forKey: .account) }
if index != nil { try container.encode(index, forKey: .index) }
if products.count > 0 { try container.encode(products, forKey: .products) }
if orders.count > 0 { try container.encode(orders, forKey: .orders) }
if responseStatus != nil { try container.encode(responseStatus, forKey: .responseStatus) }
}
}
/**
* 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.")
public class ServiceResponseBase : Codable
{
/**
* Data structure that holds error information from a service operation.
*/
// @ApiMember(Description="Data structure that holds error information from a service operation.")
public var responseStatus:ResponseStatus
required public init(){}
}
/**
* Represents a user account.
*/
// @Api(Description="Represents a user account.")
public class Account : IHasUserName, Codable
{
/**
* The unique identifier of the user account.
*/
// @ApiMember(Description="The unique identifier of the user account.", IsRequired=true)
public var id:Int
/**
* 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)
public var index:Int
/**
* The unique identifier of the customer associated with this account.
*/
// @ApiMember(Description="The unique identifier of the customer associated with this account.", IsRequired=true)
public var refId:Int?
/**
* 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'.")
public var refIdStr:String
/**
* The unique user name of the user account.
*/
// @ApiMember(Description="The unique user name of the user account.", IsRequired=true)
public var userName:String
/**
* The electronic mail address of the user account.
*/
// @ApiMember(Description="The electronic mail address of the user account.")
public var email:String
/**
* The friendly name of the user account.
*/
// @ApiMember(Description="The friendly name of the user account.")
public var displayName:String
/**
* 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.")
public var firstName:String
/**
* 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.")
public var lastName:String
/**
* The unique identifier of the customer associated with this account.
*/
// @ApiMember(Description="The unique identifier of the customer associated with this account.")
public var fullName:String
/**
* The gender of the owner (natural person) of the user account.
*/
// @ApiMember(Description="The gender of the owner (natural person) of the user account.")
public var gender:String
/**
* The language of the owner of teh user account.
*/
// @ApiMember(Description="The language of the owner of teh user account.")
public var language:String
/**
* The company, where the user is an employee.
*/
// @ApiMember(Description="The company, where the user is an employee.")
public var company:String
/**
* The profile URL of the user account.
*/
// @ApiMember(Description="The profile URL of the user account.", IsRequired=true)
public var profileUrl:String
/**
* The roles assigned to the user account.
*/
// @ApiMember(Description="The roles assigned to the user account.")
public var roles:[String] = []
/**
* The permissions assigned to the user account.
*/
// @ApiMember(Description="The permissions assigned to the user account.")
public var permissions:[String] = []
/**
* The primary e-mail address of the user.
*/
// @ApiMember(Description="The primary e-mail address of the user.")
public var primaryEmail:String
/**
* Random data to enhance the security of the user password.
*/
// @ApiMember(Description="Random data to enhance the security of the user password.")
public var salt:String
/**
* 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.")
public var passwordHash:String
/**
* 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.")
public var digestHa1Hash:String
/**
* 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.")
public var invalidLoginAttempts:Int
/**
* The last time the user account attempted a sign in.
*/
// @ApiMember(Description="The last time the user account attempted a sign in.")
public var lastLoginAttempt:Date?
/**
* The date and time when the user acount was denied access.
*/
// @ApiMember(Description="The date and time when the user acount was denied access.")
public var lockedDate:Date?
/**
* The date and time when the user account was created.
*/
// @ApiMember(Description="The date and time when the user account was created.")
public var createdDate:Date
/**
* The date and time when the user account was last modified.
*/
// @ApiMember(Description="The date and time when the user account was last modified.")
public var modifiedDate:Date
/**
* The telephone number of the owner of the user account.
*/
// @ApiMember(Description="The telephone number of the owner of the user account.")
public var phoneNumber:String
/**
* The birth date of the owner of the user account
*/
// @ApiMember(Description="The birth date of the owner of the user account")
public var birthDate:Date?
/**
* The string representation of the birth date of the user account.
*/
// @ApiMember(Description="The string representation of the birth date of the user account.")
public var birthDateRaw:String
/**
* The mail address of the user account.
*/
// @ApiMember(Description="The mail address of the user account.")
public var address:String
/**
* Additional information for the specified 'Address' of the user.
*/
// @ApiMember(Description="Additional information for the specified 'Address' of the user.")
public var address2:String
/**
* The city of the owner of the user account.
*/
// @ApiMember(Description="The city of the owner of the user account.")
public var city:String
/**
* The state of the owner of the user account.
*/
// @ApiMember(Description="The state of the owner of the user account.")
public var state:String
/**
* 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'.")
public var country:String
/**
* The locale of the user account.
*/
// @ApiMember(Description="The locale of the user account.")
public var culture:String
/**
* The mail address of the user account.
*/
// @ApiMember(Description="The mail address of the user account.")
public var mailAddress:String
/**
* The nickname of the user of the user account.
*/
// @ApiMember(Description="The nickname of the user of the user account.")
public var nickname:String
/**
* The postal code of the user account.
*/
// @ApiMember(Description="The postal code of the user account.")
public var postalCode:String
/**
* The time zone of the user of the user account.
*/
// @ApiMember(Description="The time zone of the user of the user account.")
public var timeZone:String
/**
* Additional information to attach to the user account.
*/
// @ApiMember(Description="Additional information to attach to the user account.")
public var meta:[String:String] = [:]
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(){}
}
/**
* Represents a commission to consume services.
*/
// @Api(Description="Represents a commission to consume services.")
public class Order : IHasName, Codable
{
/**
* The unique identifier of the order.
*/
// @ApiMember(Description="The unique identifier of the order.", IsRequired=true)
public var id:Int
/**
* 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)
public var productId:Int
/**
* 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)
public var accountId:Int
/**
* A name to identify the order.
*/
// @ApiMember(Description="A name to identify the order.", IsRequired=true)
// @Validate(Validator="NotEmpty")
public var name:String
/**
* The name of the service, for which the order was made.
*/
// @ApiMember(Description="The name of the service, for which the order was made.")
public var serviceName:String
/**
* The time stamp at which the order was initiated.
*/
// @ApiMember(Description="The time stamp at which the order was initiated.")
public var requestTimestamp:Date?
/**
* The time stamp at which the order was completed.
*/
// @ApiMember(Description="The time stamp at which the order was completed.")
public var responseTimestamp:Date?
/**
* The URI from which the order was initiated.
*/
// @ApiMember(Description="The URI from which the order was initiated.")
public var requestUri:String
/**
* The HTTP method of the order request.
*/
// @ApiMember(Description="The HTTP method of the order request.")
public var requestHttpMethod:String
/**
* The duration of the order request.
*/
// @ApiMember(Description="The duration of the order request.")
@TimeSpan public var requestDuration:TimeInterval?
/**
* The HTTP status code of the order request.
*/
// @ApiMember(Description="The HTTP status code of the order request.")
public var responseStatusCode:HttpStatusCode
/**
* The IP address of client, who placed the order.
*/
// @ApiMember(Description="The IP address of client, who placed the order.")
public var clientIPAddress:String
/**
* The unit of measurement for the order.
*/
// @ApiMember(Description="The unit of measurement for the order.")
public var unitOfMeasurement:String
/**
* The type of process, for which the order is charged.
*/
// @ApiMember(Description="The type of process, for which the order is charged.")
public var processType:String
/**
* The type of data, for which the order is charged.
*/
// @ApiMember(Description="The type of data, for which the order is charged.")
public var dataType:String
/**
* The name of the data, for which the order is charged.
*/
// @ApiMember(Description="The name of the data, for which the order is charged.")
public var dataName:String
/**
* The date of creation of the order.
*/
// @ApiMember(Description="The date of creation of the order.")
public var creationDate:Date
/**
* 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.")
public var expiryDate:Date?
/**
* 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.")
public var isTest:Bool
required public init(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .x-msgpack suffix or ?format=x-msgpack
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /async/accounts/update HTTP/1.1
Host: taxfiling.staging.pwc.de
Accept: application/x-msgpack
Content-Type: application/x-msgpack
Content-Length: length
{"userName":"String","displayName":"String","email":"String","profileUrl":"String","meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: application/x-msgpack
Content-Length: length
{"account":{"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":"\/Date(-62135596800000-0000)\/","lockedDate":"\/Date(-62135596800000-0000)\/","createdDate":"\/Date(-62135596800000-0000)\/","modifiedDate":"\/Date(-62135596800000-0000)\/","phoneNumber":"String","birthDate":"\/Date(-62135596800000-0000)\/","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"}},"index":0,"products":[{"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"}}}