Tax Filing Service
| Required role: | Admin | Required permission: | CanAccess |
| GET | /sync/customers |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
/**
* Represents a service request to retrieve all customers.
*/
@Api(Description="Represents a service request to retrieve all customers.")
public static class RetrieveAllCustomers extends RetrieveAllCustomersBase
{
/**
* Should related accounts be included in the retrieved customers?
*/
@ApiMember(Description="Should related accounts be included in the retrieved customers?")
public Boolean includeAccounts = null;
/**
* Specifies the number of products to skip per customer. Applicable only when 'IncludeAccounts' is true.
*/
@ApiMember(Description="Specifies the number of products to skip per customer. Applicable only when 'IncludeAccounts' is true. ")
public Integer skipAccounts = null;
/**
* Specifies the number of products to include per customer. Applicable only when 'IncludeAccounts' is true.
*/
@ApiMember(Description="Specifies the number of products to include per customer. Applicable only when 'IncludeAccounts' is true. ")
public Integer takeAccounts = null;
/**
* The number of query results to skip.
*/
@ApiMember(Description="The number of query results to skip.")
public Integer skip = null;
/**
* The number of query results to include.
*/
@ApiMember(Description="The number of query results to include.")
public Integer take = null;
public Boolean isIncludeAccounts() { return includeAccounts; }
public RetrieveAllCustomers setIncludeAccounts(Boolean value) { this.includeAccounts = value; return this; }
public Integer getSkipAccounts() { return skipAccounts; }
public RetrieveAllCustomers setSkipAccounts(Integer value) { this.skipAccounts = value; return this; }
public Integer getTakeAccounts() { return takeAccounts; }
public RetrieveAllCustomers setTakeAccounts(Integer value) { this.takeAccounts = value; return this; }
public Integer getSkip() { return skip; }
public RetrieveAllCustomers setSkip(Integer value) { this.skip = value; return this; }
public Integer getTake() { return take; }
public RetrieveAllCustomers setTake(Integer value) { this.take = value; return this; }
}
/**
* Specifies a service to search for customers.
*/
@Api(Description="Specifies a service to search for customers.")
public static class RetrieveAllCustomersBase extends PaginationBase implements IGet
{
/**
* Should related accounts be included in the retrieved customers?
*/
@ApiMember(Description="Should related accounts be included in the retrieved customers?")
public Boolean includeAccounts = null;
/**
* Specifies the number of products to skip per customer. Applicable only when 'IncludeAccounts' is true.
*/
@ApiMember(Description="Specifies the number of products to skip per customer. Applicable only when 'IncludeAccounts' is true. ")
public Integer skipAccounts = null;
/**
* Specifies the number of products to include per customer. Applicable only when 'IncludeAccounts' is true.
*/
@ApiMember(Description="Specifies the number of products to include per customer. Applicable only when 'IncludeAccounts' is true. ")
public Integer takeAccounts = null;
/**
* The number of query results to skip.
*/
@ApiMember(Description="The number of query results to skip.")
public Integer skip = null;
/**
* The number of query results to include.
*/
@ApiMember(Description="The number of query results to include.")
public Integer take = null;
public Boolean isIncludeAccounts() { return includeAccounts; }
public RetrieveAllCustomersBase setIncludeAccounts(Boolean value) { this.includeAccounts = value; return this; }
public Integer getSkipAccounts() { return skipAccounts; }
public RetrieveAllCustomersBase setSkipAccounts(Integer value) { this.skipAccounts = value; return this; }
public Integer getTakeAccounts() { return takeAccounts; }
public RetrieveAllCustomersBase setTakeAccounts(Integer value) { this.takeAccounts = value; return this; }
public Integer getSkip() { return skip; }
public RetrieveAllCustomersBase setSkip(Integer value) { this.skip = value; return this; }
public Integer getTake() { return take; }
public RetrieveAllCustomersBase setTake(Integer value) { this.take = value; return this; }
}
/**
* The number of query results to skip.
*/
@Api(Description="The number of query results to skip.")
public static class PaginationBase implements IPaginate
{
/**
* The number of query results to skip.
*/
@ApiMember(Description="The number of query results to skip.")
public Integer skip = null;
/**
* The number of query results to include.
*/
@ApiMember(Description="The number of query results to include.")
public Integer take = null;
public Integer getSkip() { return skip; }
public PaginationBase setSkip(Integer value) { this.skip = value; return this; }
public Integer getTake() { return take; }
public PaginationBase setTake(Integer value) { this.take = value; return this; }
}
/**
* Represents a query response that contains a structured error information and encapsulates customers.
*/
@Api(Description="Represents a query response that contains a structured error information and encapsulates customers.")
public static class CustomerQueryResponse extends QueryResponse<Customer>
{
@DataMember(Order=1)
public Integer offset = null;
@DataMember(Order=2)
public Integer total = null;
@DataMember(Order=3)
public ArrayList<Customer> results = null;
@DataMember(Order=4)
public HashMap<String,String> meta = null;
@DataMember(Order=5)
public ResponseStatus responseStatus = null;
public Integer getOffset() { return offset; }
public CustomerQueryResponse setOffset(Integer value) { this.offset = value; return this; }
public Integer getTotal() { return total; }
public CustomerQueryResponse setTotal(Integer value) { this.total = value; return this; }
public ArrayList<Customer> getResults() { return results; }
public CustomerQueryResponse setResults(ArrayList<Customer> value) { this.results = value; return this; }
public HashMap<String,String> getMeta() { return meta; }
public CustomerQueryResponse setMeta(HashMap<String,String> value) { this.meta = value; return this; }
public ResponseStatus getResponseStatus() { return responseStatus; }
public CustomerQueryResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
}
@DataContract
public static class QueryResponse<T>
{
@DataMember(Order=1)
public Integer offset = null;
@DataMember(Order=2)
public Integer total = null;
@DataMember(Order=3)
public ArrayList<T> results = null;
@DataMember(Order=4)
public HashMap<String,String> meta = null;
@DataMember(Order=5)
public ResponseStatus responseStatus = null;
public Integer getOffset() { return offset; }
public QueryResponse<T> setOffset(Integer value) { this.offset = value; return this; }
public Integer getTotal() { return total; }
public QueryResponse<T> setTotal(Integer value) { this.total = value; return this; }
public ArrayList<T> getResults() { return results; }
public QueryResponse<T> setResults(ArrayList<T> value) { this.results = value; return this; }
public HashMap<String,String> getMeta() { return meta; }
public QueryResponse<T> setMeta(HashMap<String,String> value) { this.meta = value; return this; }
public ResponseStatus getResponseStatus() { return responseStatus; }
public QueryResponse<T> setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
}
/**
* Represents a customer (business organization or entrepreneur).
*/
@Api(Description="Represents a customer (business organization or entrepreneur).")
public static class Customer implements IHasName
{
/**
* The unique identifier of the customer.
*/
@ApiMember(Description="The unique identifier of the customer.", IsRequired=true)
public Integer id = null;
/**
* The position of this instance in a collection of 'Customer' instances
*/
@ApiMember(Description="The position of this instance in a collection of 'Customer' instances", IsRequired=true)
public Integer index = null;
/**
* Full name or organization name of customer.
*/
@ApiMember(Description="Full name or organization name of customer.", IsRequired=true)
@Validate(Validator="NotEmpty")
public String name = null;
/**
* The country of residence or business of customer.
*/
@ApiMember(Description="The country of residence or business of customer.")
public String country = null;
/**
* The type of customer.
*/
@ApiMember(Description="The type of customer.")
public CustomerType type = null;
/**
* The list of user accounts associated with this customer.
*/
@ApiMember(Description="The list of user accounts associated with this customer.")
@Ignore()
public ArrayList<Account> accounts = null;
public Integer getId() { return id; }
public Customer setId(Integer value) { this.id = value; return this; }
public Integer getIndex() { return index; }
public Customer setIndex(Integer value) { this.index = value; return this; }
public String getName() { return name; }
public Customer setName(String value) { this.name = value; return this; }
public String getCountry() { return country; }
public Customer setCountry(String value) { this.country = value; return this; }
public CustomerType getType() { return type; }
public Customer setType(CustomerType value) { this.type = value; return this; }
public ArrayList<Account> getAccounts() { return accounts; }
public Customer setAccounts(ArrayList<Account> value) { this.accounts = value; return this; }
}
public static enum CustomerType
{
Internal,
Network,
External;
}
/**
* 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; }
}
}
Java RetrieveAllCustomers DTOs
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.
GET /sync/customers HTTP/1.1 Host: taxfiling.staging.pwc.de Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"offset":0,"total":0,"results":[{"id":0,"index":0,"name":"String","country":"String","type":"Internal","accounts":[{"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"}}]}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}