Api Doc Changes

Author: kanika2024

source/includes/_project.md

@@ -22,7 +22,6 @@
       "description": "Pacific/Honolulu",
       "id": 316
     },
-    "project_calendar": 1,
     "disable_parallel_booking": false,
     "is_archive": false,
     "created_on": "2018-08-20T09:25:34.925474Z",
@@ -61,7 +60,7 @@ Name      |  Description
 **image** <br>`string` | String value representing URL of image file of project.
 **tags** <br>`array of strings` | Tags are the list of strings (labels) attached to this project object which could be used for the purpose of filtering, identification or other information.
 **timezone** <br>`integer` | Defines and categorize projects based on their location. This field is only available when scheduling plus module is on.
-**project_calender** <br>`integer` | ID of the Calendar object, which should be assigned to the project. Depending upon requirements, different calendars can be applied to different projects. If the calendar is omitted, then the default calendar (as defined in the Administrator calendar settings) will be applied to this project.This field is only available when scheduling plus module is on.
+**project_calendar** <br>`integer` | ID of the Calendar object, which should be assigned to the project. Depending upon requirements, different calendars can be applied to different projects. If the calendar is omitted, then the default calendar (as defined in the Administrator calendar settings) will be applied to this project.This field is only available when scheduling plus module is on.
 **is_archive** <br>`boolean` | Boolean value representing whether this project is archived or not.
 **created_on** <br>`string` | Timestamp at which this project object was created.
 **created_by** <br> `object` | Object representing user who created this project object.
@@ -102,7 +101,7 @@ Name               |  Description
 **end_date**<br><span class="mandatoryFlag">&#9873;</span> <span class="removableFlag mln-2">&#9873;</span> | String value representing a date in ISO 8601 extended notation for date i.e. yyyy-MM-dd.
 **tags**<br><span class="removableFlag mln-2">&#9873;</span> | An optional array of strings which could be attached to this project object as labels. This can be useful for the purpose of filtering, identification or other information.
 **timezone** <br><span class="mandatoryFlag">&#9873;</span> <span class="removableFlag mln-2">&#9873;</span> | One timezone object can be defined for a project.<br><br>_**Note**: <span class="warning">This field is only available when scheduling plus module is on</span>._
-**project_calender** <br>| ID of the Calendar object, which should be assigned to the project. Depending upon requirements, different calendars can be applied to different projects. If the calendar is omitted, then the default calendar (as defined in the Administrator calendar settings) will be applied to this project.<br><br>_**Note**: <span class="warning">This field is only available when scheduling plus module is on</span>._
+**project_calendar** <br>| ID of the Calendar object, which should be assigned to the project. Depending upon requirements, different calendars can be applied to different projects. If the calendar is omitted, then the default calendar (as defined in the Administrator calendar settings) will be applied to this project.<br><br>_**Note**: <span class="warning">This field is only available when scheduling plus module is on</span>._
 **disable_parallel_booking** <br>`optional` | Boolean value defining if project can or cannot have multiple bookings at a time. Default value for disable parallel booking is false.
 **udf_\*** <br><span class="mandatoryFlag">&#9873;</span> <span class="removableFlag mln-2">&#9873;</span> | A user with Administrator rights can add custom fields. These fields can be used to capture additional information in Projects. Different types of projects may have a different set of user-defined fields. The value for user defined field can be passed as shown in example request. In given example `udf_confirmed`</span> is a user defined field. <a href="#user-defined-fields" class="api-ref">Learn more</a><br><br>_**Note**: User with Administrator rights can make fields marked with <span class="mandatoryFlag iconInline">&#9873;</span> mandatory and remove fields marked with <span class="removableFlag iconInline">&#9873;</span>, from <a href ="#get-a-specific-project-type" class="api-ref">specific project type</a> using eRS Cloud Application. If mandatory fields are not passed with a valid value or removed fields are passed while creating project, the operation will fail with response code **400**_.
 
@@ -166,7 +165,6 @@ curl -v \
         "description": "Pacific/Honolulu",
         "id": 316
       },
-      "project_calendar": 1,
       "disable_parallel_booking": false,
       "is_archive": false,
       "created_on": "2018-08-20T09:25:34.925474Z",
@@ -246,8 +244,8 @@ curl -v "https://app.eresourcescheduler.cloud/rest/v1/projects/1" \
     "id": 316
   },
   "project_calendar": {
-    "name": "blank",
-    "id": 2
+    "name": "Default",
+    "id": 1
     },
   "disable_parallel_booking": false,
   "is_archive": false,
@@ -425,7 +423,7 @@ curl -v -X PUT \
 **email**<br><span class="mandatoryFlag">&#9873;</span> <span class="removableFlag mln-2">&#9873;</span> | String value representing email address associated with project object. Email address must be properly formatted with a maximum length of 254 characters.
 **tags**<br><span class="removableFlag mln-2">&#9873;</span> | An optional array of strings which could be attached to this project object as labels. This can be useful for the purpose of filtering, identification or other information. It can be up to 50 characters.
 **timezone** <br><span class="mandatoryFlag">&#9873;</span> <span class="removableFlag mln-2">&#9873;</span> | One timezone object can be defined for a project.<br><br>_**Note**: <span class="warning">This field is only available when scheduling plus module is on</span>._
-**project_calender** <br>| ID of the Calendar object, which should be assigned to the project. Depending upon requirements, different calendars can be applied to different projects. If the calendar is omitted, then the default calendar (as defined in the Administrator calendar settings) will be applied to this project.<br><br>_**Note**: <span class="warning">This field is only available when scheduling plus module is on</span>._
+**project_calendar** <br>| ID of the Calendar object, which should be assigned to the project. Depending upon requirements, different calendars can be applied to different projects. If the calendar is omitted, then the default calendar (as defined in the Administrator calendar settings) will be applied to this project.<br><br>_**Note**: <span class="warning">This field is only available when scheduling plus module is on</span>._
 **disable_parallel_booking** <br>`optional` | Boolean value defining if project can or cannot have multiple bookings at a time. Default value for disable parallel booking is false.
 **udf_\*** <br><span class="mandatoryFlag">&#9873;</span> <span class="removableFlag mln-2">&#9873;</span> | A user with Administrator rights can add custom fields. These fields can be used to capture additional information in Project. Different types of projects may have a different set of user-defined fields. The value for user defined field can be passed as shown in example request. In first example `udf_progress` is a user defined field. <a href ="#user-defined-fields" class="api-ref">Learn more</a><br><br>_**Note**: User with Administrator rights can make fields marked with <span class="mandatoryFlag iconInline">&#9873;</span> mandatory and remove fields marked with <span class="removableFlag iconInline">&#9873;</span>, from <a href ="#get-a-specific-project-type" class="api-ref">specific project type</a> using eRS Cloud Application. If mandatory fields are not passed with a valid value or removed fields are passed while updating project, the operation will fail with response code **400**_.
 

source/includes/_requirement.md

@@ -113,7 +113,7 @@ Name         |  Description
 **flexi_range_duration** <br>`integer` | Represents the defined duration range for flexibility in fulfilling the requirement compared to the original requirement date.
 **flexi_range_unit** <br>`integer` | Represents a unit that allows for flexibility in fulfilling the requirement. Unit value could be one of the following:<br><br><li> **1** for `Hours` : Refers to 'hours' as a unit.</li><li> **2** for `Days` : Refers to 'days' as a unit.</li><br>
 **allow_multi_allocation** <br>`boolean` | This refers to allocation of a specific requirement to multiple assignment.
-**is_link_booking** <br>`boolean` | This refers to hardinking of, common UDF of booking with requirement.
+**is_link_booking** <br>`boolean` | This refers to hard-linking of a common UDF of booking with requirement's.
 **conditions** <br>`array of object` | This refers to the criteria on which the requirement must be fulfilled.<li>**conditions.field** `string` <br> This is a reference to the text's API_code.</li> <li>**<a href="#requirement-operator" class="api-ref">conditions.operator</a>** `string`  <br> This refers to a character that represents a specific mathematical or logical action or process. </li><li>**conditions.values** <br>This refers to the values defined for the requirement to be considered in suggested resources.</li><li>**conditions.weightage** `integer`  <br> Every condition can be assigned relative importance in comparison to other conditions to calculate its weightage. Weightage is ultimately used to calculate the match score of resources.</li> <li>**conditions.is_mandatory** `boolean` <br> Indicates whether this field is mandatory. If this field is marked as mandatory, it means that a required value must be provided for it in the suggested resources.</li>
 **created_on** <br>`string` | Timestamp at which this requirement object was created.
 **created_by** <br> `object` | Object representing user who created this requirement object.
@@ -181,7 +181,7 @@ Name               |  Description
 **flexi_range_duration** <br>`integer` |Represents the defined duration range for flexibility in fulfilling the requirement compared to the original requirement date.
 **flexi_range_unit** <br>`integer` | Represents a unit that allows for flexibility in fulfilling the requirement. Unit value could be one of the following:<br><br><li> **1** for `Hours` : Refers to 'hours' as a unit</li><li> **2** for `Days` : Refers to 'days' as a unit </li><br>
 **allow_multi_allocation** <br>`boolean` | This refers to allocation of a specific requirement to multiple resources simultaneously.
-**is_link_booking** <br>`boolean` | This refers to hardinking of, common UDF of booking with requirement.
+**is_link_booking** <br>`boolean` | This refers to hard-linking of a common UDF of booking with requirement's.
 **conditions** <br>`array of object` | This refers to the criteria on which the requirement must be fulfilled.<li>**conditions.field** `string` <br> This is a reference to the text's API_code.</li> <li><a href="#requirement-operator" class="api-ref">conditions.operator</a>`string`  <br> This refers to a character that represents a specific mathematical or logical action or process. </li><li>**conditions.values** <br>This refers to the values defined for the requirement to be considered in suggested resources.</li> <li>**conditions.weightage** `integer`  <br> Every condition can be assigned relative importance in comparison to other conditions to calculate its weightage. Weightage is ultimately used to calculate the match score of resources.</li> <li>**conditions.is_mandatory** `boolean` <br> Indicates whether this field is mandatory. If this field is marked as mandatory, it means that a required value must be provided for it in the suggested resources.</li>
 **udf_\***<br><span class="mandatoryFlag">&#9873;</span> <span class="removableFlag mln-2">&#9873;</span> | A user with Administrator rights can add custom fields. These fields can be used to capture additional information in Requirements. The value for user defined field can be passed as shown in example request. In given example `udf_confirmed`</span> is a user defined field. <a href="#user-defined-fields" class="api-ref">Learn more</a><br><br>_**Note**: User with Administrator rights can make fields marked with <span class="mandatoryFlag iconInline">&#9873;</span> mandatory and remove fields marked with <span class="removableFlag iconInline">&#9873;</span>, from <a href ="#requirement-profile" class="api-ref">requirement profile</a> using eRS Cloud Application. If mandatory fields are not passed with a valid value or removed fields are passed while creating requirement, the operation will fail with response code **400**_.
 
@@ -657,7 +657,7 @@ Name               |  Description
 **flexi_range_duration** <br>`integer` | Represents the defined duration range for flexibility in fulfilling the requirement compared to the original requirement date.
 **flexi_range_unit** <br>`integer` | Represents a unit that allows for flexibility in fulfilling the requirement. Unit value could be one of the following:<br><br><li> **1** for `Hours` : Refers to 'hours' as a unit.</li><li> **2** for `Days` : Refers to 'days' as a unit.</li><br>
 **allow_multi_allocation** <br>`boolean` | This refers to allocation of a specific requirement to multiple resources simultaneously.
-**is_link_booking** <br>`boolean` | This refers to hardinking of, common UDF of booking with requirement.
+**is_link_booking** <br>`boolean` | This refers to hard-linking of a common UDF of booking with requirement's.
 **conditions** <br>`array of object` | This refers to the criteria on which the requirement must be fulfilled.<li>**conditions.field** `string` <br> This is a reference to the text's API_code.</li> <li><a href="#requirement-operator" class="api-ref">conditions.operator</a>`string`  <br> This refers to a character that represents a specific mathematical or logical action or process. </li><li>**conditions.values** <br>This refers to the values defined for the requirement to be considered in suggested resources.</li> <li>**conditions.weightage** `integer`  <br> Every condition can be assigned relative importance in comparison to other conditions to calculate its weightage. Weightage is ultimately used to calculate the match score of resources.</li> <li>**conditions.is_mandatory** `boolean` <br> Indicates whether this field is mandatory. If this field is marked as mandatory, it means that a required value must be provided for it in the suggested resources.</li>
 **udf_\***<br><span class="mandatoryFlag">&#9873;</span> <span class="removableFlag mln-2">&#9873;</span> | A user with Administrator rights can add such custom fields. These fields can be used to capture additional info in requirements. <a href="#user-defined-fields" class="api-ref">Learn more</a><br><br>_**Note**: User with Administrator rights can make fields marked with <span class="mandatoryFlag iconInline">&#9873;</span> mandatory and remove fields marked with <span class="removableFlag iconInline">&#9873;</span>, from <a href ="#requirement-profile" class="api-ref">requirement profile</a> using eRS Cloud Application. If mandatory fields are not passed with a valid value or removed fields are passed while updating booking, the operation will fail with response code **400**_.