Tax Filing Service
| Required role: | AllowAnyUser | Required permission: | CanAccess |
| GET | /sync/orders/search |
|---|
/** @description The number of query results to skip. */
// @Api(Description="The number of query results to skip.")
export class PaginationBase implements IPaginate
{
/** @description The number of query results to skip. */
// @ApiMember(Description="The number of query results to skip.")
public skip?: number;
/** @description The number of query results to include. */
// @ApiMember(Description="The number of query results to include.")
public take?: number;
public constructor(init?: Partial<PaginationBase>) { (Object as any).assign(this, init); }
}
/** @description Represents a specific time interval, within which, an action was carried out. */
export enum PeriodMode
{
Today = 'Today',
Yesterday = 'Yesterday',
LastWeek = 'LastWeek',
Last30Days = 'Last30Days',
Last90Days = 'Last90Days',
Last180Days = 'Last180Days',
}
/** @description Specifies a service request from a standard user to search for orders. */
// @Api(Description="Specifies a service request from a standard user to search for orders.")
export class SearchOrdersBase extends PaginationBase implements IGet
{
/** @description The user name of the account. */
// @ApiMember(Description="The user name of the account.")
public userName?: string;
/** @description The name of the order. */
// @ApiMember(Description="The name of the order.")
public name?: string;
/** @description Search by using the name of the order that starts with the specified value. */
// @ApiMember(Description="Search by using the name of the order that starts with the specified value.")
public nameStartsWith?: string;
/** @description Search by using the name of the order that ends with the specified value. */
// @ApiMember(Description="Search by using the name of the order that ends with the specified value.")
public nameEndsWith?: string;
/** @description Search by using the name of the order that contains the specified value. */
// @ApiMember(Description="Search by using the name of the order that contains the specified value.")
public nameContains?: string;
/** @description Search by using the name of the order that contains the specified value. */
// @ApiMember(Description="Search by using the name of the order that contains the specified value.")
public serviceName?: string;
/** @description Search by using the service name of the order that starts with the specified value. */
// @ApiMember(Description="Search by using the service name of the order that starts with the specified value.")
public serviceNameStartsWith?: string;
/** @description Search by using the service name of the order that ends with the specified value. */
// @ApiMember(Description="Search by using the service name of the order that ends with the specified value.")
public serviceNameEndsWith?: string;
/** @description Search by using the service name of the order that contains the specified value. */
// @ApiMember(Description="Search by using the service name of the order that contains the specified value.")
public serviceNameContains?: string;
/** @description Search for orders placed before a certain date and time. The specified date is included in the search. */
// @ApiMember(Description="Search for orders placed before a certain date and time. The specified date is included in the search.")
public before?: string;
/** @description Search for orders placed after a certain date and time. The specified date is included in the search. */
// @ApiMember(Description="Search for orders placed after a certain date and time. The specified date is included in the search.")
public after?: string;
/** @description Search for orders placed within a date and time period. The specified date is the start of the period and it is included in the search. */
// @ApiMember(Description="Search for orders placed within a date and time period. The specified date is the start of the period and it is included in the search.")
public periodStartDate?: string;
/** @description Search for orders placed within a date and time period. The specified date is the start of the period and it is included in the search. */
// @ApiMember(Description="Search for orders placed within a date and time period. The specified date is the start of the period and it is included in the search.")
public periodEndDate?: string;
/** @description Search for orders placed within the last 180 days. Today is included in the search. */
// @ApiMember(Description="Search for orders placed within the last 180 days. Today is included in the search.")
public periodMode?: PeriodMode;
/** @description Was the order request successful? */
// @ApiMember(Description="Was the order request successful?")
public orderRequestSucceeded?: boolean;
/** @description The unit of measurement for the order. */
// @ApiMember(Description="The unit of measurement for the order.")
public unitOfMeasurement?: string;
/** @description Search by using the unit of measurement of the order that starts with the specified value. */
// @ApiMember(Description="Search by using the unit of measurement of the order that starts with the specified value.")
public unitOfMeasurementStartsWith?: string;
/** @description Search by using the unit of measurement of the order that ends with the specified value. */
// @ApiMember(Description="Search by using the unit of measurement of the order that ends with the specified value.")
public unitOfMeasurementEndsWith?: string;
/** @description Search by using the unit of measurement of the order that contains the specified value. */
// @ApiMember(Description="Search by using the unit of measurement of the order that contains the specified value.")
public unitOfMeasurementContains?: 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 Search by using the process type of the order that starts with the specified value. */
// @ApiMember(Description="Search by using the process type of the order that starts with the specified value.")
public processTypeStartsWith?: string;
/** @description Search by using the process type of the order that ends with the specified value. */
// @ApiMember(Description="Search by using the process type of the order that ends with the specified value.")
public processTypeEndsWith?: string;
/** @description Search by using the process type of the order that contains the specified value. */
// @ApiMember(Description="Search by using the process type of the order that contains the specified value.")
public processTypeContains?: 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 Search by using the type of data, for which the order is charged that starts with the specified value. */
// @ApiMember(Description="Search by using the type of data, for which the order is charged that starts with the specified value.")
public dataTypeStartsWith?: string;
/** @description Search by using the type of data, for which the order is charged that ends with the specified value. */
// @ApiMember(Description="Search by using the type of data, for which the order is charged that ends with the specified value.")
public dataTypeEndsWith?: string;
/** @description Search by using the type of data, for which the order is charged that contains the specified value. */
// @ApiMember(Description="Search by using the type of data, for which the order is charged that contains the specified value.")
public dataTypeContains?: 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 Search by using the name of data, for which the order is charged that starts with the specified value. */
// @ApiMember(Description="Search by using the name of data, for which the order is charged that starts with the specified value.")
public dataNameStartsWith?: string;
/** @description Search by using the name of data, for which the order is charged that ends with the specified value. */
// @ApiMember(Description="Search by using the name of data, for which the order is charged that ends with the specified value.")
public dataNameEndsWith?: string;
/** @description Search by using the name of data, for which the order is charged that contains the specified value. */
// @ApiMember(Description="Search by using the name of data, for which the order is charged that contains the specified value.")
public dataNameContains?: string;
/** @description The number of query results to skip. */
// @ApiMember(Description="The number of query results to skip.")
public skip?: number;
/** @description The number of query results to include. */
// @ApiMember(Description="The number of query results to include.")
public take?: number;
public constructor(init?: Partial<SearchOrdersBase>) { super(init); (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 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.")
export class OrderQueryResponse extends QueryResponse<Order>
{
// @DataMember(Order=1)
public offset: number;
// @DataMember(Order=2)
public total: number;
// @DataMember(Order=3)
public results: Order[];
// @DataMember(Order=4)
public meta: { [index: string]: string; };
// @DataMember(Order=5)
public responseStatus: ResponseStatus;
public constructor(init?: Partial<OrderQueryResponse>) { super(init); (Object as any).assign(this, init); }
}
/** @description Represents a service request from a standard user to search for orders. */
// @Api(Description="Represents a service request from a standard user to search for orders.")
export class SearchOrders extends SearchOrdersBase
{
/** @description The user name of the account. */
// @ApiMember(Description="The user name of the account.")
public userName?: string;
/** @description The name of the order. */
// @ApiMember(Description="The name of the order.")
public name?: string;
/** @description Search by using the name of the order that starts with the specified value. */
// @ApiMember(Description="Search by using the name of the order that starts with the specified value.")
public nameStartsWith?: string;
/** @description Search by using the name of the order that ends with the specified value. */
// @ApiMember(Description="Search by using the name of the order that ends with the specified value.")
public nameEndsWith?: string;
/** @description Search by using the name of the order that contains the specified value. */
// @ApiMember(Description="Search by using the name of the order that contains the specified value.")
public nameContains?: string;
/** @description Search by using the name of the order that contains the specified value. */
// @ApiMember(Description="Search by using the name of the order that contains the specified value.")
public serviceName?: string;
/** @description Search by using the service name of the order that starts with the specified value. */
// @ApiMember(Description="Search by using the service name of the order that starts with the specified value.")
public serviceNameStartsWith?: string;
/** @description Search by using the service name of the order that ends with the specified value. */
// @ApiMember(Description="Search by using the service name of the order that ends with the specified value.")
public serviceNameEndsWith?: string;
/** @description Search by using the service name of the order that contains the specified value. */
// @ApiMember(Description="Search by using the service name of the order that contains the specified value.")
public serviceNameContains?: string;
/** @description Search for orders placed before a certain date and time. The specified date is included in the search. */
// @ApiMember(Description="Search for orders placed before a certain date and time. The specified date is included in the search.")
public before?: string;
/** @description Search for orders placed after a certain date and time. The specified date is included in the search. */
// @ApiMember(Description="Search for orders placed after a certain date and time. The specified date is included in the search.")
public after?: string;
/** @description Search for orders placed within a date and time period. The specified date is the start of the period and it is included in the search. */
// @ApiMember(Description="Search for orders placed within a date and time period. The specified date is the start of the period and it is included in the search.")
public periodStartDate?: string;
/** @description Search for orders placed within a date and time period. The specified date is the start of the period and it is included in the search. */
// @ApiMember(Description="Search for orders placed within a date and time period. The specified date is the start of the period and it is included in the search.")
public periodEndDate?: string;
/** @description Search for orders placed within the last 180 days. Today is included in the search. */
// @ApiMember(Description="Search for orders placed within the last 180 days. Today is included in the search.")
public periodMode?: PeriodMode;
/** @description Was the order request successful? */
// @ApiMember(Description="Was the order request successful?")
public orderRequestSucceeded?: boolean;
/** @description The unit of measurement for the order. */
// @ApiMember(Description="The unit of measurement for the order.")
public unitOfMeasurement?: string;
/** @description Search by using the unit of measurement of the order that starts with the specified value. */
// @ApiMember(Description="Search by using the unit of measurement of the order that starts with the specified value.")
public unitOfMeasurementStartsWith?: string;
/** @description Search by using the unit of measurement of the order that ends with the specified value. */
// @ApiMember(Description="Search by using the unit of measurement of the order that ends with the specified value.")
public unitOfMeasurementEndsWith?: string;
/** @description Search by using the unit of measurement of the order that contains the specified value. */
// @ApiMember(Description="Search by using the unit of measurement of the order that contains the specified value.")
public unitOfMeasurementContains?: 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 Search by using the process type of the order that starts with the specified value. */
// @ApiMember(Description="Search by using the process type of the order that starts with the specified value.")
public processTypeStartsWith?: string;
/** @description Search by using the process type of the order that ends with the specified value. */
// @ApiMember(Description="Search by using the process type of the order that ends with the specified value.")
public processTypeEndsWith?: string;
/** @description Search by using the process type of the order that contains the specified value. */
// @ApiMember(Description="Search by using the process type of the order that contains the specified value.")
public processTypeContains?: 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 Search by using the type of data, for which the order is charged that starts with the specified value. */
// @ApiMember(Description="Search by using the type of data, for which the order is charged that starts with the specified value.")
public dataTypeStartsWith?: string;
/** @description Search by using the type of data, for which the order is charged that ends with the specified value. */
// @ApiMember(Description="Search by using the type of data, for which the order is charged that ends with the specified value.")
public dataTypeEndsWith?: string;
/** @description Search by using the type of data, for which the order is charged that contains the specified value. */
// @ApiMember(Description="Search by using the type of data, for which the order is charged that contains the specified value.")
public dataTypeContains?: 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 Search by using the name of data, for which the order is charged that starts with the specified value. */
// @ApiMember(Description="Search by using the name of data, for which the order is charged that starts with the specified value.")
public dataNameStartsWith?: string;
/** @description Search by using the name of data, for which the order is charged that ends with the specified value. */
// @ApiMember(Description="Search by using the name of data, for which the order is charged that ends with the specified value.")
public dataNameEndsWith?: string;
/** @description Search by using the name of data, for which the order is charged that contains the specified value. */
// @ApiMember(Description="Search by using the name of data, for which the order is charged that contains the specified value.")
public dataNameContains?: string;
/** @description The number of query results to skip. */
// @ApiMember(Description="The number of query results to skip.")
public skip?: number;
/** @description The number of query results to include. */
// @ApiMember(Description="The number of query results to include.")
public take?: number;
public constructor(init?: Partial<SearchOrders>) { super(init); (Object as any).assign(this, init); }
}
// @DataContract
export class QueryResponse<T>
{
// @DataMember(Order=1)
public offset: number;
// @DataMember(Order=2)
public total: number;
// @DataMember(Order=3)
public results: T[];
// @DataMember(Order=4)
public meta: { [index: string]: string; };
// @DataMember(Order=5)
public responseStatus: ResponseStatus;
public constructor(init?: Partial<QueryResponse<T>>) { (Object as any).assign(this, init); }
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .x-msgpack suffix or ?format=x-msgpack
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /sync/orders/search HTTP/1.1 Host: taxfiling.pwc.de Accept: application/x-msgpack
HTTP/1.1 200 OK
Content-Type: application/x-msgpack
Content-Length: length
{"offset":0,"total":0,"results":[{"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}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}