Back

POST departmentmembers

Create a department member.

Request Information

URI Parameters

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

None.

Body Parameters (OrganizationMember)

All the parameters needed to create the organization member.

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
ID globally unique identifier Required on Update

ID of the relationship between Organization and Member
SiteID globally unique identifier

ID of the site for the individual.
IndividualID globally unique identifier Required

ID of the given individual
OrganizationID globally unique identifier Required

ID of the organiztion/department the Individual is a member of
ReportsToID globally unique identifier

ID of the individual that the given individual reports to
Title string

Title of the given individual
Primary boolean

Denotes if this is the primary department/organization for the given individual. (Defaults to false)
Leader boolean

Denotes if the member is the leader of the department. (Defaults to false)
Name string

Name of the given individual
ReportsToFull string

Full name of the individual that the given individual reports to.
ReportsToOrderedName string

Full ordered name of the individual that the given individual reports to.

Request Formats

application/xml, text/xml

Sample
<OrganizationMember xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>940a73ec-fd9a-4515-be8f-01e2ba395555</ID>
  <SiteID>42a9e9fb-afc0-4795-b22a-65a75c74450e</SiteID>
  <IndividualID>5ffd0ebe-98fb-4a7c-90d4-111b37b6c0fd</IndividualID>
  <OrganizationID>975e0e38-e2df-4cea-99e9-fcb18909de45</OrganizationID>
  <ReportsToID>a98c4432-c8d1-48b3-8d1a-aba0c6e0d443</ReportsToID>
  <Title>sample string 4</Title>
  <Primary>true</Primary>
  <Leader>true</Leader>
</OrganizationMember>

application/json, text/json

Sample
{
  "ID": "940a73ec-fd9a-4515-be8f-01e2ba395555",
  "SiteID": "42a9e9fb-afc0-4795-b22a-65a75c74450e",
  "IndividualID": "5ffd0ebe-98fb-4a7c-90d4-111b37b6c0fd",
  "OrganizationID": "975e0e38-e2df-4cea-99e9-fcb18909de45",
  "ReportsToID": "a98c4432-c8d1-48b3-8d1a-aba0c6e0d443",
  "Title": "sample string 4",
  "Primary": true,
  "Leader": true
}

Response Information

Resource Description (IHttpActionResult)

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

None.

Response Formats

application/xml, text/xml, application/json, text/json

Sample

Sample not available.