Request Information

URI Parameters

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

None.

Body Parameters (Phase)

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

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

ID of the phase.

SiteID globally unique identifier Required

ID of the site for the phase.

Name string Required

Name of the phase. (Max length 50 characters)

Rank integer Required

Rank of the phase.

Request Formats

application/xml, text/xml

Sample
<Phase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>1</ID>
  <SiteID>2f89c9ba-029f-4b12-a365-a9b6e1dfd08d</SiteID>
  <Name>sample string 1</Name>
  <Rank>1</Rank>
</Phase>

application/json, text/json

Sample
{
  "ID": 1,
  "SiteID": "2f89c9ba-029f-4b12-a365-a9b6e1dfd08d",
  "Name": "sample string 1",
  "Rank": 1
}

Response Information

Resource Description (Phase)

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

ID of the phase.

SiteID globally unique identifier Required

ID of the site for the phase.

Name string Required

Name of the phase. (Max length 50 characters)

Rank integer Required

Rank of the phase.

Response Formats

application/xml, text/xml

Sample
<Phase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>1</ID>
  <SiteID>374b092c-dd62-4c51-9b9f-d09aebc7cd42</SiteID>
  <Name>sample string 1</Name>
  <Rank>1</Rank>
</Phase>

application/json, text/json

Sample
{
  "ID": 1,
  "SiteID": "374b092c-dd62-4c51-9b9f-d09aebc7cd42",
  "Name": "sample string 1",
  "Rank": 1
}