Field Squared API Services

<back to all web services

CatalogList

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

The following routes are available for this service:
GET/{Workspace}/CatalogList
namespace Field2Office.API.Model.Catalogs

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    ///<summary>
    ///Contains the data for a catalog within the system.
    ///</summary>
    [<AllowNullLiteral>]
    type Catalog() = 
        member val Workspace:String = null with get,set
        member val AssignedWorkspace:String = null with get,set
        member val ObjectId:String = null with get,set
        member val VersionId:String = null with get,set
        member val BasedOn:String = null with get,set
        member val ExternalId:String = null with get,set
        member val Created:String = null with get,set
        member val LastUpdated:String = null with get,set
        member val Name:String = null with get,set
        member val Type:String = null with get,set
        member val Parent:String = null with get,set
        member val Ancestors:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Items:Dictionary<String, Dictionary<String,String>> = new Dictionary<String, Dictionary<String,String>>() with get,set
        member val Enabled:Boolean = new Boolean() with get,set

    ///<summary>
    ////{Workspace}/CatalogList returns a list of catalogs in the workspace.
    ///</summary>
    [<AllowNullLiteral>]
    type CatalogList() = 
        member val Workspace:String = null with get,set
        member val DateGenerated:String = null with get,set
        member val Catalogs:ResizeArray<Catalog> = new ResizeArray<Catalog>() with get,set
        member val RecordsAvailable:Int64 = new Int64() with get,set

F# 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