POST departments

Request Information

URI Parameters

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList

None.

Body Parameters (Organization)

This object takes all the parameters needed to create a new department.

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList

Request Formats

application/xml, text/xml

Sample

<Organization xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>08412269-4eae-4d9d-bf58-195b365b04c0</ID>
  <SiteID>554c2d88-fbcd-42c0-9f66-0cde7f452d51</SiteID>
  <ParentID>f3403c70-d19d-4768-8cb7-93c496419fe1</ParentID>
  <Rank>1</Rank>
  <Name>sample string 1</Name>
  <EmotionalGoal>sample string 2</EmotionalGoal>
  <Focus>sample string 3</Focus>
  <Picture>QEA=</Picture>
</Organization>

application/json, text/json

Sample

{
  "ID": "08412269-4eae-4d9d-bf58-195b365b04c0",
  "SiteID": "554c2d88-fbcd-42c0-9f66-0cde7f452d51",
  "ParentID": "f3403c70-d19d-4768-8cb7-93c496419fe1",
  "Rank": 1,
  "Name": "sample string 1",
  "EmotionalGoal": "sample string 2",
  "Focus": "sample string 3",
  "Picture": "QEA="
}

Response Information

Resource Description (Organization)

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList

Response Formats

application/xml, text/xml

Sample

<Organization xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>0eb17e49-bebe-47f2-ab2d-f17f591d1d9d</ID>
  <SiteID>0851b025-9570-4d55-9560-c9b45acb056e</SiteID>
  <ParentID>1e0ce34a-2315-4537-9eea-160d8db3a357</ParentID>
  <Rank>1</Rank>
  <Name>sample string 1</Name>
  <EmotionalGoal>sample string 2</EmotionalGoal>
  <Focus>sample string 3</Focus>
  <Picture>QEA=</Picture>
  <RowType>1</RowType>
  <RankPath>QEA=</RankPath>
  <RankOrder>sample string 4</RankOrder>
  <DisplayRank>sample string 5</DisplayRank>
  <Level>1</Level>
  <Values>sample string 6</Values>
  <Deleted>true</Deleted>
  <DeletedByRef>true</DeletedByRef>
  <Created>2024-10-24T07:37:57.5780909+00:00</Created>
  <CreatedBy>d027c23e-c41c-4be7-aea3-166cf8bf46b0</CreatedBy>
  <Updated>2024-10-24T07:37:57.5780909+00:00</Updated>
  <UpdatedBy>506c4d15-aa3f-4fb0-9390-e23b18458b7b</UpdatedBy>
  <LastComment>sample string 7</LastComment>
  <LastCommentDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2024-10-24T07:37:57.5780909Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </LastCommentDate>
  <LastCommentByID>8da79868-7840-4e34-bd83-aee6272c18be</LastCommentByID>
  <LastCommentBy>sample string 8</LastCommentBy>
  <ParentName>sample string 9</ParentName>
  <CanRead>true</CanRead>
  <CanUpdate>true</CanUpdate>
  <CanDelete>true</CanDelete>
  <CanDelegate>true</CanDelegate>
</Organization>

application/json, text/json

Sample

{
  "ID": "0eb17e49-bebe-47f2-ab2d-f17f591d1d9d",
  "SiteID": "0851b025-9570-4d55-9560-c9b45acb056e",
  "ParentID": "1e0ce34a-2315-4537-9eea-160d8db3a357",
  "Rank": 1,
  "Name": "sample string 1",
  "EmotionalGoal": "sample string 2",
  "Focus": "sample string 3",
  "Picture": "QEA=",
  "RowType": 1,
  "RankPath": "QEA=",
  "RankOrder": "sample string 4",
  "DisplayRank": "sample string 5",
  "Level": 1,
  "Values": "sample string 6",
  "Deleted": true,
  "DeletedByRef": true,
  "Created": "2024-10-24T07:37:57.5780909+00:00",
  "CreatedBy": "d027c23e-c41c-4be7-aea3-166cf8bf46b0",
  "Updated": "2024-10-24T07:37:57.5780909+00:00",
  "UpdatedBy": "506c4d15-aa3f-4fb0-9390-e23b18458b7b",
  "LastComment": "sample string 7",
  "LastCommentDate": "2024-10-24T07:37:57.5780909+00:00",
  "LastCommentByID": "8da79868-7840-4e34-bd83-aee6272c18be",
  "LastCommentBy": "sample string 8",
  "ParentName": "sample string 9",
  "CanRead": true,
  "CanUpdate": true,
  "CanDelete": true,
  "CanDelegate": true
}

Name	Description
ID `globally unique identifier` Required on Update ID of the given organization/department.	`globally unique identifier` Required on Update ID of the given organization/department.
SiteID `globally unique identifier` ID of the site for the given organization/department.	`globally unique identifier` ID of the site for the given organization/department.
ParentID `globally unique identifier` ID of the parent for the given organization/department. This will be a site ID for a given organization or an organization ID for a given department.	`globally unique identifier` ID of the parent for the given organization/department. This will be a site ID for a given organization or an organization ID for a given department.
Rank `integer` Required Rank of the given organization/department.	`integer` Required Rank of the given organization/department.
Name `string` Required Name of the given organization/department. (Max length 100 characters)	`string` Required Name of the given organization/department. (Max length 100 characters)
EmotionalGoal `string` Emotional Goal of the given organization/department. (Max length 1000 characters)	`string` Emotional Goal of the given organization/department. (Max length 1000 characters)
Focus `string` Focus of the given organization/department.	`string` Focus of the given organization/department.
Picture `Collection of byte` Picture of the given organization/department.	`Collection of byte` Picture of the given organization/department.
RowType `integer` ReadOnly RowType of the given organization(4) or department(56).	`integer` ReadOnly RowType of the given organization(4) or department(56).
RankPath `Collection of byte` ReadOnly Current rank of the given Organization/Department in a byte array.	`Collection of byte` ReadOnly Current rank of the given Organization/Department in a byte array.
RankOrder `string` ReadOnly Rank in string format, (0001.0001.0001) for the given organization/department.	`string` ReadOnly Rank in string format, (0001.0001.0001) for the given organization/department.
DisplayRank `string` ReadOnly Rank that is actually displayed.	`string` ReadOnly Rank that is actually displayed.
Level `integer` ReadOnly Number of indent levels, Ex: 1 = 1, 1.1 = 2, 1.1.1 = 3	`integer` ReadOnly Number of indent levels, Ex: 1 = 1, 1.1 = 2, 1.1.1 = 3
Values `string` ReadOnly Value of the given organization/department.	`string` ReadOnly Value of the given organization/department.
Deleted `boolean` ReadOnly Deleted status of the given organization/department.	`boolean` ReadOnly Deleted status of the given organization/department.
DeletedByRef `boolean` ReadOnly Deleted by reference status of the given organization/department.	`boolean` ReadOnly Deleted by reference status of the given organization/department.
Created `date` ReadOnly Date the given organization/department was created.	`date` ReadOnly Date the given organization/department was created.
CreatedBy `globally unique identifier` ReadOnly ID of the individual who created the given organization/department.	`globally unique identifier` ReadOnly ID of the individual who created the given organization/department.
Updated `date` ReadOnly The date that the given organization/department was last updated.	`date` ReadOnly The date that the given organization/department was last updated.
UpdatedBy `globally unique identifier` ReadOnly The ID of the individual that updated the given organization/department.	`globally unique identifier` ReadOnly The ID of the individual that updated the given organization/department.
LastComment `string` ReadOnly Body of the most recent comment.	`string` ReadOnly Body of the most recent comment.
LastCommentDate `date` ReadOnly Date the most recent comment was posted.	`date` ReadOnly Date the most recent comment was posted.
LastCommentByID `globally unique identifier` ReadOnly ID of the user who posted the most recent comment.	`globally unique identifier` ReadOnly ID of the user who posted the most recent comment.
LastCommentBy `string` ReadOnly Name of the user who posted the most recent comment.	`string` ReadOnly Name of the user who posted the most recent comment.
ParentName `string` ReadOnly Name of the parent for the given Organization/Department. This will be a site for a given organization or an organization for a given department.	`string` ReadOnly Name of the parent for the given Organization/Department. This will be a site for a given organization or an organization for a given department.
CanRead `boolean` ReadOnly Read security setting for the object based on the current logged in user.	`boolean` ReadOnly Read security setting for the object based on the current logged in user.
CanUpdate `boolean` ReadOnly Update security setting for the object based on the current logged in user.	`boolean` ReadOnly Update security setting for the object based on the current logged in user.
CanDelete `boolean` ReadOnly Delete security setting for the object based on the current logged in user.	`boolean` ReadOnly Delete security setting for the object based on the current logged in user.
CanDelegate `boolean` ReadOnly Delegate security setting for the object based on the current logged in user.	`boolean` ReadOnly Delegate security setting for the object based on the current logged in user.