Tax Filing Service

<back to all web services

SearchAccountsAsync

SearchAccountsAsync

Represents a service to search for accounts in an asynchronous operation.

Requires Authentication
Required role:AdminRequired permission:CanAccess
The following routes are available for this service:
GET/async/accounts/search
SearchAccountsAsync Parameters:
NameParameterData TypeRequiredDescription
AccountIdqueryint?NoThe unique identifier of the user account.
CustomerIdqueryint?NoThe unique identifier of the customer associated with this account.
UserNamequerystringNoThe user name of the user account.
UserNameStartsWithquerystringNoSearch by using the user name that starts with the specified value.
UserNameEndsWithquerystringNoSearch by using the user name that ends with the specified value.
UserNameContainsquerystringNoSearch by using the user name that contains the specified value.
DisplayNamequerystringNoThe display name of the user account.
EmailquerystringNoThe e-mail address of the user account.
EmailStartsWithquerystringNoSearch by using the e-mail address of the user account that starts with the specified value.
EmailEndsWithquerystringNoSearch by using the e-mail address of the user account that ends with the specified value.
EmailContainsquerystringNoSearch by using the e-mail address of the user account that contains the specified value.
DisplayNameStartsWithquerystringNoSearch by using the display name that starts with the specified value.
DisplayNameEndsWithquerystringNoSearch by using the display name that ends with the specified value.
DisplayNameContainsquerystringNoSearch by using the display name that contains the specified value.
ProfileUrlquerystringNoSearch with the profile URL of the user account.
IncludeProductsqueryboolNoShould the related products of the account be included in the retrieved accounts?
IncludeOrdersqueryboolNoShould the related orders of the account be included in the retrieved accounts?
SkipProductsqueryint?NoSpecifies the number of products to skip per account. Applicable only when 'IncludeProducts' is true.
TakeProductsqueryint?NoSpecifies the number of products to include per account. Applicable only when 'IncludeProducts' is true.
SkipOrdersqueryint?NoSpecifies the number of orders to skip per account. Applicable only when 'IncludeOrders' is true.
TakeOrdersqueryint?NoSpecifies the number of orders to include per account. Applicable only when 'IncludeOrders' is true.
Skipqueryint?NoThe number of query results to skip.
Takequeryint?NoThe number of query results to include.
SearchAccountsBase Parameters:
NameParameterData TypeRequiredDescription
AccountIdformint?NoThe unique identifier of the user account.
CustomerIdformint?NoThe unique identifier of the customer associated with this account.
UserNameformstringNoThe user name of the user account.
UserNameStartsWithformstringNoSearch by using the user name that starts with the specified value.
UserNameEndsWithformstringNoSearch by using the user name that ends with the specified value.
UserNameContainsformstringNoSearch by using the user name that contains the specified value.
DisplayNameformstringNoThe display name of the user account.
EmailformstringNoThe e-mail address of the user account.
EmailStartsWithformstringNoSearch by using the e-mail address of the user account that starts with the specified value.
EmailEndsWithformstringNoSearch by using the e-mail address of the user account that ends with the specified value.
EmailContainsformstringNoSearch by using the e-mail address of the user account that contains the specified value.
DisplayNameStartsWithformstringNoSearch by using the display name that starts with the specified value.
DisplayNameEndsWithformstringNoSearch by using the display name that ends with the specified value.
DisplayNameContainsformstringNoSearch by using the display name that contains the specified value.
ProfileUrlformstringNoSearch with the profile URL of the user account.
IncludeProductsformboolNoShould the related products of the account be included in the retrieved accounts?
IncludeOrdersformboolNoShould the related orders of the account be included in the retrieved accounts?
SkipProductsformint?NoSpecifies the number of products to skip per account. Applicable only when 'IncludeProducts' is true.
TakeProductsformint?NoSpecifies the number of products to include per account. Applicable only when 'IncludeProducts' is true.
SkipOrdersformint?NoSpecifies the number of orders to skip per account. Applicable only when 'IncludeOrders' is true.
TakeOrdersformint?NoSpecifies the number of orders to include per account. Applicable only when 'IncludeOrders' is true.
Skipformint?NoThe number of query results to skip.
Takeformint?NoThe number of query results to include.
PaginationBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?NoThe number of query results to skip.
Takeformint?NoThe number of query results to include.
AccountQueryResponse Parameters:
NameParameterData TypeRequiredDescription
ProductsMapformDictionary<int, List<Product>>YesThe dictionary of products associated to found user accounts.
OrdersMapformDictionary<int, List<Order>>YesThe dictionary of orders associated with each found user account.
OffsetformintNo
TotalformintNo
ResultsformList<Account>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
Account Parameters:
NameParameterData TypeRequiredDescription
IdformintYesThe unique identifier of the user account.
IndexformintYesThe position of this instance in a collection of 'Account' instances
RefIdformint?YesThe unique identifier of the customer associated with this account.
RefIdStrformstringNoThe string representation of the unique identifier of a reference that associates with this user account. This should have the same value as 'RefId'.
UserNameformstringYesThe unique user name of the user account.
EmailformstringNoThe electronic mail address of the user account.
DisplayNameformstringNoThe friendly name of the user account.
FirstNameformstringNoThe first name of the owner (natural person) of the user account.
LastNameformstringNoThe last name of the owner (natural person) of the user account.
FullNameformstringNoThe unique identifier of the customer associated with this account.
GenderformstringNoThe gender of the owner (natural person) of the user account.
LanguageformstringNoThe language of the owner of teh user account.
CompanyformstringNoThe company, where the user is an employee.
ProfileUrlformstringYesThe profile URL of the user account.
RolesformList<string>YesThe roles assigned to the user account.
PermissionsformList<string>YesThe permissions assigned to the user account.
PrimaryEmailformstringNoThe primary e-mail address of the user.
SaltformstringNoRandom data to enhance the security of the user password.
PasswordHashformstringNoThe hash value of the user password that the PBKDF2 algorithm produces.
DigestHa1HashformstringNoThe hash value of the user password that the DigestHa1 algorithm produces.
InvalidLoginAttemptsformintNoThe number of times the user account tried to sign in but failed.
LastLoginAttemptformDateTime?NoThe last time the user account attempted a sign in.
LockedDateformDateTime?NoThe date and time when the user acount was denied access.
CreatedDateformDateTimeNoThe date and time when the user account was created.
ModifiedDateformDateTimeNoThe date and time when the user account was last modified.
PhoneNumberformstringNoThe telephone number of the owner of the user account.
BirthDateformDateTime?NoThe birth date of the owner of the user account
BirthDateRawformstringNoThe string representation of the birth date of the user account.
AddressformstringNoThe mail address of the user account.
Address2formstringNoAdditional information for the specified 'Address' of the user.
CityformstringNoThe city of the owner of the user account.
StateformstringNoThe state of the owner of the user account.
CountryformstringNoThe country of the owner of the user account. It is recommended to use the name of the associated 'Customer'.
CultureformstringNoThe locale of the user account.
MailAddressformstringNoThe mail address of the user account.
NicknameformstringNoThe nickname of the user of the user account.
PostalCodeformstringNoThe postal code of the user account.
TimeZoneformstringNoThe time zone of the user of the user account.
MetaformDictionary<string, string>NoAdditional information to attach to the user account.

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /async/accounts/search HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}