s1 API Host

<back to all web services

GetCatalogueRequest

The following routes are available for this service:
GET, OPTIONS/api/catalogues/{LanguageCode}/{ProviderKey}Get the providers catalogue for a language.Only possible if the user is authenticated
Parameters:
NameParameterData TypeRequiredDescription
LanguageCodepathstringYesThe ISO language code for the universal catalogue
ProviderKeypathstringYesCatalogue by prodiver

To override the Content-type in your clients 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 /jsv/reply/GetCatalogueRequest HTTP/1.1 
Host: s1-api.fource.nl 
Content-Type: text/jsv
Content-Length: length

{
	languageCode: String,
	providerKey: String
}

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

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String
			}
		]
	},
	catalogue: 
	{
		languageCode: String,
		key: String,
		lastUpdated: 0001-01-01
	}
}