Partners Centre

CentreConfigurationRequest

Get the UI configuration for a Partners Centre

The following routes are available for this service:
GET	/configurations	Get the UI configuration for a Partners Centre	The Partners Centre will may not have a yrspace id. It will differ between environments.

**CentreRequest** Parameters:
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

**CentreConfigurationResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Pages	form	IReadOnlyCollection<Page>	No

**Page** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
Title	form	string	No
Body	form	string	No
Image	form	string	No
Icon	form	string	No
Order	form	int?	No
Sections	form	IReadOnlyCollection<Section>	No
Buttons	form	IReadOnlyCollection<Button>	No

**Section** Parameters:
Name	Parameter	Data Type	Required
Title	form	string	No
Body	form	string	No
Image	form	string	No
Order	form	int	No
PageName	form	string	No

**Button** Parameters:
Name	Parameter	Data Type	Required
Title	form	string	No
Order	form	int	No
Image	form	string	No

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

HTTP + XML

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/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CentreConfigurationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PartnersCentre.Service.Models.Api.Response">
  <Pages i:nil="true" />
</CentreConfigurationResponse>