Tax Filing Service

<back to all web services

RetrieveAllProducts

RetrieveProductsSync

Represents a service request to retrieve all products.

Requires Authentication
Required role:AdminRequired permission:CanAccess
The following routes are available for this service:
GET/sync/products
RetrieveAllProducts Parameters:
NameParameterData TypeRequiredDescription
IncludeOrdersquerybool?NoShould the related orders of the account be included in the retrieved products?
SkipOrdersqueryint?NoSpecifies the number of orders to skip per product. Applicable only when 'IncludeOrders' is true.
TakeOrdersqueryint?NoSpecifies the number of orders to include per product. Applicable only when 'IncludeOrders' is true.
Skipqueryint?NoThe number of query results to skip.
Takequeryint?NoThe number of query results to include.
RetrieveAllProductsBase Parameters:
NameParameterData TypeRequiredDescription
IncludeOrdersformbool?NoShould the related orders of the account be included in the retrieved products?
SkipOrdersformint?NoSpecifies the number of orders to skip per product. Applicable only when 'IncludeOrders' is true.
TakeOrdersformint?NoSpecifies the number of orders to include per product. Applicable only when 'IncludeOrders' is true.
Skipformint?NoThe number of query results to skip.
Takeformint?NoThe number of query results to include.
PaginationBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?NoThe number of query results to skip.
Takeformint?NoThe number of query results to include.
ProductQueryResponse Parameters:
NameParameterData TypeRequiredDescription
OrdersMapformDictionary<int, List<Order>>YesThe dictionary of orders associated with each found product.
OffsetformintNo
TotalformintNo
ResultsformList<Product>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
Product Parameters:
NameParameterData TypeRequiredDescription
IdformintYesThe unique identifier of the product.
IndexformintYesThe position of this instance in a collection of 'Product' instances
NameformstringYesThe name of the product.
VersionformstringYesThe version of the product.
DescriptionformstringNoThe version of the product.
TagsformList<string>YesTags associated with the product.

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 /sync/products HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ordersMap: 
	{
		0: 
		[
			{
				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
			}
		]
	},
	offset: 0,
	total: 0,
	results: 
	[
		{
			id: 0,
			index: 0,
			name: String,
			version: String,
			description: String,
			tags: 
			[
				String
			]
		}
	],
	meta: 
	{
		String: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}