Field Squared API Services

CatalogList

/{Workspace}/CatalogList returns a list of catalogs in the workspace.

The following routes are available for this service:
GET	/{Workspace}/CatalogList

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Field2Office.API.Model.Catalogs;

namespace Field2Office.API.Model.Catalogs
{
    ///<summary>
    ///Contains the data for a catalog within the system.
    ///</summary>
    public partial class Catalog
    {
        public Catalog()
        {
            Ancestors = new List<string>{};
            Items = new Dictionary<string, Dictionary<String,String>>{};
        }

        public virtual string Workspace { get; set; }
        public virtual string AssignedWorkspace { get; set; }
        public virtual string ObjectId { get; set; }
        public virtual string VersionId { get; set; }
        public virtual string BasedOn { get; set; }
        public virtual string ExternalId { get; set; }
        public virtual string Created { get; set; }
        public virtual string LastUpdated { get; set; }
        public virtual string Name { get; set; }
        public virtual string Type { get; set; }
        public virtual string Parent { get; set; }
        public virtual List<string> Ancestors { get; set; }
        public virtual Dictionary<string, Dictionary<String,String>> Items { get; set; }
        public virtual bool Enabled { get; set; }
    }

    ///<summary>
    ////{Workspace}/CatalogList returns a list of catalogs in the workspace.
    ///</summary>
    public partial class CatalogList
    {
        public CatalogList()
        {
            Catalogs = new List<Catalog>{};
        }

        public virtual string Workspace { get; set; }
        public virtual string DateGenerated { get; set; }
        public virtual List<Catalog> Catalogs { get; set; }
        public virtual long RecordsAvailable { get; set; }
    }

}

C# CatalogList 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.

GET /{Workspace}/CatalogList HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/jsv