Request Information

URI Parameters

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

None.

Body Parameters (Status)

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

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

ID of the status.

Name string Required

Name of the status. (Max length 50 characters)

Rank integer Required

Rank of the status.

ShowForInd boolean Required on Create

Show for an Individual.

SiteID globally unique identifier Required on Create

ID of the site for the status.

Request Formats

application/xml, text/xml

Sample
<Status xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>1</ID>
  <Name>sample string 1</Name>
  <Rank>1</Rank>
  <ShowForInd>true</ShowForInd>
  <SiteID>fe573e63-1436-4d93-9f7a-513b7774e7ce</SiteID>
</Status>

application/json, text/json

Sample
{
  "ID": 1,
  "Name": "sample string 1",
  "Rank": 1,
  "ShowForInd": true,
  "SiteID": "fe573e63-1436-4d93-9f7a-513b7774e7ce"
}

Response Information

Resource Description (Status)

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

ID of the status.

Name string Required

Name of the status. (Max length 50 characters)

Rank integer Required

Rank of the status.

ShowForInd boolean Required on Create

Show for an Individual.

SiteID globally unique identifier Required on Create

ID of the site for the status.

Response Formats

application/xml, text/xml

Sample
<Status xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>1</ID>
  <Name>sample string 1</Name>
  <Rank>1</Rank>
  <ShowForInd>true</ShowForInd>
  <SiteID>8192948f-bc31-4c49-a2e5-1cd328d40e24</SiteID>
</Status>

application/json, text/json

Sample
{
  "ID": 1,
  "Name": "sample string 1",
  "Rank": 1,
  "ShowForInd": true,
  "SiteID": "8192948f-bc31-4c49-a2e5-1cd328d40e24"
}