Tax Filing Service

<back to all web services

SearchAccounts

SearchAccountsSync

Represents a service to search for accounts.

Requires Authentication
Required role:AdminRequired permission:CanAccess
The following routes are available for this service:
GET/sync/accounts/search
"use strict";
export class PaginationBase {
    /** @param {{skip?:number,take?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?number}
     * @description The number of query results to skip. */
    skip;
    /**
     * @type {?number}
     * @description The number of query results to include. */
    take;
}
export class SearchAccountsBase extends PaginationBase {
    /** @param {{accountId?:number,customerId?:number,userName?:string,userNameStartsWith?:string,userNameEndsWith?:string,userNameContains?:string,displayName?:string,email?:string,emailStartsWith?:string,emailEndsWith?:string,emailContains?:string,displayNameStartsWith?:string,displayNameEndsWith?:string,displayNameContains?:string,profileUrl?:string,includeProducts?:boolean,includeOrders?:boolean,skipProducts?:number,takeProducts?:number,skipOrders?:number,takeOrders?:number,skip?:number,take?:number,skip?:number,take?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {?number}
     * @description The unique identifier of the user account. */
    accountId;
    /**
     * @type {?number}
     * @description The unique identifier of the customer associated with this account. */
    customerId;
    /**
     * @type {?string}
     * @description The user name of the user account. */
    userName;
    /**
     * @type {?string}
     * @description Search by using the user name that starts with the specified value. */
    userNameStartsWith;
    /**
     * @type {?string}
     * @description Search by using the user name that ends with the specified value. */
    userNameEndsWith;
    /**
     * @type {?string}
     * @description Search by using the user name that contains the specified value. */
    userNameContains;
    /**
     * @type {?string}
     * @description The display name of the user account. */
    displayName;
    /**
     * @type {?string}
     * @description The e-mail address of the user account. */
    email;
    /**
     * @type {?string}
     * @description Search by using the e-mail address of the user account that starts with the specified value. */
    emailStartsWith;
    /**
     * @type {?string}
     * @description Search by using the e-mail address of the user account that ends with the specified value. */
    emailEndsWith;
    /**
     * @type {?string}
     * @description Search by using the e-mail address of the user account that contains the specified value. */
    emailContains;
    /**
     * @type {?string}
     * @description Search by using the display name that starts with the specified value. */
    displayNameStartsWith;
    /**
     * @type {?string}
     * @description Search by using the display name that ends with the specified value. */
    displayNameEndsWith;
    /**
     * @type {?string}
     * @description Search by using the display name that contains the specified value. */
    displayNameContains;
    /**
     * @type {?string}
     * @description Search with the profile URL of the user account. */
    profileUrl;
    /**
     * @type {boolean}
     * @description Should the related products of the account be included in the retrieved accounts? */
    includeProducts;
    /**
     * @type {boolean}
     * @description Should the related orders of the account be included in the retrieved accounts? */
    includeOrders;
    /**
     * @type {?number}
     * @description Specifies the number of products to skip per account. Applicable only when 'IncludeProducts' is true.  */
    skipProducts;
    /**
     * @type {?number}
     * @description Specifies the number of products to include per account. Applicable only when 'IncludeProducts' is true.  */
    takeProducts;
    /**
     * @type {?number}
     * @description Specifies the number of orders to skip per account. Applicable only when 'IncludeOrders' is true.  */
    skipOrders;
    /**
     * @type {?number}
     * @description Specifies the number of orders to include per account. Applicable only when 'IncludeOrders' is true.  */
    takeOrders;
    /**
     * @type {?number}
     * @description The number of query results to skip. */
    skip;
    /**
     * @type {?number}
     * @description The number of query results to include. */
    take;
}
export class Account {
    /** @param {{id?:number,index?:number,refId?:number,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?:number,lastLoginAttempt?:string,lockedDate?:string,createdDate?:string,modifiedDate?:string,phoneNumber?:string,birthDate?:string,birthDateRaw?:string,address?:string,address2?:string,city?:string,state?:string,country?:string,culture?:string,mailAddress?:string,nickname?:string,postalCode?:string,timeZone?:string,meta?:{ [index: string]: string; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The unique identifier of the user account. */
    id;
    /**
     * @type {number}
     * @description The position of this instance in a collection of 'Account' instances */
    index;
    /**
     * @type {number}
     * @description The unique identifier of the customer associated with this account. */
    refId;
    /**
     * @type {?string}
     * @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'. */
    refIdStr;
    /**
     * @type {string}
     * @description The unique user name of the user account. */
    userName;
    /**
     * @type {?string}
     * @description The electronic mail address of the user account. */
    email;
    /**
     * @type {?string}
     * @description The friendly name of the user account. */
    displayName;
    /**
     * @type {?string}
     * @description The first name of the owner (natural person) of the user account. */
    firstName;
    /**
     * @type {?string}
     * @description The last name of the owner (natural person) of the user account. */
    lastName;
    /**
     * @type {?string}
     * @description The unique identifier of the customer associated with this account. */
    fullName;
    /**
     * @type {?string}
     * @description The gender of the owner (natural person) of the user account. */
    gender;
    /**
     * @type {?string}
     * @description The language of the owner of teh user account. */
    language;
    /**
     * @type {?string}
     * @description The company, where the user is an employee. */
    company;
    /**
     * @type {string}
     * @description The profile URL of the user account. */
    profileUrl;
    /**
     * @type {string[]}
     * @description The roles assigned to the user account. */
    roles;
    /**
     * @type {string[]}
     * @description The permissions assigned to the user account. */
    permissions;
    /**
     * @type {?string}
     * @description The primary e-mail address of the user. */
    primaryEmail;
    /**
     * @type {?string}
     * @description Random data to enhance the security of the user password. */
    salt;
    /**
     * @type {?string}
     * @description The hash value of the user password that the PBKDF2 algorithm produces. */
    passwordHash;
    /**
     * @type {?string}
     * @description The hash value of the user password that the DigestHa1 algorithm produces. */
    digestHa1Hash;
    /**
     * @type {number}
     * @description The number of times the user account tried to sign in but failed. */
    invalidLoginAttempts;
    /**
     * @type {?string}
     * @description The last time the user account attempted a sign in. */
    lastLoginAttempt;
    /**
     * @type {?string}
     * @description The date and time when the user acount was denied access. */
    lockedDate;
    /**
     * @type {string}
     * @description The date and time when the user account was created. */
    createdDate;
    /**
     * @type {string}
     * @description The date and time when the user account was last modified. */
    modifiedDate;
    /**
     * @type {?string}
     * @description The telephone number of the owner of the user account. */
    phoneNumber;
    /**
     * @type {?string}
     * @description The birth date of the owner of the user account */
    birthDate;
    /**
     * @type {?string}
     * @description The string representation of the birth date of the user account. */
    birthDateRaw;
    /**
     * @type {?string}
     * @description The mail address of the user account. */
    address;
    /**
     * @type {?string}
     * @description Additional information for the specified 'Address' of the user. */
    address2;
    /**
     * @type {?string}
     * @description The city of the owner of the user account. */
    city;
    /**
     * @type {?string}
     * @description The state of the owner of the user account. */
    state;
    /**
     * @type {?string}
     * @description The country of the owner of the user account. It is recommended to use the name of the associated 'Customer'. */
    country;
    /**
     * @type {?string}
     * @description The locale of the user account. */
    culture;
    /**
     * @type {?string}
     * @description The mail address of the user account. */
    mailAddress;
    /**
     * @type {?string}
     * @description The nickname of the user of the user account. */
    nickname;
    /**
     * @type {?string}
     * @description The postal code of the user account. */
    postalCode;
    /**
     * @type {?string}
     * @description The time zone of the user of the user account. */
    timeZone;
    /**
     * @type {?{ [index: string]: string; }}
     * @description Additional information to attach to the user account. */
    meta;
}
export class AccountQueryResponse extends QueryResponse {
    /** @param {{productsMap?:{ [index: number]: Product[]; },ordersMap?:{ [index: number]: Order[]; },offset?:number,total?:number,results?:Account[],meta?:{ [index: string]: string; },responseStatus?:ResponseStatus,offset?:number,total?:number,results?:T[],meta?:{ [index: string]: string; },responseStatus?:ResponseStatus}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {{ [index: number]: Product[]; }}
     * @description The dictionary of products associated to found user accounts. */
    productsMap;
    /**
     * @type {{ [index: number]: Order[]; }}
     * @description The dictionary of orders associated with each found user account. */
    ordersMap;
    /** @type {number} */
    offset;
    /** @type {number} */
    total;
    /** @type {Account[]} */
    results;
    /** @type {{ [index: string]: string; }} */
    meta;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class SearchAccounts extends SearchAccountsBase {
    /** @param {{accountId?:number,customerId?:number,userName?:string,userNameStartsWith?:string,userNameEndsWith?:string,userNameContains?:string,displayName?:string,email?:string,emailStartsWith?:string,emailEndsWith?:string,emailContains?:string,displayNameStartsWith?:string,displayNameEndsWith?:string,displayNameContains?:string,profileUrl?:string,includeProducts?:boolean,includeOrders?:boolean,skipProducts?:number,takeProducts?:number,skipOrders?:number,takeOrders?:number,skip?:number,take?:number,accountId?:number,customerId?:number,userName?:string,userNameStartsWith?:string,userNameEndsWith?:string,userNameContains?:string,displayName?:string,email?:string,emailStartsWith?:string,emailEndsWith?:string,emailContains?:string,displayNameStartsWith?:string,displayNameEndsWith?:string,displayNameContains?:string,profileUrl?:string,includeProducts?:boolean,includeOrders?:boolean,skipProducts?:number,takeProducts?:number,skipOrders?:number,takeOrders?:number,skip?:number,take?:number,skip?:number,take?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {?number}
     * @description The unique identifier of the user account. */
    accountId;
    /**
     * @type {?number}
     * @description The unique identifier of the customer associated with this account. */
    customerId;
    /**
     * @type {?string}
     * @description The user name of the user account. */
    userName;
    /**
     * @type {?string}
     * @description Search by using the user name that starts with the specified value. */
    userNameStartsWith;
    /**
     * @type {?string}
     * @description Search by using the user name that ends with the specified value. */
    userNameEndsWith;
    /**
     * @type {?string}
     * @description Search by using the user name that contains the specified value. */
    userNameContains;
    /**
     * @type {?string}
     * @description The display name of the user account. */
    displayName;
    /**
     * @type {?string}
     * @description The e-mail address of the user account. */
    email;
    /**
     * @type {?string}
     * @description Search by using the e-mail address of the user account that starts with the specified value. */
    emailStartsWith;
    /**
     * @type {?string}
     * @description Search by using the e-mail address of the user account that ends with the specified value. */
    emailEndsWith;
    /**
     * @type {?string}
     * @description Search by using the e-mail address of the user account that contains the specified value. */
    emailContains;
    /**
     * @type {?string}
     * @description Search by using the display name that starts with the specified value. */
    displayNameStartsWith;
    /**
     * @type {?string}
     * @description Search by using the display name that ends with the specified value. */
    displayNameEndsWith;
    /**
     * @type {?string}
     * @description Search by using the display name that contains the specified value. */
    displayNameContains;
    /**
     * @type {?string}
     * @description Search with the profile URL of the user account. */
    profileUrl;
    /**
     * @type {boolean}
     * @description Should the related products of the account be included in the retrieved accounts? */
    includeProducts;
    /**
     * @type {boolean}
     * @description Should the related orders of the account be included in the retrieved accounts? */
    includeOrders;
    /**
     * @type {?number}
     * @description Specifies the number of products to skip per account. Applicable only when 'IncludeProducts' is true.  */
    skipProducts;
    /**
     * @type {?number}
     * @description Specifies the number of products to include per account. Applicable only when 'IncludeProducts' is true.  */
    takeProducts;
    /**
     * @type {?number}
     * @description Specifies the number of orders to skip per account. Applicable only when 'IncludeOrders' is true.  */
    skipOrders;
    /**
     * @type {?number}
     * @description Specifies the number of orders to include per account. Applicable only when 'IncludeOrders' is true.  */
    takeOrders;
    /**
     * @type {?number}
     * @description The number of query results to skip. */
    skip;
    /**
     * @type {?number}
     * @description The number of query results to include. */
    take;
}
/** @typedef T {any} */
export class QueryResponse {
    /** @param {{offset?:number,total?:number,results?:T[],meta?:{ [index: string]: string; },responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    offset;
    /** @type {number} */
    total;
    /** @type {T[]} */
    results;
    /** @type {{ [index: string]: string; }} */
    meta;
    /** @type {ResponseStatus} */
    responseStatus;
}

JavaScript SearchAccounts DTOs

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 /sync/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"}}}