REST API: Check File Directory Name Availability

Anonymous User

Published: 5/5/2015

Grace Kamau

Updated: 12/5/2020

0 (0votes)

Check File Directory Name Availability

Check whether a file directory name is available for use or if it already exists. Valid for Communifire version 5.2 and above.

HTTP Method

GET

Response Format

JSON

Requires Authentication?

YES

Product Version

5.2 and above

Required Parameters	How to use	Description
API Key	Used in the request URL: &token=x OR Set in header: request.Headers.Add(Rest-Api-Key, x)	Communifire REST API key for the Communifire portal you are making the call for.
ParentID	&ParentID=x - Used in the request URL (see below)	ID of the parent directory.
DirectoryID	&DirectoryID=x - Used in the request URL (see below)	ID of the directory to be excluded from name availability check.
DirectoryName	&DirectoryName=x - Used in the request URL (see below)	Name whose availability needs to be checked.

True/false is returned as ResponseData.

{
    "IsError":false,
    "ResponseMessage":"",
    "ResponseData":true
}

Please Note The content type that you pass in the header of your request should be application/json.