Request Information

URI Parameters

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

ID of the period to be updated.

Body Parameters (Period)

Contains the parameters needed to update a period.

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

ID of the given period.

SiteID globally unique identifier Required on Create

ID of the site for the given period.

StartDate date Required

Start date of the given period.

EndDate date Required

End date of the given period.

TotalProjects integer ReadOnly

Total number of projects for the given period.

TotalCommitments integer ReadOnly

Total number of commitments for the given period.

DateSpan string ReadOnly

Span of dates for the given period.

Permissions integer ReadOnly

Permissions for the given period.

Request Formats

application/xml, text/xml

Sample
<Period xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <Permissions>0</Permissions>
  <ID>1</ID>
  <SiteID>f0aa81cd-448f-450d-8662-064bd48a63bc</SiteID>
  <StartDate>2021-11-03T19:00:00.4166594+00:00</StartDate>
  <EndDate>2021-11-03T19:00:00.4166594+00:00</EndDate>
</Period>

application/json, text/json

Sample
,"Permissions":0,"ID":1,"SiteID":"f0aa81cd-448f-450d-8662-064bd48a63bc","StartDate":"2021-11-03T19:00:00.4166594+00:00","EndDate":"2021-11-03T19:00:00.4166594+00:00"}

Response Information

Resource Description (Period)

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

ID of the given period.

SiteID globally unique identifier Required on Create

ID of the site for the given period.

StartDate date Required

Start date of the given period.

EndDate date Required

End date of the given period.

TotalProjects integer ReadOnly

Total number of projects for the given period.

TotalCommitments integer ReadOnly

Total number of commitments for the given period.

DateSpan string ReadOnly

Span of dates for the given period.

Permissions integer ReadOnly

Permissions for the given period.

Response Formats

application/xml, text/xml

Sample
<Period xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <DateSpan>sample string 5</DateSpan>
  <Permissions>6</Permissions>
  <TotalCommitments>1</TotalCommitments>
  <TotalProjects>1</TotalProjects>
  <ID>1</ID>
  <SiteID>06d42e69-2865-49db-9175-954a496a8121</SiteID>
  <StartDate>2021-11-03T19:00:00.4166594+00:00</StartDate>
  <EndDate>2021-11-03T19:00:00.4166594+00:00</EndDate>
</Period>

application/json, text/json

Sample
{
  "TotalProjects": 1,
  "TotalCommitments": 1,
  "DateSpan": "sample string 5",
  "Permissions": 6,
  "ID": 1,
  "SiteID": "06d42e69-2865-49db-9175-954a496a8121",
  "StartDate": "2021-11-03T19:00:00.4166594+00:00",
  "EndDate": "2021-11-03T19:00:00.4166594+00:00"
}