Required role: | Admin | Required permissions: | CanAccess, CanAdd |
POST | /sync/products/batch |
---|
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.Domain.Concretes.Models;
namespace PwC.Metering.Core.Domain.Concretes.Models
{
///<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 register one or more products in a batch operation.
///</summary>
[Api(Description="Represents a service request to register one or more products in a batch operation.")]
public partial class BatchRegisterProducts
: BatchRegisterProductsBase
{
public BatchRegisterProducts()
{
Products = new List<Product>{};
}
///<summary>
///The products to register.
///</summary>
[ApiMember(Description="The products to register.", IsRequired=true)]
public virtual List<Product> Products { get; set; }
}
///<summary>
///Specifies a base service request to register one or more products in a batch operation.
///</summary>
[Api(Description="Specifies a base service request to register one or more products in a batch operation.")]
public partial class BatchRegisterProductsBase
: IPost
{
public BatchRegisterProductsBase()
{
Products = new List<Product>{};
}
///<summary>
///The products to register.
///</summary>
[ApiMember(Description="The products to register.", IsRequired=true)]
public virtual List<Product> Products { get; set; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /sync/products/batch HTTP/1.1
Host: taxfiling.staging.pwc.de
Accept: application/json
Content-Type: application/json
Content-Length: length
{"products":[{"id":0,"index":0,"name":"String","version":"String","description":"String","tags":["String"]}]}
HTTP/1.1 200 OK Content-Type: application/json 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":"\/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"}}}]