PrismaLife services - Metadata

<back to all web services

ConfigFile

Übertragung von Konfigurationsdateien

The following routes are available for this service:
POST/api/ConfigFileConfigFile-ServiceÜbertragung von Konfigurationsdateien
Parameters:
NameParameterData TypeRequiredDescription
LoginbodyCredentialYesLogin (Benutzername und Passwort)
FileNamebodystringYesFileName
FileContentbodystringYesFileContent in Base64
BIBOnlypathBooleanYesCreate BIB Document only
OmitDocumentpathBooleanNoOmit document, true = gets result without PDF attached.
DocFieldListbodyListNoList of DocFieldValue (key, value). FileName and Filecontent is not needed if this is filled. This must be NULL if FileContent should be used. List
IsTestClientpathBooleanNoPrismaLife Internal only. Flag for TestClient
CreateValidDocumentInTestClientpathBooleanNoPrismaLife Internal only. Flag to create valid Documents in TestClient

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/ConfigFile HTTP/1.1 
Host: services.prismalife.com 
Content-Type: text/jsv
Content-Length: length

{
	login: 
	{
		username: String,
		password: String
	},
	fileName: String,
	fileContent: String,
	options: 
	{
		rules: 
		[
			{
				key: String,
				value: String
			}
		]
	},
	bibOnly: False,
	omitDocument: False,
	docFieldList: 
	[
		{
			key: String,
			value: String
		}
	],
	isTestClient: False,
	createValidDocumentInTestClient: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	report: 
	{
		pdf: AA==,
		fileKey: String,
		allPages: 0
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String
			}
		]
	},
	warnings: 
	[
		String
	],
	id: String,
	premTotal: 0,
	performance: 0,
	payOutEnd: 0,
	productName: String
}