GET api/v{version}/customer

Request Information

URI Parameters

NameDescriptionTypeAdditional information
version

The requested API version

 string

Required

Default value is 1

Body Parameters

None.

Response Information

Resource Description

BasicCustomer
NameDescriptionTypeAdditional information
HasAnActiveBooking

boolean

None.
BuildingName

string

None.
University

string

None.
Course

string

None.
TenancyType

TenancyType

None.
CurrentLocation

Collection of Location

None.
MaintenanceServiceTypes

Collection of MaintenanceService

None.
NotificationCount

integer

None.
Id

integer

None.
GivenName

string

None.
FamilyName

string

None.
CustomerId

string

None.
Email

string

None.
HomeCountry

string

None.
AcademicYear

string

None.
MobileNumber

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "MobileNumber": null,
  "HasAnActiveBooking": true,
  "BuildingName": "Bristol UNITE House",
  "University": "Uni of Life",
  "Course": "Life studies",
  "TenancyType": "1",
  "CurrentLocation": [
    {
      "Id": 3827398,
      "Name": "Room A Flat 202",
      "LocationType": "Room"
    },
    {
      "Id": 2131232,
      "Name": "Flat 202",
      "LocationType": "Flat"
    },
    {
      "Id": 123123,
      "Name": "Second Floor",
      "LocationType": "Floor"
    },
    {
      "Id": 123,
      "Name": "Ice Palace",
      "LocationType": "Property"
    },
    {
      "Id": 123,
      "Name": "North Pole",
      "LocationType": "City"
    }
  ],
  "MaintenanceServiceTypes": [
    {
      "ServiceId": 2,
      "Service": "Electrical"
    },
    {
      "ServiceId": 5,
      "Service": "Glazing"
    }
  ],
  "NotificationCount": 0,
  "Id": 0,
  "GivenName": "Bob",
  "FamilyName": "Smith",
  "CustomerId": "0897989879",
  "Email": "na@na.com",
  "HomeCountry": "North Pole",
  "AcademicYear": null
}

text/javascript

Sample: 
{"MobileNumber":null,"HasAnActiveBooking":true,"BuildingName":"Bristol UNITE House","University":"Uni of Life","Course":"Life studies","TenancyType":"1","CurrentLocation":[{"Id":3827398,"Name":"Room A Flat 202","LocationType":"Room"},{"Id":2131232,"Name":"Flat 202","LocationType":"Flat"},{"Id":123123,"Name":"Second Floor","LocationType":"Floor"},{"Id":123,"Name":"Ice Palace","LocationType":"Property"},{"Id":123,"Name":"North Pole","LocationType":"City"}],"MaintenanceServiceTypes":[{"ServiceId":2,"Service":"Electrical"},{"ServiceId":5,"Service":"Glazing"}],"NotificationCount":0,"Id":0,"GivenName":"Bob","FamilyName":"Smith","CustomerId":"0897989879","Email":"na@na.com","HomeCountry":"North Pole","AcademicYear":null}

application/xml, text/xml

Sample: 
<BasicCustomer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UNITE.External.API.Models">
  <AcademicYear i:nil="true" />
  <CustomerId>0897989879</CustomerId>
  <Email>na@na.com</Email>
  <FamilyName>Smith</FamilyName>
  <GivenName>Bob</GivenName>
  <HomeCountry>North Pole</HomeCountry>
  <Id>0</Id>
  <BuildingName>Bristol UNITE House</BuildingName>
  <Course>Life studies</Course>
  <CurrentLocation>
    <Location>
      <Id>3827398</Id>
      <LocationType>Room</LocationType>
      <Name>Room A Flat 202</Name>
    </Location>
    <Location>
      <Id>2131232</Id>
      <LocationType>Flat</LocationType>
      <Name>Flat 202</Name>
    </Location>
    <Location>
      <Id>123123</Id>
      <LocationType>Floor</LocationType>
      <Name>Second Floor</Name>
    </Location>
    <Location>
      <Id>123</Id>
      <LocationType>Property</LocationType>
      <Name>Ice Palace</Name>
    </Location>
    <Location>
      <Id>123</Id>
      <LocationType>City</LocationType>
      <Name>North Pole</Name>
    </Location>
  </CurrentLocation>
  <HasAnActiveBooking>true</HasAnActiveBooking>
  <MaintenanceServiceTypes>
    <MaintenanceService>
      <Service>Electrical</Service>
      <ServiceId>2</ServiceId>
    </MaintenanceService>
    <MaintenanceService>
      <Service>Glazing</Service>
      <ServiceId>5</ServiceId>
    </MaintenanceService>
  </MaintenanceServiceTypes>
  <MobileNumber i:nil="true" />
  <NotificationCount>0</NotificationCount>
  <TenancyType>AcademicYear</TenancyType>
  <University>Uni of Life</University>
</BasicCustomer>