<back to all web services

SearchAccounts

Represents a service to search for accounts.

import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* Represents a service to search for accounts.
*/
@Api(Description="Represents a service to search for accounts.")
open class SearchAccounts : SearchAccountsBase()
{
    /**
    * The unique identifier of the user account.
    */
    @ApiMember(Description="The unique identifier of the user account.")
    var accountId:Int? = null

    /**
    * The unique identifier of the customer associated with this account.
    */
    @ApiMember(Description="The unique identifier of the customer associated with this account.")
    var customerId:Int? = null

    /**
    * The user name of the user account.
    */
    @ApiMember(Description="The user name of the user account.")
    var userName:String? = null

    /**
    * Search by using the user name that starts with the specified value.
    */
    @ApiMember(Description="Search by using the user name that starts with the specified value.")
    var userNameStartsWith:String? = null

    /**
    * Search by using the user name that ends with the specified value.
    */
    @ApiMember(Description="Search by using the user name that ends with the specified value.")
    var userNameEndsWith:String? = null

    /**
    * Search by using the user name that contains the specified value.
    */
    @ApiMember(Description="Search by using the user name that contains the specified value.")
    var userNameContains:String? = null

    /**
    * The display name of the user account.
    */
    @ApiMember(Description="The display name of the user account.")
    var displayName:String? = null

    /**
    * The e-mail address of the user account.
    */
    @ApiMember(Description="The e-mail address of the user account.")
    var email:String? = null

    /**
    * Search by using the e-mail address of the user account that starts with the specified value.
    */
    @ApiMember(Description="Search by using the e-mail address of the user account that starts with the specified value.")
    var emailStartsWith:String? = null

    /**
    * Search by using the e-mail address of the user account that ends with the specified value.
    */
    @ApiMember(Description="Search by using the e-mail address of the user account that ends with the specified value.")
    var emailEndsWith:String? = null

    /**
    * Search by using the e-mail address of the user account that contains the specified value.
    */
    @ApiMember(Description="Search by using the e-mail address of the user account that contains the specified value.")
    var emailContains:String? = null

    /**
    * Search by using the display name that starts with the specified value.
    */
    @ApiMember(Description="Search by using the display name that starts with the specified value.")
    var displayNameStartsWith:String? = null

    /**
    * Search by using the display name that ends with the specified value.
    */
    @ApiMember(Description="Search by using the display name that ends with the specified value.")
    var displayNameEndsWith:String? = null

    /**
    * Search by using the display name that contains the specified value.
    */
    @ApiMember(Description="Search by using the display name that contains the specified value.")
    var displayNameContains:String? = null

    /**
    * Search with the profile URL of the user account.
    */
    @ApiMember(Description="Search with the profile URL of the user account.")
    var profileUrl:String? = null

    /**
    * Should the related products of the account be included in the retrieved accounts?
    */
    @ApiMember(Description="Should the related products of the account be included in the retrieved accounts?")
    var includeProducts:Boolean? = null

    /**
    * Should the related orders of the account be included in the retrieved accounts?
    */
    @ApiMember(Description="Should the related orders of the account be included in the retrieved accounts?")
    var includeOrders:Boolean? = null

    /**
    * 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. ")
    var skipProducts:Int? = null

    /**
    * 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. ")
    var takeProducts:Int? = null

    /**
    * 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. ")
    var skipOrders:Int? = null

    /**
    * 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. ")
    var takeOrders:Int? = null

    /**
    * The number of query results to skip.
    */
    @ApiMember(Description="The number of query results to skip.")
    var skip:Int? = null

    /**
    * The number of query results to include.
    */
    @ApiMember(Description="The number of query results to include.")
    var take:Int? = null
}

/**
* Specifies a service to search for accounts.
*/
@Api(Description="Specifies a service to search for accounts.")
open class SearchAccountsBase : PaginationBase(), IGet
{
    /**
    * The unique identifier of the user account.
    */
    @ApiMember(Description="The unique identifier of the user account.")
    var accountId:Int? = null

    /**
    * The unique identifier of the customer associated with this account.
    */
    @ApiMember(Description="The unique identifier of the customer associated with this account.")
    var customerId:Int? = null

    /**
    * The user name of the user account.
    */
    @ApiMember(Description="The user name of the user account.")
    var userName:String? = null

    /**
    * Search by using the user name that starts with the specified value.
    */
    @ApiMember(Description="Search by using the user name that starts with the specified value.")
    var userNameStartsWith:String? = null

    /**
    * Search by using the user name that ends with the specified value.
    */
    @ApiMember(Description="Search by using the user name that ends with the specified value.")
    var userNameEndsWith:String? = null

    /**
    * Search by using the user name that contains the specified value.
    */
    @ApiMember(Description="Search by using the user name that contains the specified value.")
    var userNameContains:String? = null

    /**
    * The display name of the user account.
    */
    @ApiMember(Description="The display name of the user account.")
    var displayName:String? = null

    /**
    * The e-mail address of the user account.
    */
    @ApiMember(Description="The e-mail address of the user account.")
    var email:String? = null

    /**
    * Search by using the e-mail address of the user account that starts with the specified value.
    */
    @ApiMember(Description="Search by using the e-mail address of the user account that starts with the specified value.")
    var emailStartsWith:String? = null

    /**
    * Search by using the e-mail address of the user account that ends with the specified value.
    */
    @ApiMember(Description="Search by using the e-mail address of the user account that ends with the specified value.")
    var emailEndsWith:String? = null

    /**
    * Search by using the e-mail address of the user account that contains the specified value.
    */
    @ApiMember(Description="Search by using the e-mail address of the user account that contains the specified value.")
    var emailContains:String? = null

    /**
    * Search by using the display name that starts with the specified value.
    */
    @ApiMember(Description="Search by using the display name that starts with the specified value.")
    var displayNameStartsWith:String? = null

    /**
    * Search by using the display name that ends with the specified value.
    */
    @ApiMember(Description="Search by using the display name that ends with the specified value.")
    var displayNameEndsWith:String? = null

    /**
    * Search by using the display name that contains the specified value.
    */
    @ApiMember(Description="Search by using the display name that contains the specified value.")
    var displayNameContains:String? = null

    /**
    * Search with the profile URL of the user account.
    */
    @ApiMember(Description="Search with the profile URL of the user account.")
    var profileUrl:String? = null

    /**
    * Should the related products of the account be included in the retrieved accounts?
    */
    @ApiMember(Description="Should the related products of the account be included in the retrieved accounts?")
    var includeProducts:Boolean? = null

    /**
    * Should the related orders of the account be included in the retrieved accounts?
    */
    @ApiMember(Description="Should the related orders of the account be included in the retrieved accounts?")
    var includeOrders:Boolean? = null

    /**
    * 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. ")
    var skipProducts:Int? = null

    /**
    * 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. ")
    var takeProducts:Int? = null

    /**
    * 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. ")
    var skipOrders:Int? = null

    /**
    * 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. ")
    var takeOrders:Int? = null

    /**
    * The number of query results to skip.
    */
    @ApiMember(Description="The number of query results to skip.")
    var skip:Int? = null

    /**
    * The number of query results to include.
    */
    @ApiMember(Description="The number of query results to include.")
    var take:Int? = null
}

/**
* The number of query results to skip.
*/
@Api(Description="The number of query results to skip.")
open class PaginationBase : IPaginate
{
    /**
    * The number of query results to skip.
    */
    @ApiMember(Description="The number of query results to skip.")
    var skip:Int? = null

    /**
    * The number of query results to include.
    */
    @ApiMember(Description="The number of query results to include.")
    var take:Int? = null
}

/**
* 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.")
open class AccountQueryResponse : QueryResponse<Account>()
{
    /**
    * The dictionary of products associated to found user accounts.
    */
    @ApiMember(Description="The dictionary of products associated to found user accounts.")
    var productsMap:HashMap<Int,ArrayList<Product>> = HashMap<Int,ArrayList<Product>>()

    /**
    * The dictionary of orders associated with each found user account.
    */
    @ApiMember(Description="The dictionary of orders associated with each found user account.")
    var ordersMap:HashMap<Int,ArrayList<Order>> = HashMap<Int,ArrayList<Order>>()

    @DataMember(Order=1)
    var offset:Int? = null

    @DataMember(Order=2)
    var total:Int? = null

    @DataMember(Order=3)
    var results:ArrayList<Account> = ArrayList<Account>()

    @DataMember(Order=4)
    var meta:HashMap<String,String> = HashMap<String,String>()

    @DataMember(Order=5)
    var responseStatus:ResponseStatus? = null
}

@DataContract
open class QueryResponse<T>
{
    @DataMember(Order=1)
    var offset:Int? = null

    @DataMember(Order=2)
    var total:Int? = null

    @DataMember(Order=3)
    var results:ArrayList<T> = ArrayList<T>()

    @DataMember(Order=4)
    var meta:HashMap<String,String> = HashMap<String,String>()

    @DataMember(Order=5)
    var responseStatus:ResponseStatus? = null
}

/**
* Represents a user account.
*/
@Api(Description="Represents a user account.")
open class Account : IHasUserName
{
    /**
    * The unique identifier of the user account.
    */
    @ApiMember(Description="The unique identifier of the user account.", IsRequired=true)
    var id:Int? = 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)
    var index:Int? = 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)
    var refId:Int? = 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'.")
    var refIdStr:String? = null

    /**
    * The unique user name of the user account.
    */
    @ApiMember(Description="The unique user name of the user account.", IsRequired=true)
    var userName:String? = null

    /**
    * The electronic mail address of the user account.
    */
    @ApiMember(Description="The electronic mail address of the user account.")
    var email:String? = null

    /**
    * The friendly name of the user account.
    */
    @ApiMember(Description="The friendly name of the user account.")
    var displayName:String? = 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.")
    var firstName:String? = 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.")
    var lastName:String? = null

    /**
    * The unique identifier of the customer associated with this account.
    */
    @ApiMember(Description="The unique identifier of the customer associated with this account.")
    var fullName:String? = 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.")
    var gender:String? = null

    /**
    * The language of the owner of teh user account.
    */
    @ApiMember(Description="The language of the owner of teh user account.")
    var language:String? = null

    /**
    * The company, where the user is an employee.
    */
    @ApiMember(Description="The company, where the user is an employee.")
    var company:String? = null

    /**
    * The profile URL of the user account.
    */
    @ApiMember(Description="The profile URL of the user account.", IsRequired=true)
    var profileUrl:String? = null

    /**
    * The roles assigned to the user account.
    */
    @ApiMember(Description="The roles assigned to the user account.")
    var roles:ArrayList<String> = ArrayList<String>()

    /**
    * The permissions assigned to the user account.
    */
    @ApiMember(Description="The permissions assigned to the user account.")
    var permissions:ArrayList<String> = ArrayList<String>()

    /**
    * The primary e-mail address of the user.
    */
    @ApiMember(Description="The primary e-mail address of the user.")
    var primaryEmail:String? = null

    /**
    * Random data to enhance the security of the user password.
    */
    @ApiMember(Description="Random data to enhance the security of the user password.")
    var salt:String? = 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.")
    var passwordHash:String? = 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.")
    var digestHa1Hash:String? = 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.")
    var invalidLoginAttempts:Int? = null

    /**
    * The last time the user account attempted a sign in.
    */
    @ApiMember(Description="The last time the user account attempted a sign in.")
    var lastLoginAttempt:Date? = 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.")
    var lockedDate:Date? = null

    /**
    * The date and time when the user account was created.
    */
    @ApiMember(Description="The date and time when the user account was created.")
    var createdDate:Date? = 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.")
    var modifiedDate:Date? = null

    /**
    * The telephone number of the owner of the user account.
    */
    @ApiMember(Description="The telephone number of the owner of the user account.")
    var phoneNumber:String? = null

    /**
    * The birth date of the owner of the user account
    */
    @ApiMember(Description="The birth date of the owner of the user account")
    var birthDate:Date? = 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.")
    var birthDateRaw:String? = null

    /**
    * The mail address of the user account.
    */
    @ApiMember(Description="The mail address of the user account.")
    var address:String? = null

    /**
    * Additional information for the specified 'Address' of the user.
    */
    @ApiMember(Description="Additional information for the specified 'Address' of the user.")
    var address2:String? = null

    /**
    * The city of the owner of the user account.
    */
    @ApiMember(Description="The city of the owner of the user account.")
    var city:String? = null

    /**
    * The state of the owner of the user account.
    */
    @ApiMember(Description="The state of the owner of the user account.")
    var state:String? = 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'.")
    var country:String? = null

    /**
    * The locale of the user account.
    */
    @ApiMember(Description="The locale of the user account.")
    var culture:String? = null

    /**
    * The mail address of the user account.
    */
    @ApiMember(Description="The mail address of the user account.")
    var mailAddress:String? = null

    /**
    * The nickname of the user of the user account.
    */
    @ApiMember(Description="The nickname of the user of the user account.")
    var nickname:String? = null

    /**
    * The postal code of the user account.
    */
    @ApiMember(Description="The postal code of the user account.")
    var postalCode:String? = null

    /**
    * The time zone of the user of the user account.
    */
    @ApiMember(Description="The time zone of the user of the user account.")
    var timeZone:String? = null

    /**
    * Additional information to attach to the user account.
    */
    @ApiMember(Description="Additional information to attach to the user account.")
    var meta:HashMap<String,String> = HashMap<String,String>()
}

Kotlin SearchAccounts DTOs

GET /sync/accounts/search HTTP/1.1 
Host: taxfiling.staging.pwc.de 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
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":"\/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}]},"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":"\/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"}}}