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

Retrieve KIS Data about a Course in the specified format; XML, JSON

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

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:

<Course xmlns="http://unistats.direct.gov.uk/api/v4/kis">
  <ApiUrl>http://www.example.com/</ApiUrl>
  <ApplicationUKPRN>String content</ApplicationUKPRN>
  <AssessmentMethodsUrl>http://www.example.com/</AssessmentMethodsUrl>
  <AssessmentMethodsUrlWales>http://www.example.com/</AssessmentMethodsUrlWales>
  <CoursePageUrl>http://www.example.com/</CoursePageUrl>
  <CoursePageUrlWales>http://www.example.com/</CoursePageUrlWales>
  <DistanceLearning>String content</DistanceLearning>
  <EmploymentDetailsUrl>http://www.example.com/</EmploymentDetailsUrl>
  <EmploymentDetailsUrlWales>http://www.example.com/</EmploymentDetailsUrlWales>
  <FoundationYearAvailable>NotAvailable</FoundationYearAvailable>
  <Honours>true</Honours>
  <IsPartTime>true</IsPartTime>
  <JACSCodes>
    <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">String content</string>
    <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">String content</string>
  </JACSCodes>
  <KisAimCode>String content</KisAimCode>
  <KisAimLabel>String content</KisAimLabel>
  <KisCourseId>String content</KisCourseId>
  <KisMode>String content</KisMode>
  <LDCSCodes>
    <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">String content</string>
    <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">String content</string>
  </LDCSCodes>
  <LearningAndTeachingMethodsUrl>http://www.example.com/</LearningAndTeachingMethodsUrl>
  <LearningAndTeachingMethodsUrlWales>http://www.example.com/</LearningAndTeachingMethodsUrlWales>
  <LengthInYears>2147483647</LengthInYears>
  <LocationChangesDuringCourse>true</LocationChangesDuringCourse>
  <SandwichAvailable>NotAvailable</SandwichAvailable>
  <SupportDetailsUrl>http://www.example.com/</SupportDetailsUrl>
  <SupportDetailsUrlWales>http://www.example.com/</SupportDetailsUrlWales>
  <Title>String content</Title>
  <TitleInWelsh>String content</TitleInWelsh>
  <TotalNumberOfStages>2147483647</TotalNumberOfStages>
  <YearAbroadAvailable>NotAvailable</YearAbroadAvailable>
</Course>

The following is an example response Json body:

{
	"ApiUrl":"http:\/\/www.example.com\/",
	"ApplicationUKPRN":"String content",
	"AssessmentMethodsUrl":"http:\/\/www.example.com\/",
	"AssessmentMethodsUrlWales":"http:\/\/www.example.com\/",
	"CoursePageUrl":"http:\/\/www.example.com\/",
	"CoursePageUrlWales":"http:\/\/www.example.com\/",
	"DistanceLearning":"String content",
	"EmploymentDetailsUrl":"http:\/\/www.example.com\/",
	"EmploymentDetailsUrlWales":"http:\/\/www.example.com\/",
	"FoundationYearAvailable":0,
	"Honours":true,
	"IsPartTime":true,
	"JACSCodes":["String content"],
	"KisAimCode":"String content",
	"KisAimLabel":"String content",
	"KisCourseId":"String content",
	"KisMode":"String content",
	"LDCSCodes":["String content"],
	"LearningAndTeachingMethodsUrl":"http:\/\/www.example.com\/",
	"LearningAndTeachingMethodsUrlWales":"http:\/\/www.example.com\/",
	"LengthInYears":2147483647,
	"LocationChangesDuringCourse":true,
	"SandwichAvailable":0,
	"SupportDetailsUrl":"http:\/\/www.example.com\/",
	"SupportDetailsUrlWales":"http:\/\/www.example.com\/",
	"Title":"String content",
	"TitleInWelsh":"String content",
	"TotalNumberOfStages":2147483647,
	"YearAbroadAvailable":0
}

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:import namespace="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
  <xs:complexType name="Course">
    <xs:sequence>
      <xs:element minOccurs="0" name="ApiUrl" nillable="true" type="xs:anyURI" />
      <xs:element minOccurs="0" name="ApplicationUKPRN" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="AssessmentMethodsUrl" nillable="true" type="xs:anyURI" />
      <xs:element minOccurs="0" name="AssessmentMethodsUrlWales" nillable="true" type="xs:anyURI" />
      <xs:element minOccurs="0" name="CoursePageUrl" nillable="true" type="xs:anyURI" />
      <xs:element minOccurs="0" name="CoursePageUrlWales" nillable="true" type="xs:anyURI" />
      <xs:element minOccurs="0" name="DistanceLearning" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="EmploymentDetailsUrl" nillable="true" type="xs:anyURI" />
      <xs:element minOccurs="0" name="EmploymentDetailsUrlWales" nillable="true" type="xs:anyURI" />
      <xs:element minOccurs="0" name="FoundationYearAvailable" nillable="true" xmlns:q1="http://schemas.datacontract.org/2004/07/Unistats.Application.Domain" type="q1:AvailabilityType" />
      <xs:element minOccurs="0" name="Honours" nillable="true" type="xs:boolean" />
      <xs:element minOccurs="0" name="IsPartTime" type="xs:boolean" />
      <xs:element minOccurs="0" name="JACSCodes" nillable="true" xmlns:q2="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q2:ArrayOfstring" />
      <xs:element minOccurs="0" name="KisAimCode" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="KisAimLabel" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="KisCourseId" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="KisMode" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="LDCSCodes" nillable="true" xmlns:q3="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q3:ArrayOfstring" />
      <xs:element minOccurs="0" name="LearningAndTeachingMethodsUrl" nillable="true" type="xs:anyURI" />
      <xs:element minOccurs="0" name="LearningAndTeachingMethodsUrlWales" nillable="true" type="xs:anyURI" />
      <xs:element minOccurs="0" name="LengthInYears" nillable="true" type="xs:int" />
      <xs:element minOccurs="0" name="LocationChangesDuringCourse" nillable="true" type="xs:boolean" />
      <xs:element minOccurs="0" name="SandwichAvailable" nillable="true" xmlns:q4="http://schemas.datacontract.org/2004/07/Unistats.Application.Domain" type="q4:AvailabilityType" />
      <xs:element minOccurs="0" name="SupportDetailsUrl" nillable="true" type="xs:anyURI" />
      <xs:element minOccurs="0" name="SupportDetailsUrlWales" nillable="true" type="xs:anyURI" />
      <xs:element minOccurs="0" name="Title" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="TitleInWelsh" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="TotalNumberOfStages" nillable="true" type="xs:int" />
      <xs:element minOccurs="0" name="YearAbroadAvailable" nillable="true" xmlns:q5="http://schemas.datacontract.org/2004/07/Unistats.Application.Domain" type="q5:AvailabilityType" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="Course" nillable="true" type="tns:Course" />
</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="AvailabilityType">
    <xs:restriction base="xs:string">
      <xs:enumeration value="NotAvailable" />
      <xs:enumeration value="Optional" />
      <xs:enumeration value="Compulsory" />
    </xs:restriction>
  </xs:simpleType>
  <xs:element name="AvailabilityType" nillable="true" type="tns:AvailabilityType" />
</xs:schema>

<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/Arrays" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexType name="ArrayOfstring">
    <xs:sequence>
      <xs:element minOccurs="0" maxOccurs="unbounded" name="string" nillable="true" type="xs:string" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="ArrayOfstring" nillable="true" type="tns:ArrayOfstring" />
</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>