POST periods

Request Information

URI Parameters

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

None.

Body Parameters (Period)

Contains the dates needed to create a new period.

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

Name	Description
ID `integer` Required on Update ID of the given period.	`integer` Required on Update ID of the given period.
SiteID `globally unique identifier` Required on Create ID of the site for the given period.	`globally unique identifier` Required on Create ID of the site for the given period.
StartDate `date` Required Start date of the given period.	`date` Required Start date of the given period.
EndDate `date` Required End date of the given period.	`date` Required End date of the given period.
TotalProjects `integer` ReadOnly Total number of projects for the given period.	`integer` ReadOnly Total number of projects for the given period.
TotalCommitments `integer` ReadOnly Total number of commitments for the given period.	`integer` ReadOnly Total number of commitments for the given period.
DateSpan `string` ReadOnly Span of dates for the given period.	`string` ReadOnly Span of dates for the given period.
Permissions `integer` ReadOnly Permissions for the given period.	`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>a400619a-be82-404f-8dde-f4dab204a553</SiteID>
  <StartDate>2025-02-05T00:16:37.3866355+00:00</StartDate>
  <EndDate>2025-02-05T00:16:37.3866355+00:00</EndDate>
</Period>

application/json, text/json

Sample

,"Permissions":0,"ID":1,"SiteID":"a400619a-be82-404f-8dde-f4dab204a553","StartDate":"2025-02-05T00:16:37.3866355+00:00","EndDate":"2025-02-05T00:16:37.3866355+00:00"}

Response Information

Resource Description (Period)

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

Name	Description
ID `integer` Required on Update ID of the given period.	`integer` Required on Update ID of the given period.
SiteID `globally unique identifier` Required on Create ID of the site for the given period.	`globally unique identifier` Required on Create ID of the site for the given period.
StartDate `date` Required Start date of the given period.	`date` Required Start date of the given period.
EndDate `date` Required End date of the given period.	`date` Required End date of the given period.
TotalProjects `integer` ReadOnly Total number of projects for the given period.	`integer` ReadOnly Total number of projects for the given period.
TotalCommitments `integer` ReadOnly Total number of commitments for the given period.	`integer` ReadOnly Total number of commitments for the given period.
DateSpan `string` ReadOnly Span of dates for the given period.	`string` ReadOnly Span of dates for the given period.
Permissions `integer` ReadOnly Permissions for the given period.	`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>8fc12443-caba-4daf-a8e2-8204c73dbbfa</SiteID>
  <StartDate>2025-02-05T00:16:37.3866355+00:00</StartDate>
  <EndDate>2025-02-05T00:16:37.3866355+00:00</EndDate>
</Period>

application/json, text/json

Sample

{
  "TotalProjects": 1,
  "TotalCommitments": 1,
  "DateSpan": "sample string 5",
  "Permissions": 6,
  "ID": 1,
  "SiteID": "8fc12443-caba-4daf-a8e2-8204c73dbbfa",
  "StartDate": "2025-02-05T00:16:37.3866355+00:00",
  "EndDate": "2025-02-05T00:16:37.3866355+00:00"
}