Field Squared API Services

<back to all web services

PortalFolder

Gives access to the PortalFolder Collection within the system

The following routes are available for this service:
GET,DELETE/{Workspace}/CustomerPortal/Folder/{ObjectId}
GET/{Workspace}/CustomerPortal/Folder/All/{ObjectId}
GET/{Workspace}/CustomerPortal/Folder/Children/{ObjectId}
GET/{Workspace}/CustomerPortal/Folder/Trunk/Node
GET/{Workspace}/CustomerPortal/Folder/Trunk/All
GET,DELETE/{Workspace}/PortalFolder/{ObjectId}
GET/{Workspace}/PortalFolder/All/{ObjectId}
GET/{Workspace}/PortalFolder/Children/{ObjectId}
GET/{Workspace}/PortalFolder/Trunk/Node
GET/{Workspace}/PortalFolder/Trunk/All
POST/{Workspace}/PortalFolder/Trunk/{Name}
GET/{Workspace}/PortalFolder/All/Id/{ObjectId}
GET/{Workspace}/PortalFolder/Trunk/All/Id
POST/{Workspace}/PortalFolder/{ParentFolderId}/Name/{Name}
POST/{Workspace}/PortalFolder
GET/{Workspace}/CustomerPortal/Folder/All/Id/{ObjectId}
GET/{Workspace}/CustomerPortal/Folder/Trunk/All/Id
POST/{Workspace}/CustomerPortal/Folder/{ParentFolderId}/Name/{Name}
POST/{Workspace}/CustomerPortal/Folder
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Gives access to the PortalFolder Collection within the system
    */
    public static class PortalFolder
    {
        public String ObjectId = null;
        public String Workspace = null;
        public String Name = null;
        public ArrayList<String> Teams = null;
        public String ParentFolderId = null;
        public ArrayList<String> Ancestors = null;
        public Boolean Enabled = null;
        public Boolean IsTrunk = null;
        public Boolean IsValid = null;
        
        public String getObjectId() { return ObjectId; }
        public PortalFolder setObjectId(String value) { this.ObjectId = value; return this; }
        public String getWorkspace() { return Workspace; }
        public PortalFolder setWorkspace(String value) { this.Workspace = value; return this; }
        public String getName() { return Name; }
        public PortalFolder setName(String value) { this.Name = value; return this; }
        public ArrayList<String> getTeams() { return Teams; }
        public PortalFolder setTeams(ArrayList<String> value) { this.Teams = value; return this; }
        public String getParentFolderId() { return ParentFolderId; }
        public PortalFolder setParentFolderId(String value) { this.ParentFolderId = value; return this; }
        public ArrayList<String> getAncestors() { return Ancestors; }
        public PortalFolder setAncestors(ArrayList<String> value) { this.Ancestors = value; return this; }
        public Boolean isEnabled() { return Enabled; }
        public PortalFolder setEnabled(Boolean value) { this.Enabled = value; return this; }
        public Boolean getIsTrunk() { return IsTrunk; }
        public PortalFolder setIsTrunk(Boolean value) { this.IsTrunk = value; return this; }
        public Boolean getIsValid() { return IsValid; }
        public PortalFolder setIsValid(Boolean value) { this.IsValid = value; return this; }
    }

}

Java PortalFolder 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}/PortalFolder/Trunk/{Name} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PortalFolder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Workspaces">
  <Ancestors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Ancestors>
  <Enabled>false</Enabled>
  <IsTrunk>false</IsTrunk>
  <Name>String</Name>
  <ObjectId>String</ObjectId>
  <ParentFolderId>String</ParentFolderId>
  <Teams xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Teams>
  <Workspace>String</Workspace>
</PortalFolder>