Field Squared API Services

<back to all web services

PricingList

Represents a DTO for a pricing list in a workspace. Calls without an ObjectId will retrieve an array of all active pricing list objects for the workspace.

The following routes are available for this service:
GET,POST,PUT,DELETE/{Workspace}/PricingList/{ObjectId}
GET/{Workspace}/PricingList
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Field2Office.API.Model.PricingLists;

namespace Field2Office.API.Model.PricingLists
{
    ///<summary>
    ///Represents a DTO for a pricing list in a workspace.  Calls without an ObjectId will retrieve an array of all active pricing list objects for the workspace.
    ///</summary>
    public partial class PricingList
    {
        public PricingList()
        {
            Categories = new List<PricingListCat>{};
            Items = new List<PricingListItem>{};
        }

        public virtual string Workspace { get; set; }
        public virtual string ObjectId { get; set; }
        public virtual string VersionId { get; set; }
        public virtual string BasedOn { get; set; }
        public virtual string Name { get; set; }
        public virtual List<PricingListCat> Categories { get; set; }
        public virtual List<PricingListItem> Items { get; set; }
    }

    public partial class PricingListCat
    {
        public PricingListCat()
        {
            Categories = new List<PricingListCat>{};
            Items = new List<PricingListItem>{};
        }

        public virtual string ObjectId { get; set; }
        public virtual string Name { get; set; }
        public virtual List<PricingListCat> Categories { get; set; }
        public virtual List<PricingListItem> Items { get; set; }
    }

    public partial class PricingListItem
    {
        public virtual string ObjectId { get; set; }
        public virtual string Description { get; set; }
        public virtual string Details { get; set; }
        public virtual string Manufacturer { get; set; }
        public virtual string Model { get; set; }
        public virtual string Photo { get; set; }
        public virtual bool IsTaxable { get; set; }
        public virtual string Unit { get; set; }
        public virtual double UnitPrice { get; set; }
        public virtual string Barcode { get; set; }
    }

}

C# PricingList DTOs

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.

POST /{Workspace}/PricingList/{ObjectId} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Workspace: String,
	ObjectId: String,
	VersionId: String,
	BasedOn: String,
	Name: String,
	Categories: 
	[
		{
			ObjectId: String,
			Name: String,
			Categories: 
			[
				{
					ObjectId: String,
					Name: String,
					Categories: 
					[
						{
							ObjectId: String,
							Name: String,
							Items: 
							[
								{
									ObjectId: String,
									Description: String,
									Details: String,
									Manufacturer: String,
									Model: String,
									Photo: String,
									IsTaxable: False,
									Unit: String,
									UnitPrice: 0,
									Barcode: String
								}
							]
						}
					],
					Items: 
					[
						{
							ObjectId: String,
							Description: String,
							Details: String,
							Manufacturer: String,
							Model: String,
							Photo: String,
							IsTaxable: False,
							Unit: String,
							UnitPrice: 0,
							Barcode: String
						}
					]
				}
			],
			Items: 
			[
				{
					ObjectId: String,
					Description: String,
					Details: String,
					Manufacturer: String,
					Model: String,
					Photo: String,
					IsTaxable: False,
					Unit: String,
					UnitPrice: 0,
					Barcode: String
				}
			]
		}
	],
	Items: 
	[
		{
			ObjectId: String,
			Description: String,
			Details: String,
			Manufacturer: String,
			Model: String,
			Photo: String,
			IsTaxable: False,
			Unit: String,
			UnitPrice: 0,
			Barcode: String
		}
	]
}