GET CAWS/RegisterSummaries/{id}

Request returns an individual register header basing on passed in register id.

Request Information

Parameters

Name	Description	Additional information
id	String value of the register id. Last two digits represent week number, preceeding ones represent event_id.	Define this parameter in the request URI.

Response Information

RegisterSummaryPoco object representing the header of a register (register summary).

Response body formats

application/json, text/json

Sample:

{
  "Entities": {
    "Course": {
      "1": {
        "Name": "sample string 1",
        "UniqueName": "sample string 2"
      },
      "2": {
        "Name": "sample string 1",
        "UniqueName": "sample string 2"
      },
      "3": {
        "Name": "sample string 1",
        "UniqueName": "sample string 2"
      }
    }
  },
  "Status": [
    true,
    true,
    true
  ],
  "Id": "sample string 1",
  "EventId": 2,
  "Week": 3,
  "ActivityId": 4,
  "StartDateTime": "2026-01-09T12:40:38.8578597+00:00",
  "EndDateTime": "2026-01-09T12:40:38.8578597+00:00",
  "StudentCount": 7,
  "MarkCount": 8
}

application/xml, text/xml

Sample:

<RegisterSummaryPoco xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Celcat.Models">
  <ActivityId>4</ActivityId>
  <EndDateTime>2026-01-09T12:40:38.8578597+00:00</EndDateTime>
  <Entities xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfTctEntity.TypeIdArrayOfKeyValueOfintRegisterSummaryEntNamesN7tAZKdNDVznJGxv>
      <d2p1:Key>Course</d2p1:Key>
      <d2p1:Value>
        <d2p1:KeyValueOfintRegisterSummaryEntNamesN7tAZKdN>
          <d2p1:Key>1</d2p1:Key>
          <d2p1:Value>
            <Name>sample string 1</Name>
            <UniqueName>sample string 2</UniqueName>
          </d2p1:Value>
        </d2p1:KeyValueOfintRegisterSummaryEntNamesN7tAZKdN>
        <d2p1:KeyValueOfintRegisterSummaryEntNamesN7tAZKdN>
          <d2p1:Key>2</d2p1:Key>
          <d2p1:Value>
            <Name>sample string 1</Name>
            <UniqueName>sample string 2</UniqueName>
          </d2p1:Value>
        </d2p1:KeyValueOfintRegisterSummaryEntNamesN7tAZKdN>
        <d2p1:KeyValueOfintRegisterSummaryEntNamesN7tAZKdN>
          <d2p1:Key>3</d2p1:Key>
          <d2p1:Value>
            <Name>sample string 1</Name>
            <UniqueName>sample string 2</UniqueName>
          </d2p1:Value>
        </d2p1:KeyValueOfintRegisterSummaryEntNamesN7tAZKdN>
      </d2p1:Value>
    </d2p1:KeyValueOfTctEntity.TypeIdArrayOfKeyValueOfintRegisterSummaryEntNamesN7tAZKdNDVznJGxv>
  </Entities>
  <EventId>2</EventId>
  <Id>sample string 1</Id>
  <MarkCount>8</MarkCount>
  <StartDateTime>2026-01-09T12:40:38.8578597+00:00</StartDateTime>
  <Status xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:boolean>true</d2p1:boolean>
    <d2p1:boolean>true</d2p1:boolean>
    <d2p1:boolean>true</d2p1:boolean>
  </Status>
  <StudentCount>7</StudentCount>
  <Week>3</Week>
</RegisterSummaryPoco>