Tax Filing Service
| Required role: | Admin | Required permission: | CanAccess |
| GET | /sync/orders/{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; }
}
}
namespace PwC.Metering.Core.Services.Contracts.Requests
{
///<summary>
///Represents a service request to retrieve an order.
///</summary>
[Api(Description="Represents a service request to retrieve an order.")]
public partial class RetrieveOrder
: RetrieveOrderBase
{
///<summary>
///The unique identifier of the order.
///</summary>
[ApiMember(Description="The unique identifier of the order.")]
public virtual int Id { get; set; }
}
///<summary>
///Specifies a service request to retrieve an order.
///</summary>
[Api(Description="Specifies a service request to retrieve an order.")]
public partial class RetrieveOrderBase
: IGet
{
///<summary>
///The unique identifier of the order.
///</summary>
[ApiMember(Description="The unique identifier of the order.")]
public virtual int Id { get; set; }
}
}
namespace PwC.Metering.Core.Services.Contracts.Responses
{
///<summary>
///Represents a service response that encapsulates an order data.
///</summary>
[Api(Description="Represents a service response that encapsulates an order data.")]
public partial class OrderResponse
: ServiceResponseBase
{
///<summary>
///The order data of the response.
///</summary>
[ApiMember(Description="The order data of the response.")]
public virtual Order Order { 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 .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /sync/orders/{Id} HTTP/1.1
Host: taxfiling.pwc.de
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"order":{"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},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}