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

Retrieve KIS Data about Locations for a Course

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

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:

<ArrayOfLocation xmlns="http://unistats.direct.gov.uk/api/v4/kis">
  <Location>
    <ApiUrl>http://www.example.com/</ApiUrl>
    <Latitude>1.26743233E+15</Latitude>
    <LocationId>String content</LocationId>
    <LocationUKPRN>String content</LocationUKPRN>
    <Longitude>1.26743233E+15</Longitude>
    <Name>String content</Name>
    <NameInWelsh>String content</NameInWelsh>
    <StudentUnionUrl>http://www.example.com/</StudentUnionUrl>
    <StudentUnionUrlWales>http://www.example.com/</StudentUnionUrlWales>
    <UCASCourseIds>
      <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>
    </UCASCourseIds>
    <UKPRN>String content</UKPRN>
  </Location>
  <Location>
    <ApiUrl>http://www.example.com/</ApiUrl>
    <Latitude>1.26743233E+15</Latitude>
    <LocationId>String content</LocationId>
    <LocationUKPRN>String content</LocationUKPRN>
    <Longitude>1.26743233E+15</Longitude>
    <Name>String content</Name>
    <NameInWelsh>String content</NameInWelsh>
    <StudentUnionUrl>http://www.example.com/</StudentUnionUrl>
    <StudentUnionUrlWales>http://www.example.com/</StudentUnionUrlWales>
    <UCASCourseIds>
      <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>
    </UCASCourseIds>
    <UKPRN>String content</UKPRN>
  </Location>
</ArrayOfLocation>

The following is an example response Json body:

[{
	"ApiUrl":"http:\/\/www.example.com\/",
	"Latitude":1.26743233E+15,
	"LocationId":"String content",
	"LocationUKPRN":"String content",
	"Longitude":1.26743233E+15,
	"Name":"String content",
	"NameInWelsh":"String content",
	"StudentUnionUrl":"http:\/\/www.example.com\/",
	"StudentUnionUrlWales":"http:\/\/www.example.com\/",
	"UCASCourseIds":["String content"],
	"UKPRN":"String content"
}]

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.microsoft.com/2003/10/Serialization/Arrays" />
  <xs:complexType name="ArrayOfLocation">
    <xs:sequence>
      <xs:element minOccurs="0" maxOccurs="unbounded" name="Location" nillable="true" type="tns:Location" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="ArrayOfLocation" nillable="true" type="tns:ArrayOfLocation" />
  <xs:complexType name="Location">
    <xs:sequence>
      <xs:element minOccurs="0" name="ApiUrl" nillable="true" type="xs:anyURI" />
      <xs:element minOccurs="0" name="Latitude" type="xs:double" />
      <xs:element minOccurs="0" name="LocationId" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="LocationUKPRN" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="Longitude" type="xs:double" />
      <xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="NameInWelsh" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="StudentUnionUrl" nillable="true" type="xs:anyURI" />
      <xs:element minOccurs="0" name="StudentUnionUrlWales" nillable="true" type="xs:anyURI" />
      <xs:element minOccurs="0" name="UCASCourseIds" nillable="true" xmlns:q1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q1:ArrayOfstring" />
      <xs:element minOccurs="0" name="UKPRN" nillable="true" type="xs:string" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="Location" nillable="true" type="tns:Location" />
</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.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>