Request Information

URI Parameters

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

ID of the individual.

period integer

ID of the period.

Body Parameters

None.

Response Information

Resource Description (Goal)

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

ID of the given goal.

IndividualID globally unique identifier Required on Create

ID of the individual for the given goal.

Name string Required

Name of the given goal.

Completed boolean Required

Completed status of the given goal.

Comment string Required

Comment about the given goal.

Why string Required

Reason for the given goal.

DueDate date Required

Date the given goal should be completed.

PeriodID integer Required

ID of the period for the given goal.

Measure1 string Required

First objective for the given goal.

Measure1Completed boolean Required

Completed status of the first objective for the given goal.

Measure1EndDate date Required

End date of the first objective for the given goal.

Measure1StartDate date Required

Start date of the first objective for the given goal.

Measure2 string Required

Second objective for the given goal.

Measure2Completed boolean

Completed status of the second objective for the given goal.

Measure2EndDate date Required

End date of the second objective for the given goal.

Measure2StartDate date Required

Start date of the second objective for the given goal.

Measure3 string Required

Third objective for the given goal.

Measure3Completed boolean Required

Completed status of the third objective for the given goal.

Measure3EndDate date

End date of the third objective for the given goal.

Measure3StartDate date Required

Start date of the third objective for the given goal.

Measure4 string Required

Fourth objective for the given goal.

Measure4Completed boolean Required

Completed status of the fourth objective for the given goal.

Measure4EndDate date Required

End date of the fourth objective for the given goal.

Measure4StartDate date Required

Start date of the fourth objective for the given goal.

Measure5 string Required

Fifth objective for the given goal.

Measure5Completed boolean Required

Completed status of the fifth objective for the given goal.

Measure5EndDate date Required

End date of the fifth objective for the given goal.

Measure5StartDate date Required

Start date of the fifth objective for the given goal.

SiteID globally unique identifier ReadOnly

ID of the site for the given goal.

FullName string ReadOnly

Full name of the individual for the given goal.

MeasuresCompleted integer ReadOnly

Sum of the measures completed for the given goal.

MeasuresTotal integer ReadOnly

Sum of all the measures for the given goal.

Response Formats

application/xml, text/xml

Sample
<Goal xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <FullName>sample string 14</FullName>
  <MeasuresCompleted>1</MeasuresCompleted>
  <MeasuresTotal>1</MeasuresTotal>
  <SiteID>daa81cdf-79ca-423c-9216-7cb100919a34</SiteID>
  <ID>1</ID>
  <IndividualID>85b7df53-7792-4264-bcf8-23783b39c10b</IndividualID>
  <Name>sample string 3</Name>
  <Completed>true</Completed>
  <Comment>sample string 5</Comment>
  <Why>sample string 6</Why>
  <DueDate>2021-11-03T18:52:08.0791049+00:00</DueDate>
  <PeriodID>7</PeriodID>
  <Measure1>sample string 8</Measure1>
  <Measure1Completed>true</Measure1Completed>
  <Measure1EndDate>2021-11-03T18:52:08.0791049+00:00</Measure1EndDate>
  <Measure1StartDate>2021-11-03T18:52:08.0791049+00:00</Measure1StartDate>
  <Measure2>sample string 9</Measure2>
  <Measure2Completed>true</Measure2Completed>
  <Measure2EndDate>2021-11-03T18:52:08.0791049+00:00</Measure2EndDate>
  <Measure2StartDate>2021-11-03T18:52:08.0947243+00:00</Measure2StartDate>
  <Measure3>sample string 10</Measure3>
  <Measure3Completed>true</Measure3Completed>
  <Measure3EndDate>2021-11-03T18:52:08.0947243+00:00</Measure3EndDate>
  <Measure3StartDate>2021-11-03T18:52:08.0947243+00:00</Measure3StartDate>
  <Measure4>sample string 11</Measure4>
  <Measure4Completed>true</Measure4Completed>
  <Measure4EndDate>2021-11-03T18:52:08.0947243+00:00</Measure4EndDate>
  <Measure4StartDate>2021-11-03T18:52:08.0947243+00:00</Measure4StartDate>
  <Measure5>sample string 12</Measure5>
  <Measure5Completed>true</Measure5Completed>
  <Measure5EndDate>2021-11-03T18:52:08.0947243+00:00</Measure5EndDate>
  <Measure5StartDate>2021-11-03T18:52:08.0947243+00:00</Measure5StartDate>
</Goal>

application/json, text/json

Sample
{
  "SiteID": "daa81cdf-79ca-423c-9216-7cb100919a34",
  "FullName": "sample string 14",
  "MeasuresCompleted": 1,
  "MeasuresTotal": 1,
  "ID": 1,
  "IndividualID": "85b7df53-7792-4264-bcf8-23783b39c10b",
  "Name": "sample string 3",
  "Completed": true,
  "Comment": "sample string 5",
  "Why": "sample string 6",
  "DueDate": "2021-11-03T18:52:08.0791049+00:00",
  "PeriodID": 7,
  "Measure1": "sample string 8",
  "Measure1Completed": true,
  "Measure1EndDate": "2021-11-03T18:52:08.0791049+00:00",
  "Measure1StartDate": "2021-11-03T18:52:08.0791049+00:00",
  "Measure2": "sample string 9",
  "Measure2Completed": true,
  "Measure2EndDate": "2021-11-03T18:52:08.0791049+00:00",
  "Measure2StartDate": "2021-11-03T18:52:08.0947243+00:00",
  "Measure3": "sample string 10",
  "Measure3Completed": true,
  "Measure3EndDate": "2021-11-03T18:52:08.0947243+00:00",
  "Measure3StartDate": "2021-11-03T18:52:08.0947243+00:00",
  "Measure4": "sample string 11",
  "Measure4Completed": true,
  "Measure4EndDate": "2021-11-03T18:52:08.0947243+00:00",
  "Measure4StartDate": "2021-11-03T18:52:08.0947243+00:00",
  "Measure5": "sample string 12",
  "Measure5Completed": true,
  "Measure5EndDate": "2021-11-03T18:52:08.0947243+00:00",
  "Measure5StartDate": "2021-11-03T18:52:08.0947243+00:00"
}