Field Squared API 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

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Field2Office.API.Model.PricingLists

Namespace Global

    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 Sub New()
                Categories = New List(Of PricingListCat)
                Items = New List(Of PricingListItem)
            End Sub

            Public Overridable Property Workspace As String
            Public Overridable Property ObjectId As String
            Public Overridable Property VersionId As String
            Public Overridable Property BasedOn As String
            Public Overridable Property Name As String
            Public Overridable Property Categories As List(Of PricingListCat)
            Public Overridable Property Items As List(Of PricingListItem)
        End Class

        Public Partial Class PricingListCat
            Public Sub New()
                Categories = New List(Of PricingListCat)
                Items = New List(Of PricingListItem)
            End Sub

            Public Overridable Property ObjectId As String
            Public Overridable Property Name As String
            Public Overridable Property Categories As List(Of PricingListCat)
            Public Overridable Property Items As List(Of PricingListItem)
        End Class

        Public Partial Class PricingListItem
            Public Overridable Property ObjectId As String
            Public Overridable Property Description As String
            Public Overridable Property Details As String
            Public Overridable Property Manufacturer As String
            Public Overridable Property Model As String
            Public Overridable Property Photo As String
            Public Overridable Property IsTaxable As Boolean
            Public Overridable Property Unit As String
            Public Overridable Property UnitPrice As Double
            Public Overridable Property Barcode As String
        End Class
    End Namespace
End Namespace

VB.NET PricingList DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<PricingList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.PricingLists">
  <BasedOn>String</BasedOn>
  <Categories>
    <PricingListCat>
      <Categories>
        <PricingListCat>
          <Categories>
            <PricingListCat>
              <Categories i:nil="true" />
              <Items>
                <PricingListItem>
                  <Barcode>String</Barcode>
                  <Description>String</Description>
                  <Details>String</Details>
                  <IsTaxable>false</IsTaxable>
                  <Manufacturer>String</Manufacturer>
                  <Model>String</Model>
                  <ObjectId>String</ObjectId>
                  <Photo>String</Photo>
                  <Unit>String</Unit>
                  <UnitPrice>0</UnitPrice>
                </PricingListItem>
              </Items>
              <Name>String</Name>
              <ObjectId>String</ObjectId>
            </PricingListCat>
          </Categories>
          <Items>
            <PricingListItem>
              <Barcode>String</Barcode>
              <Description>String</Description>
              <Details>String</Details>
              <IsTaxable>false</IsTaxable>
              <Manufacturer>String</Manufacturer>
              <Model>String</Model>
              <ObjectId>String</ObjectId>
              <Photo>String</Photo>
              <Unit>String</Unit>
              <UnitPrice>0</UnitPrice>
            </PricingListItem>
          </Items>
          <Name>String</Name>
          <ObjectId>String</ObjectId>
        </PricingListCat>
      </Categories>
      <Items>
        <PricingListItem>
          <Barcode>String</Barcode>
          <Description>String</Description>
          <Details>String</Details>
          <IsTaxable>false</IsTaxable>
          <Manufacturer>String</Manufacturer>
          <Model>String</Model>
          <ObjectId>String</ObjectId>
          <Photo>String</Photo>
          <Unit>String</Unit>
          <UnitPrice>0</UnitPrice>
        </PricingListItem>
      </Items>
      <Name>String</Name>
      <ObjectId>String</ObjectId>
    </PricingListCat>
  </Categories>
  <Items>
    <PricingListItem>
      <Barcode>String</Barcode>
      <Description>String</Description>
      <Details>String</Details>
      <IsTaxable>false</IsTaxable>
      <Manufacturer>String</Manufacturer>
      <Model>String</Model>
      <ObjectId>String</ObjectId>
      <Photo>String</Photo>
      <Unit>String</Unit>
      <UnitPrice>0</UnitPrice>
    </PricingListItem>
  </Items>
  <Name>String</Name>
  <ObjectId>String</ObjectId>
  <VersionId>String</VersionId>
  <Workspace>String</Workspace>
</PricingList>