Required role: | Admin | Required permissions: | CanAccess, CanDelete |
DELETE | /async/products/{Id} |
---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using PwC.Metering.Core.Services.Contracts.Requests;
using PwC.Metering.Core.Services.Contracts.Responses;
using PwC.Metering.Core.Domain.Concretes.Models;
namespace PwC.Metering.Core.Domain.Concretes.Models
{
///<summary>
///Represents a commission to consume services.
///</summary>
[Api(Description="Represents a commission to consume services.")]
public partial class Order
: IHasName
{
///<summary>
///The unique identifier of the order.
///</summary>
[ApiMember(Description="The unique identifier of the order.", IsRequired=true)]
public virtual int Id { get; set; }
///<summary>
///The unique identifier of the product, for which the order is made.
///</summary>
[ApiMember(Description="The unique identifier of the product, for which the order is made.", IsRequired=true)]
public virtual int ProductId { get; set; }
///<summary>
///The unique identifier of the user account, who placed the order.
///</summary>
[ApiMember(Description="The unique identifier of the user account, who placed the order.", IsRequired=true)]
public virtual int AccountId { get; set; }
///<summary>
///A name to identify the order.
///</summary>
[ApiMember(Description="A name to identify the order.", IsRequired=true)]
[Validate("NotEmpty")]
public virtual string Name { get; set; }
///<summary>
///The name of the service, for which the order was made.
///</summary>
[ApiMember(Description="The name of the service, for which the order was made.")]
public virtual string ServiceName { get; set; }
///<summary>
///The time stamp at which the order was initiated.
///</summary>
[ApiMember(Description="The time stamp at which the order was initiated.")]
public virtual DateTime? RequestTimestamp { get; set; }
///<summary>
///The time stamp at which the order was completed.
///</summary>
[ApiMember(Description="The time stamp at which the order was completed.")]
public virtual DateTime? ResponseTimestamp { get; set; }
///<summary>
///The URI from which the order was initiated.
///</summary>
[ApiMember(Description="The URI from which the order was initiated.")]
public virtual string RequestUri { get; set; }
///<summary>
///The HTTP method of the order request.
///</summary>
[ApiMember(Description="The HTTP method of the order request.")]
public virtual string RequestHttpMethod { get; set; }
///<summary>
///The duration of the order request.
///</summary>
[ApiMember(Description="The duration of the order request.")]
public virtual TimeSpan? RequestDuration { get; set; }
///<summary>
///The HTTP status code of the order request.
///</summary>
[ApiMember(Description="The HTTP status code of the order request.")]
public virtual HttpStatusCode ResponseStatusCode { get; set; }
///<summary>
///The IP address of client, who placed the order.
///</summary>
[ApiMember(Description="The IP address of client, who placed the order.")]
public virtual string ClientIPAddress { get; set; }
///<summary>
///The unit of measurement for the order.
///</summary>
[ApiMember(Description="The unit of measurement for the order.")]
public virtual string UnitOfMeasurement { get; set; }
///<summary>
///The type of process, for which the order is charged.
///</summary>
[ApiMember(Description="The type of process, for which the order is charged.")]
public virtual string ProcessType { get; set; }
///<summary>
///The type of data, for which the order is charged.
///</summary>
[ApiMember(Description="The type of data, for which the order is charged.")]
public virtual string DataType { get; set; }
///<summary>
///The name of the data, for which the order is charged.
///</summary>
[ApiMember(Description="The name of the data, for which the order is charged.")]
public virtual string DataName { get; set; }
///<summary>
///The date of creation of the order.
///</summary>
[ApiMember(Description="The date of creation of the order.")]
public virtual DateTime CreationDate { get; set; }
///<summary>
///The final date to retain the order in the records. After this date, the order is expunged from the records.
///</summary>
[ApiMember(Description="The final date to retain the order in the records. After this date, the order is expunged from the records.")]
public virtual DateTime? ExpiryDate { get; set; }
///<summary>
///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.
///</summary>
[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 virtual bool IsTest { get; set; }
}
///<summary>
///Represents a product.
///</summary>
[Api(Description="Represents a product.")]
public partial class Product
: IHasName
{
public Product()
{
Tags = new List<string>{};
}
///<summary>
///The unique identifier of the product.
///</summary>
[ApiMember(Description="The unique identifier of the product.", IsRequired=true)]
public virtual int Id { get; set; }
///<summary>
///The position of this instance in a collection of 'Product' instances
///</summary>
[ApiMember(Description="The position of this instance in a collection of 'Product' instances", IsRequired=true)]
public virtual int Index { get; set; }
///<summary>
///The name of the product.
///</summary>
[ApiMember(Description="The name of the product.", IsRequired=true)]
[Validate("NotEmpty")]
public virtual string Name { get; set; }
///<summary>
///The version of the product.
///</summary>
[ApiMember(Description="The version of the product.", IsRequired=true)]
[Validate("NotEmpty")]
public virtual string Version { get; set; }
///<summary>
///The version of the product.
///</summary>
[ApiMember(Description="The version of the product.")]
public virtual string Description { get; set; }
///<summary>
///Tags associated with the product.
///</summary>
[ApiMember(Description="Tags associated with the product.")]
public virtual List<string> Tags { get; set; }
}
}
namespace PwC.Metering.Core.Services.Contracts.Requests
{
///<summary>
///Represents a service request to delete a product in an asynchronous operation.
///</summary>
[Api(Description="Represents a service request to delete a product in an asynchronous operation.")]
public partial class DeleteProductAsync
: DeleteProductBase
{
///<summary>
///The unique identifier of the product.
///</summary>
[ApiMember(Description="The unique identifier of the product.")]
public virtual int Id { get; set; }
}
///<summary>
///Specifies a base service to delete a product.
///</summary>
[Api(Description="Specifies a base service to delete a product.")]
public partial class DeleteProductBase
: IDelete
{
///<summary>
///The unique identifier of the product.
///</summary>
[ApiMember(Description="The unique identifier of the product.")]
public virtual int Id { get; set; }
}
}
namespace PwC.Metering.Core.Services.Contracts.Responses
{
///<summary>
///Represents a service response that encapsulates product data.
///</summary>
[Api(Description="Represents a service response that encapsulates product data.")]
public partial class ProductResponse
: ServiceResponseBase
{
public ProductResponse()
{
Orders = new List<Order>{};
}
///<summary>
///The product data of the response.
///</summary>
[ApiMember(Description="The product data of the response.")]
public virtual Product Product { get; set; }
///<summary>
///The list of orders associated with the encapsulated product.
///</summary>
[ApiMember(Description="The list of orders associated with the encapsulated product.")]
public virtual List<Order> Orders { get; set; }
///<summary>
///Data structure that holds error information from a service operation.
///</summary>
[ApiMember(Description="Data structure that holds error information from a service operation.")]
public virtual ResponseStatus ResponseStatus { get; set; }
}
///<summary>
///Specifies a base service response class that contains a structured error information.
///</summary>
[Api(Description="Specifies a base service response class that contains a structured error information.")]
public partial class ServiceResponseBase
{
///<summary>
///Data structure that holds error information from a service operation.
///</summary>
[ApiMember(Description="Data structure that holds error information from a service operation.")]
public virtual ResponseStatus ResponseStatus { get; set; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
DELETE /async/products/{Id} HTTP/1.1 Host: taxfiling.pwc.de Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <ProductResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Services.Contracts.Responses"> <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types"> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:Message>String</d2p1:Message> <d2p1:StackTrace>String</d2p1:StackTrace> <d2p1:Errors> <d2p1:ResponseError> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:FieldName>String</d2p1:FieldName> <d2p1:Message>String</d2p1:Message> <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </d2p1:Meta> </d2p1:ResponseError> </d2p1:Errors> <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </d2p1:Meta> </ResponseStatus> <Orders xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Domain.Concretes.Models"> <d2p1:Order> <d2p1:AccountId>0</d2p1:AccountId> <d2p1:ClientIPAddress>String</d2p1:ClientIPAddress> <d2p1:CreationDate>0001-01-01T00:00:00</d2p1:CreationDate> <d2p1:DataName>String</d2p1:DataName> <d2p1:DataType>String</d2p1:DataType> <d2p1:ExpiryDate>0001-01-01T00:00:00</d2p1:ExpiryDate> <d2p1:Id>0</d2p1:Id> <d2p1:IsTest>false</d2p1:IsTest> <d2p1:Name>String</d2p1:Name> <d2p1:ProcessType>String</d2p1:ProcessType> <d2p1:ProductId>0</d2p1:ProductId> <d2p1:RequestDuration>PT0S</d2p1:RequestDuration> <d2p1:RequestHttpMethod>String</d2p1:RequestHttpMethod> <d2p1:RequestTimestamp>0001-01-01T00:00:00</d2p1:RequestTimestamp> <d2p1:RequestUri>String</d2p1:RequestUri> <d2p1:ResponseStatusCode>Continue</d2p1:ResponseStatusCode> <d2p1:ResponseTimestamp>0001-01-01T00:00:00</d2p1:ResponseTimestamp> <d2p1:ServiceName>String</d2p1:ServiceName> <d2p1:UnitOfMeasurement>String</d2p1:UnitOfMeasurement> </d2p1:Order> </Orders> <Product xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Domain.Concretes.Models"> <d2p1:Description>String</d2p1:Description> <d2p1:Id>0</d2p1:Id> <d2p1:Index>0</d2p1:Index> <d2p1:Name>String</d2p1:Name> <d2p1:Tags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>String</d3p1:string> </d2p1:Tags> <d2p1:Version>String</d2p1:Version> </Product> </ProductResponse>