Partners Centre

<back to all web services

CentreConfigurationRequest

Get the UI configuration for a Partners Centre

The following routes are available for this service:
GET/configurationsGet the UI configuration for a Partners CentreThe Partners Centre will may not have a yrspace id. It will differ between environments.
CentreRequest Parameters:
NameParameterData TypeRequiredDescription
NameformstringNoFull name of the Partners Centre
Idformint?NoBNZ Id for the Partners Centre
YrspaceIdformGuid?Noyrspace Id for the Partners Centre
CentreConfigurationResponse Parameters:
NameParameterData TypeRequiredDescription
PagesformIReadOnlyCollection<Page>No
Page Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
TitleformstringNo
BodyformstringNo
ImageformstringNo
IconformstringNo
Orderformint?No
SectionsformIReadOnlyCollection<Section>No
ButtonsformIReadOnlyCollection<Button>No
Section Parameters:
NameParameterData TypeRequiredDescription
TitleformstringNo
BodyformstringNo
ImageformstringNo
OrderformintNo
PageNameformstringNo
Button Parameters:
NameParameterData TypeRequiredDescription
TitleformstringNo
OrderformintNo
ImageformstringNo

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

HTTP + JSON

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

GET /configurations HTTP/1.1 
Host: partnerscentre-api.yrspace.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{}