Tax Filing Service
| Required role: | Admin | Required permissions: | CanAccess, CanAdd |
| PUT | /async/accounts/products/subscribe |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
/**
* Represents a service request to subscribe a user account to one or more products in an asynchronous operation.
*/
@Api(Description="Represents a service request to subscribe a user account to one or more products in an asynchronous operation.")
public static class AddProductSubscriptionAsync extends AddProductSubscriptionBase
{
/**
* The unique identifier of the user account to subscribe.
*/
@ApiMember(Description="The unique identifier of the user account to subscribe.")
public Integer accountId = null;
/**
* The user name of the user account to subscribe.
*/
@ApiMember(Description="The user name of the user account to subscribe.")
public String userName = null;
/**
* The unique identifier of the product, to which the user account is subscribed.
*/
@ApiMember(Description="The unique identifier of the product, to which the user account is subscribed.")
public Integer productId = null;
/**
* The name of the product, to which the user account is subscribed.
*/
@ApiMember(Description="The name of the product, to which the user account is subscribed.")
public String productName = null;
public Integer getAccountId() { return accountId; }
public AddProductSubscriptionAsync setAccountId(Integer value) { this.accountId = value; return this; }
public String getUserName() { return userName; }
public AddProductSubscriptionAsync setUserName(String value) { this.userName = value; return this; }
public Integer getProductId() { return productId; }
public AddProductSubscriptionAsync setProductId(Integer value) { this.productId = value; return this; }
public String getProductName() { return productName; }
public AddProductSubscriptionAsync setProductName(String value) { this.productName = value; return this; }
}
/**
* Specifies a base service request to subscribe a user account to one or more products.
*/
@Api(Description="Specifies a base service request to subscribe a user account to one or more products.")
public static class AddProductSubscriptionBase implements IPut
{
/**
* The unique identifier of the user account to subscribe.
*/
@ApiMember(Description="The unique identifier of the user account to subscribe.")
public Integer accountId = null;
/**
* The user name of the user account to subscribe.
*/
@ApiMember(Description="The user name of the user account to subscribe.")
public String userName = null;
/**
* The unique identifier of the product, to which the user account is subscribed.
*/
@ApiMember(Description="The unique identifier of the product, to which the user account is subscribed.")
public Integer productId = null;
/**
* The name of the product, to which the user account is subscribed.
*/
@ApiMember(Description="The name of the product, to which the user account is subscribed.")
public String productName = null;
public Integer getAccountId() { return accountId; }
public AddProductSubscriptionBase setAccountId(Integer value) { this.accountId = value; return this; }
public String getUserName() { return userName; }
public AddProductSubscriptionBase setUserName(String value) { this.userName = value; return this; }
public Integer getProductId() { return productId; }
public AddProductSubscriptionBase setProductId(Integer value) { this.productId = value; return this; }
public String getProductName() { return productName; }
public AddProductSubscriptionBase setProductName(String value) { this.productName = value; return this; }
}
/**
* 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 static class AccountResponse extends ServiceResponseBase
{
/**
* The user account encapsulated in the response.
*/
@ApiMember(Description="The user account encapsulated in the response.")
public Account account = null;
/**
* 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 Long index = null;
/**
* The list of products associated with the encapsulated user account.
*/
@ApiMember(Description="The list of products associated with the encapsulated user account.")
public ArrayList<Product> products = null;
/**
* The list of orders associated with the encapsulated user account.
*/
@ApiMember(Description="The list of orders associated with the encapsulated user account.")
public ArrayList<Order> orders = null;
/**
* Data structure that holds error information from a service operation.
*/
@ApiMember(Description="Data structure that holds error information from a service operation.")
public ResponseStatus responseStatus = null;
public Account getAccount() { return account; }
public AccountResponse setAccount(Account value) { this.account = value; return this; }
public Long getIndex() { return index; }
public AccountResponse setIndex(Long value) { this.index = value; return this; }
public ArrayList<Product> getProducts() { return products; }
public AccountResponse setProducts(ArrayList<Product> value) { this.products = value; return this; }
public ArrayList<Order> getOrders() { return orders; }
public AccountResponse setOrders(ArrayList<Order> value) { this.orders = value; return this; }
public ResponseStatus getResponseStatus() { return responseStatus; }
public AccountResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
}
/**
* 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 static class ServiceResponseBase
{
/**
* Data structure that holds error information from a service operation.
*/
@ApiMember(Description="Data structure that holds error information from a service operation.")
public ResponseStatus responseStatus = null;
public ResponseStatus getResponseStatus() { return responseStatus; }
public ServiceResponseBase setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
}
/**
* Represents a user account.
*/
@Api(Description="Represents a user account.")
public static class Account implements IHasUserName
{
/**
* The unique identifier of the user account.
*/
@ApiMember(Description="The unique identifier of the user account.", IsRequired=true)
public Integer id = null;
/**
* 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 Integer index = null;
/**
* 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 Integer refId = null;
/**
* 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 String refIdStr = null;
/**
* The unique user name of the user account.
*/
@ApiMember(Description="The unique user name of the user account.", IsRequired=true)
public String userName = null;
/**
* The electronic mail address of the user account.
*/
@ApiMember(Description="The electronic mail address of the user account.")
public String email = null;
/**
* The friendly name of the user account.
*/
@ApiMember(Description="The friendly name of the user account.")
public String displayName = null;
/**
* 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 String firstName = null;
/**
* 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 String lastName = null;
/**
* The unique identifier of the customer associated with this account.
*/
@ApiMember(Description="The unique identifier of the customer associated with this account.")
public String fullName = null;
/**
* 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 String gender = null;
/**
* The language of the owner of teh user account.
*/
@ApiMember(Description="The language of the owner of teh user account.")
public String language = null;
/**
* The company, where the user is an employee.
*/
@ApiMember(Description="The company, where the user is an employee.")
public String company = null;
/**
* The profile URL of the user account.
*/
@ApiMember(Description="The profile URL of the user account.", IsRequired=true)
public String profileUrl = null;
/**
* The roles assigned to the user account.
*/
@ApiMember(Description="The roles assigned to the user account.")
public ArrayList<String> roles = null;
/**
* The permissions assigned to the user account.
*/
@ApiMember(Description="The permissions assigned to the user account.")
public ArrayList<String> permissions = null;
/**
* The primary e-mail address of the user.
*/
@ApiMember(Description="The primary e-mail address of the user.")
public String primaryEmail = null;
/**
* Random data to enhance the security of the user password.
*/
@ApiMember(Description="Random data to enhance the security of the user password.")
public String salt = null;
/**
* 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 String passwordHash = null;
/**
* 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 String digestHa1Hash = null;
/**
* 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 Integer invalidLoginAttempts = null;
/**
* The last time the user account attempted a sign in.
*/
@ApiMember(Description="The last time the user account attempted a sign in.")
public Date lastLoginAttempt = null;
/**
* 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 Date lockedDate = null;
/**
* The date and time when the user account was created.
*/
@ApiMember(Description="The date and time when the user account was created.")
public Date createdDate = null;
/**
* 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 Date modifiedDate = null;
/**
* The telephone number of the owner of the user account.
*/
@ApiMember(Description="The telephone number of the owner of the user account.")
public String phoneNumber = null;
/**
* The birth date of the owner of the user account
*/
@ApiMember(Description="The birth date of the owner of the user account")
public Date birthDate = null;
/**
* 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 String birthDateRaw = null;
/**
* The mail address of the user account.
*/
@ApiMember(Description="The mail address of the user account.")
public String address = null;
/**
* Additional information for the specified 'Address' of the user.
*/
@ApiMember(Description="Additional information for the specified 'Address' of the user.")
public String address2 = null;
/**
* The city of the owner of the user account.
*/
@ApiMember(Description="The city of the owner of the user account.")
public String city = null;
/**
* The state of the owner of the user account.
*/
@ApiMember(Description="The state of the owner of the user account.")
public String state = null;
/**
* 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 String country = null;
/**
* The locale of the user account.
*/
@ApiMember(Description="The locale of the user account.")
public String culture = null;
/**
* The mail address of the user account.
*/
@ApiMember(Description="The mail address of the user account.")
public String mailAddress = null;
/**
* The nickname of the user of the user account.
*/
@ApiMember(Description="The nickname of the user of the user account.")
public String nickname = null;
/**
* The postal code of the user account.
*/
@ApiMember(Description="The postal code of the user account.")
public String postalCode = null;
/**
* The time zone of the user of the user account.
*/
@ApiMember(Description="The time zone of the user of the user account.")
public String timeZone = null;
/**
* Additional information to attach to the user account.
*/
@ApiMember(Description="Additional information to attach to the user account.")
public HashMap<String,String> meta = null;
public Integer getId() { return id; }
public Account setId(Integer value) { this.id = value; return this; }
public Integer getIndex() { return index; }
public Account setIndex(Integer value) { this.index = value; return this; }
public Integer getRefId() { return refId; }
public Account setRefId(Integer value) { this.refId = value; return this; }
public String getRefIdStr() { return refIdStr; }
public Account setRefIdStr(String value) { this.refIdStr = value; return this; }
public String getUserName() { return userName; }
public Account setUserName(String value) { this.userName = value; return this; }
public String getEmail() { return email; }
public Account setEmail(String value) { this.email = value; return this; }
public String getDisplayName() { return displayName; }
public Account setDisplayName(String value) { this.displayName = value; return this; }
public String getFirstName() { return firstName; }
public Account setFirstName(String value) { this.firstName = value; return this; }
public String getLastName() { return lastName; }
public Account setLastName(String value) { this.lastName = value; return this; }
public String getFullName() { return fullName; }
public Account setFullName(String value) { this.fullName = value; return this; }
public String getGender() { return gender; }
public Account setGender(String value) { this.gender = value; return this; }
public String getLanguage() { return language; }
public Account setLanguage(String value) { this.language = value; return this; }
public String getCompany() { return company; }
public Account setCompany(String value) { this.company = value; return this; }
public String getProfileUrl() { return profileUrl; }
public Account setProfileUrl(String value) { this.profileUrl = value; return this; }
public ArrayList<String> getRoles() { return roles; }
public Account setRoles(ArrayList<String> value) { this.roles = value; return this; }
public ArrayList<String> getPermissions() { return permissions; }
public Account setPermissions(ArrayList<String> value) { this.permissions = value; return this; }
public String getPrimaryEmail() { return primaryEmail; }
public Account setPrimaryEmail(String value) { this.primaryEmail = value; return this; }
public String getSalt() { return salt; }
public Account setSalt(String value) { this.salt = value; return this; }
public String getPasswordHash() { return passwordHash; }
public Account setPasswordHash(String value) { this.passwordHash = value; return this; }
public String getDigestHa1Hash() { return digestHa1Hash; }
public Account setDigestHa1Hash(String value) { this.digestHa1Hash = value; return this; }
public Integer getInvalidLoginAttempts() { return invalidLoginAttempts; }
public Account setInvalidLoginAttempts(Integer value) { this.invalidLoginAttempts = value; return this; }
public Date getLastLoginAttempt() { return lastLoginAttempt; }
public Account setLastLoginAttempt(Date value) { this.lastLoginAttempt = value; return this; }
public Date getLockedDate() { return lockedDate; }
public Account setLockedDate(Date value) { this.lockedDate = value; return this; }
public Date getCreatedDate() { return createdDate; }
public Account setCreatedDate(Date value) { this.createdDate = value; return this; }
public Date getModifiedDate() { return modifiedDate; }
public Account setModifiedDate(Date value) { this.modifiedDate = value; return this; }
public String getPhoneNumber() { return phoneNumber; }
public Account setPhoneNumber(String value) { this.phoneNumber = value; return this; }
public Date getBirthDate() { return birthDate; }
public Account setBirthDate(Date value) { this.birthDate = value; return this; }
public String getBirthDateRaw() { return birthDateRaw; }
public Account setBirthDateRaw(String value) { this.birthDateRaw = value; return this; }
public String getAddress() { return address; }
public Account setAddress(String value) { this.address = value; return this; }
public String getAddress2() { return address2; }
public Account setAddress2(String value) { this.address2 = value; return this; }
public String getCity() { return city; }
public Account setCity(String value) { this.city = value; return this; }
public String getState() { return state; }
public Account setState(String value) { this.state = value; return this; }
public String getCountry() { return country; }
public Account setCountry(String value) { this.country = value; return this; }
public String getCulture() { return culture; }
public Account setCulture(String value) { this.culture = value; return this; }
public String getMailAddress() { return mailAddress; }
public Account setMailAddress(String value) { this.mailAddress = value; return this; }
public String getNickname() { return nickname; }
public Account setNickname(String value) { this.nickname = value; return this; }
public String getPostalCode() { return postalCode; }
public Account setPostalCode(String value) { this.postalCode = value; return this; }
public String getTimeZone() { return timeZone; }
public Account setTimeZone(String value) { this.timeZone = value; return this; }
public HashMap<String,String> getMeta() { return meta; }
public Account setMeta(HashMap<String,String> value) { this.meta = value; return this; }
}
/**
* Represents a product.
*/
@Api(Description="Represents a product.")
public static class Product implements IHasName
{
/**
* The unique identifier of the product.
*/
@ApiMember(Description="The unique identifier of the product.", IsRequired=true)
public Integer id = null;
/**
* 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 Integer index = null;
/**
* The name of the product.
*/
@ApiMember(Description="The name of the product.", IsRequired=true)
@Validate(Validator="NotEmpty")
public String name = null;
/**
* The version of the product.
*/
@ApiMember(Description="The version of the product.", IsRequired=true)
@Validate(Validator="NotEmpty")
public String version = null;
/**
* The version of the product.
*/
@ApiMember(Description="The version of the product.")
public String description = null;
/**
* Tags associated with the product.
*/
@ApiMember(Description="Tags associated with the product.")
public ArrayList<String> tags = null;
public Integer getId() { return id; }
public Product setId(Integer value) { this.id = value; return this; }
public Integer getIndex() { return index; }
public Product setIndex(Integer value) { this.index = value; return this; }
public String getName() { return name; }
public Product setName(String value) { this.name = value; return this; }
public String getVersion() { return version; }
public Product setVersion(String value) { this.version = value; return this; }
public String getDescription() { return description; }
public Product setDescription(String value) { this.description = value; return this; }
public ArrayList<String> getTags() { return tags; }
public Product setTags(ArrayList<String> value) { this.tags = value; return this; }
}
/**
* Represents a commission to consume services.
*/
@Api(Description="Represents a commission to consume services.")
public static class Order implements IHasName
{
/**
* The unique identifier of the order.
*/
@ApiMember(Description="The unique identifier of the order.", IsRequired=true)
public Integer id = null;
/**
* 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 Integer productId = null;
/**
* 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 Integer accountId = null;
/**
* A name to identify the order.
*/
@ApiMember(Description="A name to identify the order.", IsRequired=true)
@Validate(Validator="NotEmpty")
public String name = null;
/**
* 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 String serviceName = null;
/**
* The time stamp at which the order was initiated.
*/
@ApiMember(Description="The time stamp at which the order was initiated.")
public Date requestTimestamp = null;
/**
* The time stamp at which the order was completed.
*/
@ApiMember(Description="The time stamp at which the order was completed.")
public Date responseTimestamp = null;
/**
* The URI from which the order was initiated.
*/
@ApiMember(Description="The URI from which the order was initiated.")
public String requestUri = null;
/**
* The HTTP method of the order request.
*/
@ApiMember(Description="The HTTP method of the order request.")
public String requestHttpMethod = null;
/**
* The duration of the order request.
*/
@ApiMember(Description="The duration of the order request.")
public TimeSpan requestDuration = null;
/**
* The HTTP status code of the order request.
*/
@ApiMember(Description="The HTTP status code of the order request.")
public HttpStatusCode responseStatusCode = null;
/**
* The IP address of client, who placed the order.
*/
@ApiMember(Description="The IP address of client, who placed the order.")
public String clientIPAddress = null;
/**
* The unit of measurement for the order.
*/
@ApiMember(Description="The unit of measurement for the order.")
public String unitOfMeasurement = null;
/**
* The type of process, for which the order is charged.
*/
@ApiMember(Description="The type of process, for which the order is charged.")
public String processType = null;
/**
* The type of data, for which the order is charged.
*/
@ApiMember(Description="The type of data, for which the order is charged.")
public String dataType = null;
/**
* 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 String dataName = null;
/**
* The date of creation of the order.
*/
@ApiMember(Description="The date of creation of the order.")
public Date creationDate = null;
/**
* 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 Date expiryDate = null;
/**
* 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 Boolean isTest = null;
public Integer getId() { return id; }
public Order setId(Integer value) { this.id = value; return this; }
public Integer getProductId() { return productId; }
public Order setProductId(Integer value) { this.productId = value; return this; }
public Integer getAccountId() { return accountId; }
public Order setAccountId(Integer value) { this.accountId = value; return this; }
public String getName() { return name; }
public Order setName(String value) { this.name = value; return this; }
public String getServiceName() { return serviceName; }
public Order setServiceName(String value) { this.serviceName = value; return this; }
public Date getRequestTimestamp() { return requestTimestamp; }
public Order setRequestTimestamp(Date value) { this.requestTimestamp = value; return this; }
public Date getResponseTimestamp() { return responseTimestamp; }
public Order setResponseTimestamp(Date value) { this.responseTimestamp = value; return this; }
public String getRequestUri() { return requestUri; }
public Order setRequestUri(String value) { this.requestUri = value; return this; }
public String getRequestHttpMethod() { return requestHttpMethod; }
public Order setRequestHttpMethod(String value) { this.requestHttpMethod = value; return this; }
public TimeSpan getRequestDuration() { return requestDuration; }
public Order setRequestDuration(TimeSpan value) { this.requestDuration = value; return this; }
public HttpStatusCode getResponseStatusCode() { return responseStatusCode; }
public Order setResponseStatusCode(HttpStatusCode value) { this.responseStatusCode = value; return this; }
public String getClientIPAddress() { return clientIPAddress; }
public Order setClientIPAddress(String value) { this.clientIPAddress = value; return this; }
public String getUnitOfMeasurement() { return unitOfMeasurement; }
public Order setUnitOfMeasurement(String value) { this.unitOfMeasurement = value; return this; }
public String getProcessType() { return processType; }
public Order setProcessType(String value) { this.processType = value; return this; }
public String getDataType() { return dataType; }
public Order setDataType(String value) { this.dataType = value; return this; }
public String getDataName() { return dataName; }
public Order setDataName(String value) { this.dataName = value; return this; }
public Date getCreationDate() { return creationDate; }
public Order setCreationDate(Date value) { this.creationDate = value; return this; }
public Date getExpiryDate() { return expiryDate; }
public Order setExpiryDate(Date value) { this.expiryDate = value; return this; }
public Boolean getIsTest() { return isTest; }
public Order setIsTest(Boolean value) { this.isTest = value; return this; }
}
}
Java AddProductSubscriptionAsync 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.
PUT /async/accounts/products/subscribe HTTP/1.1
Host: taxfiling.staging.pwc.de
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
accountId: 0,
userName: String,
productId: 0,
productName: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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: 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
}
},
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: 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
}
}
}