Field Squared API Services

PublicCatalog

The following routes are available for this service:
GET, PUT, POST, DELETE	/{Workspace}/API/Catalog/{CatalogType}
GET, PUT, POST, DELETE	/{Workspace}/API/Catalog
GET	/{Workspace}/API/Catalog/Schema/{CatalogType}

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

    [<DataContract>]
    [<AllowNullLiteral>]
    type PublicCatalog() = 
        [<DataMember>]
        member val Workspace:String = null with get,set

        [<DataMember>]
        member val CatalogType:String = null with get,set

        [<DataMember>]
        member val Catalog:Catalog = null with get,set

        [<DataMember>]
        member val Catalogs:ResizeArray<Catalog> = new ResizeArray<Catalog>() with get,set

F# PublicCatalog DTOs

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

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /{Workspace}/API/Catalog/{CatalogType} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Workspace":"String","CatalogType":"String","Catalog":{"CatalogType":"String","LastUpdated":"String","Created":"String","Data":{"String":{}}},"Catalogs":[{"CatalogType":"String","LastUpdated":"String","Created":"String","Data":{"String":{}}}]}