Field Squared API Services

<back to all web services

CatalogImport

Bulk import a catalog from a csv file.

The following routes are available for this service:
POST/{Workspace}/CatalogImport
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>
    ///Bulk import a catalog from a csv file.
    ///</summary>
    public partial class CatalogImport
    {
        public CatalogImport()
        {
            Mappings = new Dictionary<string, string>{};
            CategoryPath = new List<string>{};
        }

        public virtual string Workspace { get; set; }
        public virtual string Id { get; set; }
        public virtual string Type { get; set; }
        public virtual Dictionary<string, string> Mappings { get; set; }
        public virtual List<string> CategoryPath { get; set; }
        public virtual string Delimiter { get; set; }
    }

}

C# CatalogImport 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}/CatalogImport HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CatalogImport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Catalogs">
  <CategoryPath xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CategoryPath>
  <Delimiter>String</Delimiter>
  <Id>String</Id>
  <Mappings xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Mappings>
  <Type>String</Type>
  <Workspace>String</Workspace>
</CatalogImport>