Tax Filing Service
| Required role: | AllowAnyUser | Required permission: | CanAccess |
| GET | /sync/orders/search |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
/**
* 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.")
public static class SearchOrders extends SearchOrdersBase
{
/**
* The user name of the account.
*/
@ApiMember(Description="The user name of the account.")
public String userName = null;
/**
* The name of the order.
*/
@ApiMember(Description="The name of the order.")
public String name = null;
/**
* 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 String nameStartsWith = null;
/**
* 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 String nameEndsWith = null;
/**
* 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 String nameContains = null;
/**
* 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 String serviceName = null;
/**
* 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 String serviceNameStartsWith = null;
/**
* 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 String serviceNameEndsWith = null;
/**
* 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 String serviceNameContains = null;
/**
* 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 Date before = null;
/**
* 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 Date after = null;
/**
* 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 Date periodStartDate = null;
/**
* 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 Date periodEndDate = null;
/**
* 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 = null;
/**
* Was the order request successful?
*/
@ApiMember(Description="Was the order request successful?")
public Boolean orderRequestSucceeded = null;
/**
* The unit of measurement for the order.
*/
@ApiMember(Description="The unit of measurement for the order.")
public String unitOfMeasurement = null;
/**
* 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 String unitOfMeasurementStartsWith = null;
/**
* 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 String unitOfMeasurementEndsWith = null;
/**
* 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 String unitOfMeasurementContains = null;
/**
* The type of process, for which the order is charged.
*/
@ApiMember(Description="The type of process, for which the order is charged.")
public String processType = null;
/**
* 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 String processTypeStartsWith = null;
/**
* 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 String processTypeEndsWith = null;
/**
* 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 String processTypeContains = null;
/**
* The type of data, for which the order is charged.
*/
@ApiMember(Description="The type of data, for which the order is charged.")
public String dataType = null;
/**
* 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 String dataTypeStartsWith = null;
/**
* 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 String dataTypeEndsWith = null;
/**
* 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 String dataTypeContains = null;
/**
* 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 String dataName = null;
/**
* 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 String dataNameStartsWith = null;
/**
* 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 String dataNameEndsWith = null;
/**
* 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 String dataNameContains = null;
/**
* The number of query results to skip.
*/
@ApiMember(Description="The number of query results to skip.")
public Integer skip = null;
/**
* The number of query results to include.
*/
@ApiMember(Description="The number of query results to include.")
public Integer take = null;
public String getUserName() { return userName; }
public SearchOrders setUserName(String value) { this.userName = value; return this; }
public String getName() { return name; }
public SearchOrders setName(String value) { this.name = value; return this; }
public String getNameStartsWith() { return nameStartsWith; }
public SearchOrders setNameStartsWith(String value) { this.nameStartsWith = value; return this; }
public String getNameEndsWith() { return nameEndsWith; }
public SearchOrders setNameEndsWith(String value) { this.nameEndsWith = value; return this; }
public String getNameContains() { return nameContains; }
public SearchOrders setNameContains(String value) { this.nameContains = value; return this; }
public String getServiceName() { return serviceName; }
public SearchOrders setServiceName(String value) { this.serviceName = value; return this; }
public String getServiceNameStartsWith() { return serviceNameStartsWith; }
public SearchOrders setServiceNameStartsWith(String value) { this.serviceNameStartsWith = value; return this; }
public String getServiceNameEndsWith() { return serviceNameEndsWith; }
public SearchOrders setServiceNameEndsWith(String value) { this.serviceNameEndsWith = value; return this; }
public String getServiceNameContains() { return serviceNameContains; }
public SearchOrders setServiceNameContains(String value) { this.serviceNameContains = value; return this; }
public Date getBefore() { return before; }
public SearchOrders setBefore(Date value) { this.before = value; return this; }
public Date getAfter() { return after; }
public SearchOrders setAfter(Date value) { this.after = value; return this; }
public Date getPeriodStartDate() { return periodStartDate; }
public SearchOrders setPeriodStartDate(Date value) { this.periodStartDate = value; return this; }
public Date getPeriodEndDate() { return periodEndDate; }
public SearchOrders setPeriodEndDate(Date value) { this.periodEndDate = value; return this; }
public PeriodMode getPeriodMode() { return periodMode; }
public SearchOrders setPeriodMode(PeriodMode value) { this.periodMode = value; return this; }
public Boolean isOrderRequestSucceeded() { return orderRequestSucceeded; }
public SearchOrders setOrderRequestSucceeded(Boolean value) { this.orderRequestSucceeded = value; return this; }
public String getUnitOfMeasurement() { return unitOfMeasurement; }
public SearchOrders setUnitOfMeasurement(String value) { this.unitOfMeasurement = value; return this; }
public String getUnitOfMeasurementStartsWith() { return unitOfMeasurementStartsWith; }
public SearchOrders setUnitOfMeasurementStartsWith(String value) { this.unitOfMeasurementStartsWith = value; return this; }
public String getUnitOfMeasurementEndsWith() { return unitOfMeasurementEndsWith; }
public SearchOrders setUnitOfMeasurementEndsWith(String value) { this.unitOfMeasurementEndsWith = value; return this; }
public String getUnitOfMeasurementContains() { return unitOfMeasurementContains; }
public SearchOrders setUnitOfMeasurementContains(String value) { this.unitOfMeasurementContains = value; return this; }
public String getProcessType() { return processType; }
public SearchOrders setProcessType(String value) { this.processType = value; return this; }
public String getProcessTypeStartsWith() { return processTypeStartsWith; }
public SearchOrders setProcessTypeStartsWith(String value) { this.processTypeStartsWith = value; return this; }
public String getProcessTypeEndsWith() { return processTypeEndsWith; }
public SearchOrders setProcessTypeEndsWith(String value) { this.processTypeEndsWith = value; return this; }
public String getProcessTypeContains() { return processTypeContains; }
public SearchOrders setProcessTypeContains(String value) { this.processTypeContains = value; return this; }
public String getDataType() { return dataType; }
public SearchOrders setDataType(String value) { this.dataType = value; return this; }
public String getDataTypeStartsWith() { return dataTypeStartsWith; }
public SearchOrders setDataTypeStartsWith(String value) { this.dataTypeStartsWith = value; return this; }
public String getDataTypeEndsWith() { return dataTypeEndsWith; }
public SearchOrders setDataTypeEndsWith(String value) { this.dataTypeEndsWith = value; return this; }
public String getDataTypeContains() { return dataTypeContains; }
public SearchOrders setDataTypeContains(String value) { this.dataTypeContains = value; return this; }
public String getDataName() { return dataName; }
public SearchOrders setDataName(String value) { this.dataName = value; return this; }
public String getDataNameStartsWith() { return dataNameStartsWith; }
public SearchOrders setDataNameStartsWith(String value) { this.dataNameStartsWith = value; return this; }
public String getDataNameEndsWith() { return dataNameEndsWith; }
public SearchOrders setDataNameEndsWith(String value) { this.dataNameEndsWith = value; return this; }
public String getDataNameContains() { return dataNameContains; }
public SearchOrders setDataNameContains(String value) { this.dataNameContains = value; return this; }
public Integer getSkip() { return skip; }
public SearchOrders setSkip(Integer value) { this.skip = value; return this; }
public Integer getTake() { return take; }
public SearchOrders setTake(Integer value) { this.take = value; return this; }
}
/**
* 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.")
public static class SearchOrdersBase extends PaginationBase implements IGet
{
/**
* The user name of the account.
*/
@ApiMember(Description="The user name of the account.")
public String userName = null;
/**
* The name of the order.
*/
@ApiMember(Description="The name of the order.")
public String name = null;
/**
* 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 String nameStartsWith = null;
/**
* 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 String nameEndsWith = null;
/**
* 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 String nameContains = null;
/**
* 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 String serviceName = null;
/**
* 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 String serviceNameStartsWith = null;
/**
* 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 String serviceNameEndsWith = null;
/**
* 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 String serviceNameContains = null;
/**
* 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 Date before = null;
/**
* 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 Date after = null;
/**
* 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 Date periodStartDate = null;
/**
* 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 Date periodEndDate = null;
/**
* 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 = null;
/**
* Was the order request successful?
*/
@ApiMember(Description="Was the order request successful?")
public Boolean orderRequestSucceeded = null;
/**
* The unit of measurement for the order.
*/
@ApiMember(Description="The unit of measurement for the order.")
public String unitOfMeasurement = null;
/**
* 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 String unitOfMeasurementStartsWith = null;
/**
* 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 String unitOfMeasurementEndsWith = null;
/**
* 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 String unitOfMeasurementContains = null;
/**
* The type of process, for which the order is charged.
*/
@ApiMember(Description="The type of process, for which the order is charged.")
public String processType = null;
/**
* 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 String processTypeStartsWith = null;
/**
* 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 String processTypeEndsWith = null;
/**
* 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 String processTypeContains = null;
/**
* The type of data, for which the order is charged.
*/
@ApiMember(Description="The type of data, for which the order is charged.")
public String dataType = null;
/**
* 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 String dataTypeStartsWith = null;
/**
* 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 String dataTypeEndsWith = null;
/**
* 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 String dataTypeContains = null;
/**
* 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 String dataName = null;
/**
* 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 String dataNameStartsWith = null;
/**
* 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 String dataNameEndsWith = null;
/**
* 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 String dataNameContains = null;
/**
* The number of query results to skip.
*/
@ApiMember(Description="The number of query results to skip.")
public Integer skip = null;
/**
* The number of query results to include.
*/
@ApiMember(Description="The number of query results to include.")
public Integer take = null;
public String getUserName() { return userName; }
public SearchOrdersBase setUserName(String value) { this.userName = value; return this; }
public String getName() { return name; }
public SearchOrdersBase setName(String value) { this.name = value; return this; }
public String getNameStartsWith() { return nameStartsWith; }
public SearchOrdersBase setNameStartsWith(String value) { this.nameStartsWith = value; return this; }
public String getNameEndsWith() { return nameEndsWith; }
public SearchOrdersBase setNameEndsWith(String value) { this.nameEndsWith = value; return this; }
public String getNameContains() { return nameContains; }
public SearchOrdersBase setNameContains(String value) { this.nameContains = value; return this; }
public String getServiceName() { return serviceName; }
public SearchOrdersBase setServiceName(String value) { this.serviceName = value; return this; }
public String getServiceNameStartsWith() { return serviceNameStartsWith; }
public SearchOrdersBase setServiceNameStartsWith(String value) { this.serviceNameStartsWith = value; return this; }
public String getServiceNameEndsWith() { return serviceNameEndsWith; }
public SearchOrdersBase setServiceNameEndsWith(String value) { this.serviceNameEndsWith = value; return this; }
public String getServiceNameContains() { return serviceNameContains; }
public SearchOrdersBase setServiceNameContains(String value) { this.serviceNameContains = value; return this; }
public Date getBefore() { return before; }
public SearchOrdersBase setBefore(Date value) { this.before = value; return this; }
public Date getAfter() { return after; }
public SearchOrdersBase setAfter(Date value) { this.after = value; return this; }
public Date getPeriodStartDate() { return periodStartDate; }
public SearchOrdersBase setPeriodStartDate(Date value) { this.periodStartDate = value; return this; }
public Date getPeriodEndDate() { return periodEndDate; }
public SearchOrdersBase setPeriodEndDate(Date value) { this.periodEndDate = value; return this; }
public PeriodMode getPeriodMode() { return periodMode; }
public SearchOrdersBase setPeriodMode(PeriodMode value) { this.periodMode = value; return this; }
public Boolean isOrderRequestSucceeded() { return orderRequestSucceeded; }
public SearchOrdersBase setOrderRequestSucceeded(Boolean value) { this.orderRequestSucceeded = value; return this; }
public String getUnitOfMeasurement() { return unitOfMeasurement; }
public SearchOrdersBase setUnitOfMeasurement(String value) { this.unitOfMeasurement = value; return this; }
public String getUnitOfMeasurementStartsWith() { return unitOfMeasurementStartsWith; }
public SearchOrdersBase setUnitOfMeasurementStartsWith(String value) { this.unitOfMeasurementStartsWith = value; return this; }
public String getUnitOfMeasurementEndsWith() { return unitOfMeasurementEndsWith; }
public SearchOrdersBase setUnitOfMeasurementEndsWith(String value) { this.unitOfMeasurementEndsWith = value; return this; }
public String getUnitOfMeasurementContains() { return unitOfMeasurementContains; }
public SearchOrdersBase setUnitOfMeasurementContains(String value) { this.unitOfMeasurementContains = value; return this; }
public String getProcessType() { return processType; }
public SearchOrdersBase setProcessType(String value) { this.processType = value; return this; }
public String getProcessTypeStartsWith() { return processTypeStartsWith; }
public SearchOrdersBase setProcessTypeStartsWith(String value) { this.processTypeStartsWith = value; return this; }
public String getProcessTypeEndsWith() { return processTypeEndsWith; }
public SearchOrdersBase setProcessTypeEndsWith(String value) { this.processTypeEndsWith = value; return this; }
public String getProcessTypeContains() { return processTypeContains; }
public SearchOrdersBase setProcessTypeContains(String value) { this.processTypeContains = value; return this; }
public String getDataType() { return dataType; }
public SearchOrdersBase setDataType(String value) { this.dataType = value; return this; }
public String getDataTypeStartsWith() { return dataTypeStartsWith; }
public SearchOrdersBase setDataTypeStartsWith(String value) { this.dataTypeStartsWith = value; return this; }
public String getDataTypeEndsWith() { return dataTypeEndsWith; }
public SearchOrdersBase setDataTypeEndsWith(String value) { this.dataTypeEndsWith = value; return this; }
public String getDataTypeContains() { return dataTypeContains; }
public SearchOrdersBase setDataTypeContains(String value) { this.dataTypeContains = value; return this; }
public String getDataName() { return dataName; }
public SearchOrdersBase setDataName(String value) { this.dataName = value; return this; }
public String getDataNameStartsWith() { return dataNameStartsWith; }
public SearchOrdersBase setDataNameStartsWith(String value) { this.dataNameStartsWith = value; return this; }
public String getDataNameEndsWith() { return dataNameEndsWith; }
public SearchOrdersBase setDataNameEndsWith(String value) { this.dataNameEndsWith = value; return this; }
public String getDataNameContains() { return dataNameContains; }
public SearchOrdersBase setDataNameContains(String value) { this.dataNameContains = value; return this; }
public Integer getSkip() { return skip; }
public SearchOrdersBase setSkip(Integer value) { this.skip = value; return this; }
public Integer getTake() { return take; }
public SearchOrdersBase setTake(Integer value) { this.take = value; return this; }
}
/**
* The number of query results to skip.
*/
@Api(Description="The number of query results to skip.")
public static class PaginationBase implements IPaginate
{
/**
* The number of query results to skip.
*/
@ApiMember(Description="The number of query results to skip.")
public Integer skip = null;
/**
* The number of query results to include.
*/
@ApiMember(Description="The number of query results to include.")
public Integer take = null;
public Integer getSkip() { return skip; }
public PaginationBase setSkip(Integer value) { this.skip = value; return this; }
public Integer getTake() { return take; }
public PaginationBase setTake(Integer value) { this.take = value; return this; }
}
/**
* Represents a specific time interval, within which, an action was carried out.
*/
public static enum PeriodMode
{
Today,
Yesterday,
LastWeek,
Last30Days,
Last90Days,
Last180Days;
}
/**
* 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.")
public static class OrderQueryResponse extends QueryResponse<Order>
{
@DataMember(Order=1)
public Integer offset = null;
@DataMember(Order=2)
public Integer total = null;
@DataMember(Order=3)
public ArrayList<Order> results = null;
@DataMember(Order=4)
public HashMap<String,String> meta = null;
@DataMember(Order=5)
public ResponseStatus responseStatus = null;
public Integer getOffset() { return offset; }
public OrderQueryResponse setOffset(Integer value) { this.offset = value; return this; }
public Integer getTotal() { return total; }
public OrderQueryResponse setTotal(Integer value) { this.total = value; return this; }
public ArrayList<Order> getResults() { return results; }
public OrderQueryResponse setResults(ArrayList<Order> value) { this.results = value; return this; }
public HashMap<String,String> getMeta() { return meta; }
public OrderQueryResponse setMeta(HashMap<String,String> value) { this.meta = value; return this; }
public ResponseStatus getResponseStatus() { return responseStatus; }
public OrderQueryResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
}
@DataContract
public static class QueryResponse<T>
{
@DataMember(Order=1)
public Integer offset = null;
@DataMember(Order=2)
public Integer total = null;
@DataMember(Order=3)
public ArrayList<T> results = null;
@DataMember(Order=4)
public HashMap<String,String> meta = null;
@DataMember(Order=5)
public ResponseStatus responseStatus = null;
public Integer getOffset() { return offset; }
public QueryResponse<T> setOffset(Integer value) { this.offset = value; return this; }
public Integer getTotal() { return total; }
public QueryResponse<T> setTotal(Integer value) { this.total = value; return this; }
public ArrayList<T> getResults() { return results; }
public QueryResponse<T> setResults(ArrayList<T> value) { this.results = value; return this; }
public HashMap<String,String> getMeta() { return meta; }
public QueryResponse<T> setMeta(HashMap<String,String> value) { this.meta = value; return this; }
public ResponseStatus getResponseStatus() { return responseStatus; }
public QueryResponse<T> setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
}
/**
* Represents a commission to consume services.
*/
@Api(Description="Represents a commission to consume services.")
public static class Order implements IHasName
{
/**
* The unique identifier of the order.
*/
@ApiMember(Description="The unique identifier of the order.", IsRequired=true)
public Integer id = null;
/**
* 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 Integer productId = null;
/**
* 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 Integer accountId = null;
/**
* A name to identify the order.
*/
@ApiMember(Description="A name to identify the order.", IsRequired=true)
@Validate(Validator="NotEmpty")
public String name = null;
/**
* 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 String serviceName = null;
/**
* The time stamp at which the order was initiated.
*/
@ApiMember(Description="The time stamp at which the order was initiated.")
public Date requestTimestamp = null;
/**
* The time stamp at which the order was completed.
*/
@ApiMember(Description="The time stamp at which the order was completed.")
public Date responseTimestamp = null;
/**
* The URI from which the order was initiated.
*/
@ApiMember(Description="The URI from which the order was initiated.")
public String requestUri = null;
/**
* The HTTP method of the order request.
*/
@ApiMember(Description="The HTTP method of the order request.")
public String requestHttpMethod = null;
/**
* The duration of the order request.
*/
@ApiMember(Description="The duration of the order request.")
public TimeSpan requestDuration = null;
/**
* The HTTP status code of the order request.
*/
@ApiMember(Description="The HTTP status code of the order request.")
public HttpStatusCode responseStatusCode = null;
/**
* The IP address of client, who placed the order.
*/
@ApiMember(Description="The IP address of client, who placed the order.")
public String clientIPAddress = null;
/**
* The unit of measurement for the order.
*/
@ApiMember(Description="The unit of measurement for the order.")
public String unitOfMeasurement = null;
/**
* The type of process, for which the order is charged.
*/
@ApiMember(Description="The type of process, for which the order is charged.")
public String processType = null;
/**
* The type of data, for which the order is charged.
*/
@ApiMember(Description="The type of data, for which the order is charged.")
public String dataType = null;
/**
* 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 String dataName = null;
/**
* The date of creation of the order.
*/
@ApiMember(Description="The date of creation of the order.")
public Date creationDate = null;
/**
* 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 Date expiryDate = null;
/**
* 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 Boolean isTest = null;
public Integer getId() { return id; }
public Order setId(Integer value) { this.id = value; return this; }
public Integer getProductId() { return productId; }
public Order setProductId(Integer value) { this.productId = value; return this; }
public Integer getAccountId() { return accountId; }
public Order setAccountId(Integer value) { this.accountId = value; return this; }
public String getName() { return name; }
public Order setName(String value) { this.name = value; return this; }
public String getServiceName() { return serviceName; }
public Order setServiceName(String value) { this.serviceName = value; return this; }
public Date getRequestTimestamp() { return requestTimestamp; }
public Order setRequestTimestamp(Date value) { this.requestTimestamp = value; return this; }
public Date getResponseTimestamp() { return responseTimestamp; }
public Order setResponseTimestamp(Date value) { this.responseTimestamp = value; return this; }
public String getRequestUri() { return requestUri; }
public Order setRequestUri(String value) { this.requestUri = value; return this; }
public String getRequestHttpMethod() { return requestHttpMethod; }
public Order setRequestHttpMethod(String value) { this.requestHttpMethod = value; return this; }
public TimeSpan getRequestDuration() { return requestDuration; }
public Order setRequestDuration(TimeSpan value) { this.requestDuration = value; return this; }
public HttpStatusCode getResponseStatusCode() { return responseStatusCode; }
public Order setResponseStatusCode(HttpStatusCode value) { this.responseStatusCode = value; return this; }
public String getClientIPAddress() { return clientIPAddress; }
public Order setClientIPAddress(String value) { this.clientIPAddress = value; return this; }
public String getUnitOfMeasurement() { return unitOfMeasurement; }
public Order setUnitOfMeasurement(String value) { this.unitOfMeasurement = value; return this; }
public String getProcessType() { return processType; }
public Order setProcessType(String value) { this.processType = value; return this; }
public String getDataType() { return dataType; }
public Order setDataType(String value) { this.dataType = value; return this; }
public String getDataName() { return dataName; }
public Order setDataName(String value) { this.dataName = value; return this; }
public Date getCreationDate() { return creationDate; }
public Order setCreationDate(Date value) { this.creationDate = value; return this; }
public Date getExpiryDate() { return expiryDate; }
public Order setExpiryDate(Date value) { this.expiryDate = value; return this; }
public Boolean getIsTest() { return isTest; }
public Order setIsTest(Boolean value) { this.isTest = value; return this; }
}
}
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"}}}