Tax Filing Service
| Required role: | Admin | Required permissions: | CanAccess, CanAdd |
| POST | /sync/products |
|---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports PwC.Metering.Core.Services.Contracts.Requests
Imports PwC.Metering.Core.Services.Contracts.Responses
Imports PwC.Metering.Core.Domain.Concretes.Models
Namespace Global
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
Implements IHasName
'''<Summary>
'''The unique identifier of the order.
'''</Summary>
<ApiMember(Description:="The unique identifier of the order.", IsRequired:=true)>
Public Overridable Property Id As Integer
'''<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 Overridable Property ProductId As Integer
'''<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 Overridable Property AccountId As Integer
'''<Summary>
'''A name to identify the order.
'''</Summary>
<ApiMember(Description:="A name to identify the order.", IsRequired:=true)>
<Validate(Validator:="NotEmpty")>
Public Overridable Property Name As String
'''<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 Overridable Property ServiceName As String
'''<Summary>
'''The time stamp at which the order was initiated.
'''</Summary>
<ApiMember(Description:="The time stamp at which the order was initiated.")>
Public Overridable Property RequestTimestamp As Nullable(Of Date)
'''<Summary>
'''The time stamp at which the order was completed.
'''</Summary>
<ApiMember(Description:="The time stamp at which the order was completed.")>
Public Overridable Property ResponseTimestamp As Nullable(Of Date)
'''<Summary>
'''The URI from which the order was initiated.
'''</Summary>
<ApiMember(Description:="The URI from which the order was initiated.")>
Public Overridable Property RequestUri As String
'''<Summary>
'''The HTTP method of the order request.
'''</Summary>
<ApiMember(Description:="The HTTP method of the order request.")>
Public Overridable Property RequestHttpMethod As String
'''<Summary>
'''The duration of the order request.
'''</Summary>
<ApiMember(Description:="The duration of the order request.")>
Public Overridable Property RequestDuration As Nullable(Of TimeSpan)
'''<Summary>
'''The HTTP status code of the order request.
'''</Summary>
<ApiMember(Description:="The HTTP status code of the order request.")>
Public Overridable Property ResponseStatusCode As HttpStatusCode
'''<Summary>
'''The IP address of client, who placed the order.
'''</Summary>
<ApiMember(Description:="The IP address of client, who placed the order.")>
Public Overridable Property ClientIPAddress As String
'''<Summary>
'''The unit of measurement for the order.
'''</Summary>
<ApiMember(Description:="The unit of measurement for the order.")>
Public Overridable Property UnitOfMeasurement As String
'''<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 Overridable Property ProcessType As String
'''<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 Overridable Property DataType As String
'''<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 Overridable Property DataName As String
'''<Summary>
'''The date of creation of the order.
'''</Summary>
<ApiMember(Description:="The date of creation of the order.")>
Public Overridable Property CreationDate As Date
'''<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 Overridable Property ExpiryDate As Nullable(Of Date)
'''<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 Overridable Property IsTest As Boolean
End Class
'''<Summary>
'''Represents a product.
'''</Summary>
<Api(Description:="Represents a product.")>
Public Partial Class Product
Implements IHasName
Public Sub New()
Tags = New List(Of String)
End Sub
'''<Summary>
'''The unique identifier of the product.
'''</Summary>
<ApiMember(Description:="The unique identifier of the product.", IsRequired:=true)>
Public Overridable Property Id As Integer
'''<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 Overridable Property Index As Integer
'''<Summary>
'''The name of the product.
'''</Summary>
<ApiMember(Description:="The name of the product.", IsRequired:=true)>
<Validate(Validator:="NotEmpty")>
Public Overridable Property Name As String
'''<Summary>
'''The version of the product.
'''</Summary>
<ApiMember(Description:="The version of the product.", IsRequired:=true)>
<Validate(Validator:="NotEmpty")>
Public Overridable Property Version As String
'''<Summary>
'''The version of the product.
'''</Summary>
<ApiMember(Description:="The version of the product.")>
Public Overridable Property Description As String
'''<Summary>
'''Tags associated with the product.
'''</Summary>
<ApiMember(Description:="Tags associated with the product.")>
Public Overridable Property Tags As List(Of String)
End Class
End Namespace
Namespace PwC.Metering.Core.Services.Contracts.Requests
'''<Summary>
'''Represents a service request to register a product.
'''</Summary>
<Api(Description:="Represents a service request to register a product.")>
Public Partial Class RegisterProduct
Inherits RegisterProductBase
Public Sub New()
Tags = New List(Of String)
End Sub
'''<Summary>
'''The name of the product.
'''</Summary>
<ApiMember(Description:="The name of the product.")>
Public Overridable Property Name As String
'''<Summary>
'''The description of the product.
'''</Summary>
<ApiMember(Description:="The description of the product.")>
Public Overridable Property Description As String
'''<Summary>
'''The version of the product.
'''</Summary>
<ApiMember(Description:="The version of the product.")>
Public Overridable Property Version As String
'''<Summary>
'''Tags associated with the product.
'''</Summary>
<ApiMember(Description:="Tags associated with the product.")>
Public Overridable Property Tags As List(Of String)
End Class
'''<Summary>
'''Specifies a base service request to register a product.
'''</Summary>
<Api(Description:="Specifies a base service request to register a product.")>
Public Partial Class RegisterProductBase
Implements IPost
Public Sub New()
Tags = New List(Of String)
End Sub
'''<Summary>
'''The name of the product.
'''</Summary>
<ApiMember(Description:="The name of the product.")>
Public Overridable Property Name As String
'''<Summary>
'''The description of the product.
'''</Summary>
<ApiMember(Description:="The description of the product.")>
Public Overridable Property Description As String
'''<Summary>
'''The version of the product.
'''</Summary>
<ApiMember(Description:="The version of the product.")>
Public Overridable Property Version As String
'''<Summary>
'''Tags associated with the product.
'''</Summary>
<ApiMember(Description:="Tags associated with the product.")>
Public Overridable Property Tags As List(Of String)
End Class
End Namespace
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
Inherits ServiceResponseBase
Public Sub New()
Orders = New List(Of Order)
End Sub
'''<Summary>
'''The product data of the response.
'''</Summary>
<ApiMember(Description:="The product data of the response.")>
Public Overridable Property Product As Product
'''<Summary>
'''The list of orders associated with the encapsulated product.
'''</Summary>
<ApiMember(Description:="The list of orders associated with the encapsulated product.")>
Public Overridable Property Orders As List(Of Order)
'''<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 Overridable Property ResponseStatus As ResponseStatus
End Class
'''<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 Overridable Property ResponseStatus As ResponseStatus
End Class
End Namespace
End Namespace
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /sync/products HTTP/1.1
Host: taxfiling.pwc.de
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
name: String,
description: String,
version: String,
tags:
[
String
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
product:
{
id: 0,
index: 0,
name: String,
version: String,
description: String,
tags:
[
String
]
},
orders:
[
{
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
}
],
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}