Platform API

<back to all web services

GetSuiteDataForLicensee

Gets the suite data for a particular licensee

Requires Authentication
The following routes are available for this service:
All Verbs/api/suitedata
GetSuiteDataForLicensee Parameters:
NameParameterData TypeRequiredDescription
SuiteIdqueryGuidNoThe suite id
LicenseeIdqueryGuidNoThe id of the licensee
GetSuiteDataResponse Parameters:
NameParameterData TypeRequiredDescription
SuiteApplianceLicenseeIdformGuidNo
DomainNameformstringNo
SkinNameformstringNo
LicenseeConnectionIdformGuidNo
LicenseeContactIdformGuidNo
LicenseeContactNameformstringNo
IsBrandedURLformboolNo
ResponseStatusformResponseStatusNo

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.

POST /api/suitedata HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	DomainName: String,
	SkinName: String,
	LicenseeContactName: String,
	IsBrandedURL: False,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}