Reference for http://data.unistats.ac.uk/api/v4/KIS/Institution/{PUBUKPRN}/Course/{KISCOURSEID}/{KISMODE}/Statistics

Retrieve KIS Data statistics for a Course

Url: http://data.unistats.ac.uk/api/v4/KIS/Institution/{PUBUKPRN}/Course/{KISCOURSEID}/{KISMODE}/Statistics

HTTP Method: GET

This operation supports JSONP responses. The callback function can be specified using the "callback" Url query parameter.

Message direction Format Body
Request N/A The Request body is empty.
Response Xml Example,Schema
Response Json Example

The following is an example response Xml body:

<ArrayOfStatistic xmlns="http://unistats.direct.gov.uk/api/v4/kis">
  <Statistic>
    <AggregationLevel>CourseLevelSingleYear</AggregationLevel>
    <ApiUrl>http://www.example.com/</ApiUrl>
    <Code>String content</Code>
    <Details>
      <StatisticDetail>
        <Code>String content</Code>
        <IsPercentage>true</IsPercentage>
        <Value>2147483647</Value>
      </StatisticDetail>
      <StatisticDetail>
        <Code>String content</Code>
        <IsPercentage>true</IsPercentage>
        <Value>2147483647</Value>
      </StatisticDetail>
    </Details>
    <JACSSubjectCode>String content</JACSSubjectCode>
    <Population>2147483647</Population>
    <ResponseRate>2147483647</ResponseRate>
  </Statistic>
  <Statistic>
    <AggregationLevel>CourseLevelSingleYear</AggregationLevel>
    <ApiUrl>http://www.example.com/</ApiUrl>
    <Code>String content</Code>
    <Details>
      <StatisticDetail>
        <Code>String content</Code>
        <IsPercentage>true</IsPercentage>
        <Value>2147483647</Value>
      </StatisticDetail>
      <StatisticDetail>
        <Code>String content</Code>
        <IsPercentage>true</IsPercentage>
        <Value>2147483647</Value>
      </StatisticDetail>
    </Details>
    <JACSSubjectCode>String content</JACSSubjectCode>
    <Population>2147483647</Population>
    <ResponseRate>2147483647</ResponseRate>
  </Statistic>
</ArrayOfStatistic>

The following is an example response Json body:

[{
	"AggregationLevel":0,
	"ApiUrl":"http:\/\/www.example.com\/",
	"Code":"String content",
	"Details":[{
		"Code":"String content",
		"IsPercentage":true,
		"Value":2147483647
	}],
	"JACSSubjectCode":"String content",
	"Population":2147483647,
	"ResponseRate":2147483647
}]

The following is the response Xml Schema:

<xs:schema xmlns:tns="http://unistats.direct.gov.uk/api/v4/kis" elementFormDefault="qualified" targetNamespace="http://unistats.direct.gov.uk/api/v4/kis" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:import namespace="http://schemas.datacontract.org/2004/07/Unistats.Application.Domain" />
  <xs:complexType name="ArrayOfStatistic">
    <xs:sequence>
      <xs:element minOccurs="0" maxOccurs="unbounded" name="Statistic" nillable="true" type="tns:Statistic" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="ArrayOfStatistic" nillable="true" type="tns:ArrayOfStatistic" />
  <xs:complexType name="Statistic">
    <xs:sequence>
      <xs:element minOccurs="0" name="AggregationLevel" xmlns:q1="http://schemas.datacontract.org/2004/07/Unistats.Application.Domain" type="q1:StatisticAggregationLevel" />
      <xs:element minOccurs="0" name="ApiUrl" nillable="true" type="xs:anyURI" />
      <xs:element minOccurs="0" name="Code" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="Details" nillable="true" type="tns:ArrayOfStatisticDetail" />
      <xs:element minOccurs="0" name="JACSSubjectCode" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="Population" type="xs:int" />
      <xs:element minOccurs="0" name="ResponseRate" nillable="true" type="xs:int" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="Statistic" nillable="true" type="tns:Statistic" />
  <xs:complexType name="ArrayOfStatisticDetail">
    <xs:sequence>
      <xs:element minOccurs="0" maxOccurs="unbounded" name="StatisticDetail" nillable="true" type="tns:StatisticDetail" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="ArrayOfStatisticDetail" nillable="true" type="tns:ArrayOfStatisticDetail" />
  <xs:complexType name="StatisticDetail">
    <xs:sequence>
      <xs:element minOccurs="0" name="Code" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="IsPercentage" type="xs:boolean" />
      <xs:element minOccurs="0" name="Value" type="xs:int" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="StatisticDetail" nillable="true" type="tns:StatisticDetail" />
</xs:schema>

Additional response Xml Schemas:

<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="anyType" nillable="true" type="xs:anyType" />
  <xs:element name="anyURI" nillable="true" type="xs:anyURI" />
  <xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
  <xs:element name="boolean" nillable="true" type="xs:boolean" />
  <xs:element name="byte" nillable="true" type="xs:byte" />
  <xs:element name="dateTime" nillable="true" type="xs:dateTime" />
  <xs:element name="decimal" nillable="true" type="xs:decimal" />
  <xs:element name="double" nillable="true" type="xs:double" />
  <xs:element name="float" nillable="true" type="xs:float" />
  <xs:element name="int" nillable="true" type="xs:int" />
  <xs:element name="long" nillable="true" type="xs:long" />
  <xs:element name="QName" nillable="true" type="xs:QName" />
  <xs:element name="short" nillable="true" type="xs:short" />
  <xs:element name="string" nillable="true" type="xs:string" />
  <xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
  <xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
  <xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
  <xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
  <xs:element name="char" nillable="true" type="tns:char" />
  <xs:simpleType name="char">
    <xs:restriction base="xs:int" />
  </xs:simpleType>
  <xs:element name="duration" nillable="true" type="tns:duration" />
  <xs:simpleType name="duration">
    <xs:restriction base="xs:duration">
      <xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
      <xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
      <xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
    </xs:restriction>
  </xs:simpleType>
  <xs:element name="guid" nillable="true" type="tns:guid" />
  <xs:simpleType name="guid">
    <xs:restriction base="xs:string">
      <xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
    </xs:restriction>
  </xs:simpleType>
  <xs:attribute name="FactoryType" type="xs:QName" />
  <xs:attribute name="Id" type="xs:ID" />
  <xs:attribute name="Ref" type="xs:IDREF" />
</xs:schema>

<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/Unistats.Application.Domain" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/Unistats.Application.Domain" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:simpleType name="StatisticAggregationLevel">
    <xs:restriction base="xs:string">
      <xs:enumeration value="CourseLevelSingleYear" />
      <xs:enumeration value="CourseLevelTwoYears" />
      <xs:enumeration value="JACSLevel3SingleYear" />
      <xs:enumeration value="JACSLevel3TwoYears" />
      <xs:enumeration value="JACSLevel2SingleYear" />
      <xs:enumeration value="JACSLevel2TwoYears" />
      <xs:enumeration value="JACSLevel1SingleYear" />
      <xs:enumeration value="JACSLevel1TwoYears" />
    </xs:restriction>
  </xs:simpleType>
  <xs:element name="StatisticAggregationLevel" nillable="true" type="tns:StatisticAggregationLevel" />
</xs:schema>

<xs:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="schema">
    <xs:complexType />
  </xs:element>
</xs:schema>