Tax Filing Service

<back to all web services

AdminRetrieveAccountAsync

RetrieveAccountsAsync

RRepresents a service request from an admin user to retrieve an account in an asynchronous operation.

Requires Authentication
Required role:AdminRequired permission:CanAccess
The following routes are available for this service:
GET/async/accounts/{Id}

/** @description Specifies a service request from an admin user to retrieve an account. */
// @Api(Description="Specifies a service request from an admin user to retrieve an account.")
export class AdminRetrieveAccountBase implements IGet
{
    /** @description The unique identifier of the account. */
    // @ApiMember(Description="The unique identifier of the account.")
    public id?: number;

    /** @description The user name of the account. */
    // @ApiMember(Description="The user name of the account.")
    public userName?: string;

    /** @description Should the related products of the account be included in the retrieved account? */
    // @ApiMember(Description="Should the related products of the account be included in the retrieved account?")
    public includeProducts?: boolean;

    /** @description Should the related orders of the account be included in the retrieved account? */
    // @ApiMember(Description="Should the related orders of the account be included in the retrieved account?")
    public includeOrders?: boolean;

    /** @description Specifies the number of products to skip. Applicable only when 'IncludeProducts' is true.  */
    // @ApiMember(Description="Specifies the number of products to skip. Applicable only when 'IncludeProducts' is true. ")
    public skipProducts?: number;

    /** @description Specifies the number of products to include. Applicable only when 'IncludeProducts' is true.  */
    // @ApiMember(Description="Specifies the number of products to include. Applicable only when 'IncludeProducts' is true. ")
    public takeProducts?: number;

    /** @description Specifies the number of orders to skip. Applicable only when 'IncludeOrders' is true.  */
    // @ApiMember(Description="Specifies the number of orders to skip. Applicable only when 'IncludeOrders' is true. ")
    public skipOrders?: number;

    /** @description Specifies the number of orders to include. Applicable only when 'IncludeOrders' is true.  */
    // @ApiMember(Description="Specifies the number of orders to include. Applicable only when 'IncludeOrders' is true. ")
    public takeOrders?: number;

    public constructor(init?: Partial<AdminRetrieveAccountBase>) { (Object as any).assign(this, init); }
}

/** @description 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.")
export class ServiceResponseBase
{
    /** @description 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;

    public constructor(init?: Partial<ServiceResponseBase>) { (Object as any).assign(this, init); }
}

/** @description Represents a user account. */
// @Api(Description="Represents a user account.")
export class Account implements IHasUserName
{
    /** @description The unique identifier of the user account. */
    // @ApiMember(Description="The unique identifier of the user account.", IsRequired=true)
    public id: number;

    /** @description 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 index: number;

    /** @description 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 refId: number;

    /** @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'. */
    // @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 refIdStr?: string;

    /** @description The unique user name of the user account. */
    // @ApiMember(Description="The unique user name of the user account.", IsRequired=true)
    public userName: string;

    /** @description The electronic mail address of the user account. */
    // @ApiMember(Description="The electronic mail address of the user account.")
    public email?: string;

    /** @description The friendly name of the user account. */
    // @ApiMember(Description="The friendly name of the user account.")
    public displayName?: string;

    /** @description 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 firstName?: string;

    /** @description 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 lastName?: string;

    /** @description The unique identifier of the customer associated with this account. */
    // @ApiMember(Description="The unique identifier of the customer associated with this account.")
    public fullName?: string;

    /** @description 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 gender?: string;

    /** @description The language of the owner of teh user account. */
    // @ApiMember(Description="The language of the owner of teh user account.")
    public language?: string;

    /** @description The company, where the user is an employee. */
    // @ApiMember(Description="The company, where the user is an employee.")
    public company?: string;

    /** @description The profile URL of the user account. */
    // @ApiMember(Description="The profile URL of the user account.", IsRequired=true)
    public profileUrl: string;

    /** @description The roles assigned to the user account. */
    // @ApiMember(Description="The roles assigned to the user account.")
    public roles: string[];

    /** @description The permissions assigned to the user account. */
    // @ApiMember(Description="The permissions assigned to the user account.")
    public permissions: string[];

    /** @description The primary e-mail address of the user. */
    // @ApiMember(Description="The primary e-mail address of the user.")
    public primaryEmail?: string;

    /** @description Random data to enhance the security of the user password. */
    // @ApiMember(Description="Random data to enhance the security of the user password.")
    public salt?: string;

    /** @description 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 passwordHash?: string;

    /** @description 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 digestHa1Hash?: string;

    /** @description 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 invalidLoginAttempts: number;

    /** @description The last time the user account attempted a sign in. */
    // @ApiMember(Description="The last time the user account attempted a sign in.")
    public lastLoginAttempt?: string;

    /** @description 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 lockedDate?: string;

    /** @description The date and time when the user account was created. */
    // @ApiMember(Description="The date and time when the user account was created.")
    public createdDate: string;

    /** @description 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 modifiedDate: string;

    /** @description The telephone number of the owner of the user account. */
    // @ApiMember(Description="The telephone number of the owner of the user account.")
    public phoneNumber?: string;

    /** @description The birth date of the owner of the user account */
    // @ApiMember(Description="The birth date of the owner of the user account")
    public birthDate?: string;

    /** @description 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 birthDateRaw?: string;

    /** @description The mail address of the user account. */
    // @ApiMember(Description="The mail address of the user account.")
    public address?: string;

    /** @description Additional information for the specified 'Address' of the user. */
    // @ApiMember(Description="Additional information for the specified 'Address' of the user.")
    public address2?: string;

    /** @description The city of the owner of the user account. */
    // @ApiMember(Description="The city of the owner of the user account.")
    public city?: string;

    /** @description The state of the owner of the user account. */
    // @ApiMember(Description="The state of the owner of the user account.")
    public state?: string;

    /** @description 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 country?: string;

    /** @description The locale of the user account. */
    // @ApiMember(Description="The locale of the user account.")
    public culture?: string;

    /** @description The mail address of the user account. */
    // @ApiMember(Description="The mail address of the user account.")
    public mailAddress?: string;

    /** @description The nickname of the user of the user account. */
    // @ApiMember(Description="The nickname of the user of the user account.")
    public nickname?: string;

    /** @description The postal code of the user account. */
    // @ApiMember(Description="The postal code of the user account.")
    public postalCode?: string;

    /** @description The time zone of the user of the user account. */
    // @ApiMember(Description="The time zone of the user of the user account.")
    public timeZone?: string;

    /** @description Additional information to attach to the user account. */
    // @ApiMember(Description="Additional information to attach to the user account.")
    public meta?: { [index: string]: string; };

    public constructor(init?: Partial<Account>) { (Object as any).assign(this, init); }
}

/** @description Represents a product. */
// @Api(Description="Represents a product.")
export class Product implements IHasName
{
    /** @description The unique identifier of the product. */
    // @ApiMember(Description="The unique identifier of the product.", IsRequired=true)
    public id: number;

    /** @description 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 index: number;

    /** @description The name of the product. */
    // @ApiMember(Description="The name of the product.", IsRequired=true)
    // @Validate(Validator="NotEmpty")
    public name: string;

    /** @description The version of the product. */
    // @ApiMember(Description="The version of the product.", IsRequired=true)
    // @Validate(Validator="NotEmpty")
    public version: string;

    /** @description The version of the product. */
    // @ApiMember(Description="The version of the product.")
    public description?: string;

    /** @description Tags associated with the product. */
    // @ApiMember(Description="Tags associated with the product.")
    public tags: string[];

    public constructor(init?: Partial<Product>) { (Object as any).assign(this, init); }
}

/** @description Represents a commission to consume services. */
// @Api(Description="Represents a commission to consume services.")
export class Order implements IHasName
{
    /** @description The unique identifier of the order. */
    // @ApiMember(Description="The unique identifier of the order.", IsRequired=true)
    public id: number;

    /** @description 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 productId: number;

    /** @description 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 accountId: number;

    /** @description A name to identify the order. */
    // @ApiMember(Description="A name to identify the order.", IsRequired=true)
    // @Validate(Validator="NotEmpty")
    public name: string;

    /** @description 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 serviceName?: string;

    /** @description The time stamp at which the order was initiated. */
    // @ApiMember(Description="The time stamp at which the order was initiated.")
    public requestTimestamp?: string;

    /** @description The time stamp at which the order was completed. */
    // @ApiMember(Description="The time stamp at which the order was completed.")
    public responseTimestamp?: string;

    /** @description The URI from which the order was initiated. */
    // @ApiMember(Description="The URI from which the order was initiated.")
    public requestUri?: string;

    /** @description The HTTP method of the order request. */
    // @ApiMember(Description="The HTTP method of the order request.")
    public requestHttpMethod?: string;

    /** @description The duration of the order request. */
    // @ApiMember(Description="The duration of the order request.")
    public requestDuration?: string;

    /** @description The HTTP status code of the order request. */
    // @ApiMember(Description="The HTTP status code of the order request.")
    public responseStatusCode: HttpStatusCode;

    /** @description The IP address of client, who placed the order. */
    // @ApiMember(Description="The IP address of client, who placed the order.")
    public clientIPAddress?: string;

    /** @description The unit of measurement for the order. */
    // @ApiMember(Description="The unit of measurement for the order.")
    public unitOfMeasurement?: string;

    /** @description The type of process, for which the order is charged. */
    // @ApiMember(Description="The type of process, for which the order is charged.")
    public processType?: string;

    /** @description The type of data, for which the order is charged. */
    // @ApiMember(Description="The type of data, for which the order is charged.")
    public dataType?: string;

    /** @description 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 dataName?: string;

    /** @description The date of creation of the order. */
    // @ApiMember(Description="The date of creation of the order.")
    public creationDate: string;

    /** @description 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 expiryDate?: string;

    /** @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. */
    // @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 isTest: boolean;

    public constructor(init?: Partial<Order>) { (Object as any).assign(this, init); }
}

/** @description 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.")
export class AccountResponse extends ServiceResponseBase
{
    /** @description The user account encapsulated in the response. */
    // @ApiMember(Description="The user account encapsulated in the response.")
    public account?: Account;

    /** @description 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 index: number;

    /** @description The list of products associated with the encapsulated user account. */
    // @ApiMember(Description="The list of products associated with the encapsulated user account.")
    public products: Product[];

    /** @description The list of orders associated with the encapsulated user account. */
    // @ApiMember(Description="The list of orders associated with the encapsulated user account.")
    public orders: Order[];

    /** @description 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;

    public constructor(init?: Partial<AccountResponse>) { super(init); (Object as any).assign(this, init); }
}

/** @description RRepresents a service request from an admin user to retrieve an account in an asynchronous operation. */
// @Api(Description="RRepresents a service request from an admin user to retrieve an account in an asynchronous operation.")
export class AdminRetrieveAccountAsync extends AdminRetrieveAccountBase
{
    /** @description The unique identifier of the account. */
    // @ApiMember(Description="The unique identifier of the account.")
    public id?: number;

    /** @description The user name of the account. */
    // @ApiMember(Description="The user name of the account.")
    public userName?: string;

    /** @description Should the related products of the account be included in the retrieved account? */
    // @ApiMember(Description="Should the related products of the account be included in the retrieved account?")
    public includeProducts?: boolean;

    /** @description Should the related orders of the account be included in the retrieved account? */
    // @ApiMember(Description="Should the related orders of the account be included in the retrieved account?")
    public includeOrders?: boolean;

    /** @description Specifies the number of products to skip. Applicable only when 'IncludeProducts' is true.  */
    // @ApiMember(Description="Specifies the number of products to skip. Applicable only when 'IncludeProducts' is true. ")
    public skipProducts?: number;

    /** @description Specifies the number of products to include. Applicable only when 'IncludeProducts' is true.  */
    // @ApiMember(Description="Specifies the number of products to include. Applicable only when 'IncludeProducts' is true. ")
    public takeProducts?: number;

    /** @description Specifies the number of orders to skip. Applicable only when 'IncludeOrders' is true.  */
    // @ApiMember(Description="Specifies the number of orders to skip. Applicable only when 'IncludeOrders' is true. ")
    public skipOrders?: number;

    /** @description Specifies the number of orders to include. Applicable only when 'IncludeOrders' is true.  */
    // @ApiMember(Description="Specifies the number of orders to include. Applicable only when 'IncludeOrders' is true. ")
    public takeOrders?: number;

    public constructor(init?: Partial<AdminRetrieveAccountAsync>) { super(init); (Object as any).assign(this, init); }
}

TypeScript AdminRetrieveAccountAsync DTOs

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

HTTP + JSV

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

GET /async/accounts/{Id} HTTP/1.1 
Host: taxfiling.staging.pwc.de 
Accept: text/jsv
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
		}
	}
}