| GET | /partners | Get a list of Partners in Partners Centres | The Partners Centre will may not have a yrspace id. It will differ between environments |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | Full name of the Partners Centre |
| Id | form | int? | No | BNZ Id for the Partners Centre |
| YrspaceId | form | Guid? | No | yrspace Id for the Partners Centre |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BnzId | form | int | No | |
| Name | form | string | No | |
| Street | form | string | No | |
| Suburb | form | string | No | |
| City | form | string | No | |
| Province | form | string | No | |
| Region | form | string | No | |
| Latitude | form | decimal | No | |
| Longitude | form | decimal | No | |
| MapZoom | form | int | No | |
| Link | form | string | No | |
| Features | form | IReadOnlyCollection<string> | No | |
| OperatingHours | form | IReadOnlyCollection<OperatingHour> | No | |
| Partners | form | IReadOnlyCollection<Partner> | No | |
| Floors | form | IReadOnlyCollection<Floor> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DayOfWeek | form | DayOfWeek | No | |
| OpenAt | form | string | No | |
| CloseAt | form | string | No | |
| ClosedAllDay | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BnzId | form | int | No | |
| FirstName | form | string | No | |
| Surname | form | string | No | |
| Group | form | string | No | |
| JobTitle | form | string | No | |
| Phone | form | string | No | |
| Mobile | form | string | No | |
| form | string | No | ||
| Languages | form | IReadOnlyCollection<string> | No | |
| Photo | form | Photo | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Width | form | int | No | |
| Height | form | int | No | |
| Url | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| YrspaceId | form | Guid | No | |
| Name | form | string | No | |
| Order | form | int | No | |
| Image | form | string | No | |
| Rooms | form | IReadOnlyCollection<Room> | No | |
| ShowKey | form | bool | No | |
| PointerDirection | form | string | No | |
| YouAreHere | form | Point | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| YrspaceId | form | Guid | No | |
| Name | form | string | No | |
| Capacity | form | int? | No | |
| IsBookable | form | bool | No | |
| Order | form | int? | No | |
| Flyout | form | Flyout | No | |
| Facilities | form | IReadOnlyCollection<string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Top | form | int | No | |
| Left | form | int | No | |
| Width | form | int | No | |
| Height | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| X | form | int | No | |
| Y | form | int | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /partners HTTP/1.1 Host: partnerscentre-api.yrspace.com Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Name":"String","Street":"String","Suburb":"String","City":"String","Province":"String","Region":"String","Link":"String"}