Partners Centre

<back to all web services

PartnersCentreRequest

Get the list of partners centres

The following routes are available for this service:
GET/centresGet a list of Partners CentresThe Partners Centre will may not have a yrspace id. It will differ between environments
PartnersCentreRequest Parameters:
NameParameterData TypeRequiredDescription
RoomsqueryboolNoShould it return the list of rooms? Ignored if specific Partners Centre not specified.
FullqueryboolNoGet the full details for the Partners Centres
CentreRequest Parameters:
NameParameterData TypeRequiredDescription
NameformstringNoFull name of the Partners Centre
Idformint?NoBNZ Id for the Partners Centre
YrspaceIdformGuid?Noyrspace Id for the Partners Centre
PartnersCentreResponse Parameters:
NameParameterData TypeRequiredDescription
BnzIdformintNo
NameformstringNo
StreetformstringNo
SuburbformstringNo
CityformstringNo
ProvinceformstringNo
RegionformstringNo
LatitudeformdecimalNo
LongitudeformdecimalNo
MapZoomformintNo
LinkformstringNo
FeaturesformIReadOnlyCollection<string>No
OperatingHoursformIReadOnlyCollection<OperatingHour>No
PartnersformIReadOnlyCollection<Partner>No
FloorsformIReadOnlyCollection<Floor>No
OperatingHour Parameters:
NameParameterData TypeRequiredDescription
DayOfWeekformDayOfWeekNo
OpenAtformstringNo
CloseAtformstringNo
ClosedAllDayformboolNo
Partner Parameters:
NameParameterData TypeRequiredDescription
BnzIdformintNo
FirstNameformstringNo
SurnameformstringNo
GroupformstringNo
JobTitleformstringNo
PhoneformstringNo
MobileformstringNo
EmailformstringNo
LanguagesformIReadOnlyCollection<string>No
PhotoformPhotoNo
Photo Parameters:
NameParameterData TypeRequiredDescription
WidthformintNo
HeightformintNo
UrlformstringNo
Floor Parameters:
NameParameterData TypeRequiredDescription
YrspaceIdformGuidNo
NameformstringNo
OrderformintNo
ImageformstringNo
RoomsformIReadOnlyCollection<Room>No
ShowKeyformboolNo
PointerDirectionformstringNo
YouAreHereformPointNo
Room Parameters:
NameParameterData TypeRequiredDescription
YrspaceIdformGuidNo
NameformstringNo
Capacityformint?No
IsBookableformboolNo
Orderformint?No
FlyoutformFlyoutNo
FacilitiesformIReadOnlyCollection<string>No
Flyout Parameters:
NameParameterData TypeRequiredDescription
TopformintNo
LeftformintNo
WidthformintNo
HeightformintNo
Point Parameters:
NameParameterData TypeRequiredDescription
XformintNo
YformintNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /centres HTTP/1.1 
Host: partnerscentre-api.yrspace.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Name: String,
	Street: String,
	Suburb: String,
	City: String,
	Province: String,
	Region: String,
	Link: String
}