POST api/office/GetFolders

Request Information

URI Parameters

None.

Body Parameters

User

Name	Type	Additional information
Email	string	None.
Password	string	None.
Validated	boolean	None.
Customers	Collection of Cust	None.
CustId	integer	None.
UplFile	UploadFile	None.

Request Formats

application/json, text/json

Sample:

{
  "Email": "sample string 1",
  "Password": "sample string 2",
  "Validated": true,
  "Customers": [
    {
      "CustId": 1,
      "CustName": "sample string 2",
      "CustFullName": "sample string 3",
      "HasAppAccess": true,
      "DeviationCategories": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "DeviationReceivers": [
            {
              "Id": 1,
              "FirstName": "sample string 2",
              "LastName": "sample string 3"
            },
            {
              "Id": 1,
              "FirstName": "sample string 2",
              "LastName": "sample string 3"
            }
          ],
          "CustomFields": [
            {
              "FieldTypeId": 1,
              "Name": "sample string 2",
              "DeviationCategoryId": 3,
              "Id": 4,
              "FieldValues": "sample string 5",
              "Mandatory": true
            },
            {
              "FieldTypeId": 1,
              "Name": "sample string 2",
              "DeviationCategoryId": 3,
              "Id": 4,
              "FieldValues": "sample string 5",
              "Mandatory": true
            }
          ]
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "DeviationReceivers": [
            {
              "Id": 1,
              "FirstName": "sample string 2",
              "LastName": "sample string 3"
            },
            {
              "Id": 1,
              "FirstName": "sample string 2",
              "LastName": "sample string 3"
            }
          ],
          "CustomFields": [
            {
              "FieldTypeId": 1,
              "Name": "sample string 2",
              "DeviationCategoryId": 3,
              "Id": 4,
              "FieldValues": "sample string 5",
              "Mandatory": true
            },
            {
              "FieldTypeId": 1,
              "Name": "sample string 2",
              "DeviationCategoryId": 3,
              "Id": 4,
              "FieldValues": "sample string 5",
              "Mandatory": true
            }
          ]
        }
      ],
      "HasChecklistAccess": true,
      "ChecklistTemplates": [
        {
          "Id": 1,
          "Name": "sample string 2"
        },
        {
          "Id": 1,
          "Name": "sample string 2"
        }
      ],
      "IncompleteChecklists": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "TemplateId": 3
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "TemplateId": 3
        }
      ],
      "DeviationDepartments": [
        {
          "Id": 1,
          "Name": "sample string 2"
        },
        {
          "Id": 1,
          "Name": "sample string 2"
        }
      ],
      "DeviationDepartmentIsMandatory": true
    },
    {
      "CustId": 1,
      "CustName": "sample string 2",
      "CustFullName": "sample string 3",
      "HasAppAccess": true,
      "DeviationCategories": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "DeviationReceivers": [
            {
              "Id": 1,
              "FirstName": "sample string 2",
              "LastName": "sample string 3"
            },
            {
              "Id": 1,
              "FirstName": "sample string 2",
              "LastName": "sample string 3"
            }
          ],
          "CustomFields": [
            {
              "FieldTypeId": 1,
              "Name": "sample string 2",
              "DeviationCategoryId": 3,
              "Id": 4,
              "FieldValues": "sample string 5",
              "Mandatory": true
            },
            {
              "FieldTypeId": 1,
              "Name": "sample string 2",
              "DeviationCategoryId": 3,
              "Id": 4,
              "FieldValues": "sample string 5",
              "Mandatory": true
            }
          ]
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "DeviationReceivers": [
            {
              "Id": 1,
              "FirstName": "sample string 2",
              "LastName": "sample string 3"
            },
            {
              "Id": 1,
              "FirstName": "sample string 2",
              "LastName": "sample string 3"
            }
          ],
          "CustomFields": [
            {
              "FieldTypeId": 1,
              "Name": "sample string 2",
              "DeviationCategoryId": 3,
              "Id": 4,
              "FieldValues": "sample string 5",
              "Mandatory": true
            },
            {
              "FieldTypeId": 1,
              "Name": "sample string 2",
              "DeviationCategoryId": 3,
              "Id": 4,
              "FieldValues": "sample string 5",
              "Mandatory": true
            }
          ]
        }
      ],
      "HasChecklistAccess": true,
      "ChecklistTemplates": [
        {
          "Id": 1,
          "Name": "sample string 2"
        },
        {
          "Id": 1,
          "Name": "sample string 2"
        }
      ],
      "IncompleteChecklists": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "TemplateId": 3
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "TemplateId": 3
        }
      ],
      "DeviationDepartments": [
        {
          "Id": 1,
          "Name": "sample string 2"
        },
        {
          "Id": 1,
          "Name": "sample string 2"
        }
      ],
      "DeviationDepartmentIsMandatory": true
    }
  ],
  "CustId": 4,
  "UplFile": {
    "Guid": "sample string 1",
    "Name": "sample string 2",
    "Ext": "sample string 3",
    "FullPath": "sample string 4",
    "FolderId": "sample string 5",
    "SetName": "sample string 6",
    "SetId": 7
  }
}

application/xml, text/xml

Sample:

<User xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ResopApi.Models.Office">
  <CustId>4</CustId>
  <Customers>
    <Cust>
      <ChecklistTemplates xmlns:d4p1="http://schemas.datacontract.org/2004/07/ResopApi.Models.Checklist">
        <d4p1:ChecklistTemplate>
          <d4p1:Id>1</d4p1:Id>
          <d4p1:Name>sample string 2</d4p1:Name>
        </d4p1:ChecklistTemplate>
        <d4p1:ChecklistTemplate>
          <d4p1:Id>1</d4p1:Id>
          <d4p1:Name>sample string 2</d4p1:Name>
        </d4p1:ChecklistTemplate>
      </ChecklistTemplates>
      <CustFullName>sample string 3</CustFullName>
      <CustId>1</CustId>
      <CustName>sample string 2</CustName>
      <DeviationCategories>
        <DeviationCategory>
          <CustomFields>
            <CustomField>
              <DeviationCategoryId>3</DeviationCategoryId>
              <FieldTypeId>1</FieldTypeId>
              <FieldValues>sample string 5</FieldValues>
              <Id>4</Id>
              <Mandatory>true</Mandatory>
              <Name>sample string 2</Name>
            </CustomField>
            <CustomField>
              <DeviationCategoryId>3</DeviationCategoryId>
              <FieldTypeId>1</FieldTypeId>
              <FieldValues>sample string 5</FieldValues>
              <Id>4</Id>
              <Mandatory>true</Mandatory>
              <Name>sample string 2</Name>
            </CustomField>
          </CustomFields>
          <DeviationReceivers>
            <DeviationReceiver>
              <FirstName>sample string 2</FirstName>
              <Id>1</Id>
              <LastName>sample string 3</LastName>
            </DeviationReceiver>
            <DeviationReceiver>
              <FirstName>sample string 2</FirstName>
              <Id>1</Id>
              <LastName>sample string 3</LastName>
            </DeviationReceiver>
          </DeviationReceivers>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </DeviationCategory>
        <DeviationCategory>
          <CustomFields>
            <CustomField>
              <DeviationCategoryId>3</DeviationCategoryId>
              <FieldTypeId>1</FieldTypeId>
              <FieldValues>sample string 5</FieldValues>
              <Id>4</Id>
              <Mandatory>true</Mandatory>
              <Name>sample string 2</Name>
            </CustomField>
            <CustomField>
              <DeviationCategoryId>3</DeviationCategoryId>
              <FieldTypeId>1</FieldTypeId>
              <FieldValues>sample string 5</FieldValues>
              <Id>4</Id>
              <Mandatory>true</Mandatory>
              <Name>sample string 2</Name>
            </CustomField>
          </CustomFields>
          <DeviationReceivers>
            <DeviationReceiver>
              <FirstName>sample string 2</FirstName>
              <Id>1</Id>
              <LastName>sample string 3</LastName>
            </DeviationReceiver>
            <DeviationReceiver>
              <FirstName>sample string 2</FirstName>
              <Id>1</Id>
              <LastName>sample string 3</LastName>
            </DeviationReceiver>
          </DeviationReceivers>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </DeviationCategory>
      </DeviationCategories>
      <DeviationDepartmentIsMandatory>true</DeviationDepartmentIsMandatory>
      <DeviationDepartments>
        <DeviationDepartment>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </DeviationDepartment>
        <DeviationDepartment>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </DeviationDepartment>
      </DeviationDepartments>
      <HasAppAccess>true</HasAppAccess>
      <HasChecklistAccess>true</HasChecklistAccess>
      <IncompleteChecklists xmlns:d4p1="http://schemas.datacontract.org/2004/07/ResopApi.Models.Checklist">
        <d4p1:ChecklistInfoModel>
          <d4p1:Id>1</d4p1:Id>
          <d4p1:Name>sample string 2</d4p1:Name>
          <d4p1:TemplateId>3</d4p1:TemplateId>
        </d4p1:ChecklistInfoModel>
        <d4p1:ChecklistInfoModel>
          <d4p1:Id>1</d4p1:Id>
          <d4p1:Name>sample string 2</d4p1:Name>
          <d4p1:TemplateId>3</d4p1:TemplateId>
        </d4p1:ChecklistInfoModel>
      </IncompleteChecklists>
    </Cust>
    <Cust>
      <ChecklistTemplates xmlns:d4p1="http://schemas.datacontract.org/2004/07/ResopApi.Models.Checklist">
        <d4p1:ChecklistTemplate>
          <d4p1:Id>1</d4p1:Id>
          <d4p1:Name>sample string 2</d4p1:Name>
        </d4p1:ChecklistTemplate>
        <d4p1:ChecklistTemplate>
          <d4p1:Id>1</d4p1:Id>
          <d4p1:Name>sample string 2</d4p1:Name>
        </d4p1:ChecklistTemplate>
      </ChecklistTemplates>
      <CustFullName>sample string 3</CustFullName>
      <CustId>1</CustId>
      <CustName>sample string 2</CustName>
      <DeviationCategories>
        <DeviationCategory>
          <CustomFields>
            <CustomField>
              <DeviationCategoryId>3</DeviationCategoryId>
              <FieldTypeId>1</FieldTypeId>
              <FieldValues>sample string 5</FieldValues>
              <Id>4</Id>
              <Mandatory>true</Mandatory>
              <Name>sample string 2</Name>
            </CustomField>
            <CustomField>
              <DeviationCategoryId>3</DeviationCategoryId>
              <FieldTypeId>1</FieldTypeId>
              <FieldValues>sample string 5</FieldValues>
              <Id>4</Id>
              <Mandatory>true</Mandatory>
              <Name>sample string 2</Name>
            </CustomField>
          </CustomFields>
          <DeviationReceivers>
            <DeviationReceiver>
              <FirstName>sample string 2</FirstName>
              <Id>1</Id>
              <LastName>sample string 3</LastName>
            </DeviationReceiver>
            <DeviationReceiver>
              <FirstName>sample string 2</FirstName>
              <Id>1</Id>
              <LastName>sample string 3</LastName>
            </DeviationReceiver>
          </DeviationReceivers>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </DeviationCategory>
        <DeviationCategory>
          <CustomFields>
            <CustomField>
              <DeviationCategoryId>3</DeviationCategoryId>
              <FieldTypeId>1</FieldTypeId>
              <FieldValues>sample string 5</FieldValues>
              <Id>4</Id>
              <Mandatory>true</Mandatory>
              <Name>sample string 2</Name>
            </CustomField>
            <CustomField>
              <DeviationCategoryId>3</DeviationCategoryId>
              <FieldTypeId>1</FieldTypeId>
              <FieldValues>sample string 5</FieldValues>
              <Id>4</Id>
              <Mandatory>true</Mandatory>
              <Name>sample string 2</Name>
            </CustomField>
          </CustomFields>
          <DeviationReceivers>
            <DeviationReceiver>
              <FirstName>sample string 2</FirstName>
              <Id>1</Id>
              <LastName>sample string 3</LastName>
            </DeviationReceiver>
            <DeviationReceiver>
              <FirstName>sample string 2</FirstName>
              <Id>1</Id>
              <LastName>sample string 3</LastName>
            </DeviationReceiver>
          </DeviationReceivers>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </DeviationCategory>
      </DeviationCategories>
      <DeviationDepartmentIsMandatory>true</DeviationDepartmentIsMandatory>
      <DeviationDepartments>
        <DeviationDepartment>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </DeviationDepartment>
        <DeviationDepartment>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </DeviationDepartment>
      </DeviationDepartments>
      <HasAppAccess>true</HasAppAccess>
      <HasChecklistAccess>true</HasChecklistAccess>
      <IncompleteChecklists xmlns:d4p1="http://schemas.datacontract.org/2004/07/ResopApi.Models.Checklist">
        <d4p1:ChecklistInfoModel>
          <d4p1:Id>1</d4p1:Id>
          <d4p1:Name>sample string 2</d4p1:Name>
          <d4p1:TemplateId>3</d4p1:TemplateId>
        </d4p1:ChecklistInfoModel>
        <d4p1:ChecklistInfoModel>
          <d4p1:Id>1</d4p1:Id>
          <d4p1:Name>sample string 2</d4p1:Name>
          <d4p1:TemplateId>3</d4p1:TemplateId>
        </d4p1:ChecklistInfoModel>
      </IncompleteChecklists>
    </Cust>
  </Customers>
  <Email>sample string 1</Email>
  <Password>sample string 2</Password>
  <UplFile>
    <Ext>sample string 3</Ext>
    <FolderId>sample string 5</FolderId>
    <FullPath>sample string 4</FullPath>
    <Guid>sample string 1</Guid>
    <Name>sample string 2</Name>
    <SetId>7</SetId>
    <SetName>sample string 6</SetName>
  </UplFile>
  <Validated>true</Validated>
</User>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of Folder

Name	Type	Additional information
ParentId	integer	None.
Id	integer	None.
Name	string	None.
IsProjectArchive	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ParentId": 1,
    "Id": 1,
    "Name": "sample string 2",
    "IsProjectArchive": true
  },
  {
    "ParentId": 1,
    "Id": 1,
    "Name": "sample string 2",
    "IsProjectArchive": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfFolder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ResopApi.Models.Office">
  <Folder>
    <Id>1</Id>
    <IsProjectArchive>true</IsProjectArchive>
    <Name>sample string 2</Name>
    <ParentId>1</ParentId>
  </Folder>
  <Folder>
    <Id>1</Id>
    <IsProjectArchive>true</IsProjectArchive>
    <Name>sample string 2</Name>
    <ParentId>1</ParentId>
  </Folder>
</ArrayOfFolder>