Back

GET departments?deleted={deleted}

Read departments.

Request Information

URI Parameters

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

Add ?deleted=0, 1, or 2 for not deleted, deleted, or all.

Body Parameters

None.

Response Information

Resource Description (Organization)

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
ID 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.
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.
Rank integer Required

Rank of the given organization/department.
Name 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)
Focus string

Focus of the given organization/department.
Picture Collection of byte

Picture of the given organization/department.
RowType 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.
RankOrder string ReadOnly

Rank in string format, (0001.0001.0001) for the given organization/department.
DisplayRank string ReadOnly

Rank that is actually displayed.
Level 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.
Deleted boolean ReadOnly

Deleted status of the given organization/department.
DeletedByRef boolean ReadOnly

Deleted by reference status of the given organization/department.
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.
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.
LastComment string ReadOnly

Body of the most recent comment.
LastCommentDate date ReadOnly

Date the most recent comment was posted.
LastCommentByID 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.
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.
CanRead 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.
CanDelete 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.

Response Formats

application/xml, text/xml

Sample
<Organization xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>0ef45568-e438-4e19-9018-65ee119876dd</ID>
  <SiteID>84b9f09f-980e-41e5-99bb-94535f7b5b1e</SiteID>
  <ParentID>bfe06c91-d7f8-4ddc-827c-a7c3c8846fd4</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:33:52.0345814+00:00</Created>
  <CreatedBy>c9401b5c-28aa-4be1-91ab-f8b4763baa2e</CreatedBy>
  <Updated>2024-10-24T07:33:52.0345814+00:00</Updated>
  <UpdatedBy>f42d4796-54e6-4e41-8143-6530fa71a1f3</UpdatedBy>
  <LastComment>sample string 7</LastComment>
  <LastCommentDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2024-10-24T07:33:52.0345814Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </LastCommentDate>
  <LastCommentByID>29d0a5de-6de2-438f-ab25-812508f855b7</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": "0ef45568-e438-4e19-9018-65ee119876dd",
  "SiteID": "84b9f09f-980e-41e5-99bb-94535f7b5b1e",
  "ParentID": "bfe06c91-d7f8-4ddc-827c-a7c3c8846fd4",
  "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:33:52.0345814+00:00",
  "CreatedBy": "c9401b5c-28aa-4be1-91ab-f8b4763baa2e",
  "Updated": "2024-10-24T07:33:52.0345814+00:00",
  "UpdatedBy": "f42d4796-54e6-4e41-8143-6530fa71a1f3",
  "LastComment": "sample string 7",
  "LastCommentDate": "2024-10-24T07:33:52.0345814+00:00",
  "LastCommentByID": "29d0a5de-6de2-438f-ab25-812508f855b7",
  "LastCommentBy": "sample string 8",
  "ParentName": "sample string 9",
  "CanRead": true,
  "CanUpdate": true,
  "CanDelete": true,
  "CanDelegate": true
}