Create Print Rule

openspecimen/rest/ng/specimen/print-rules

Use this resource to create new print rule in the openSpecimen application. Use HTTP POST method to call this API by passing the below details in JSON format.

Below are the attributes which need to be sent in the request body:

Parameter	Definition
name	Name of the Print Rule. Should be unique in system
specimenClass[Optional]	Class of the specimen. By default it will be 'any' Permissible Values: molecular, fluid, cell, tissue, any
specimenType[Optional]	Type of the specimen . By default it will be 'any' Permissible Values: 'any' or any specimen type of the class specified in same row
labelType	This could be cap+slide or side. This parameter and the specimen type define the information that needs to go in the label. This will help user to configure based on label physical dimensions.
dataOnLabel	Information that needs to be included in the label based on the specimen class/type and label type
printerName	Name of the printer where the request has to be forwarded to.
workstationIP[Optional]	IP address of the machine from where the print request will come and this decides to which printer the request has to be forwarded to. By default it will be 'any'. It can be specified in wild card format like grouping e.g all IPs starting with 128 will have same rule all IPs starting with 128.3. will have same rule
loginName	Login name of User.
domainName	Domain name of User.
cpShortTitle	Collection protocol short title

http[s]:<host>:<port>/openspecimen/rest/ng/specimen/print-rules

Use this URL to add print rule in openSpecimen application.

Result:

The response of this request will contains the details of the created print rule.

Below is the example of the create print rule:

URL	`http://<host>:<port>/`openspecimen/rest/ng/specimen/print-rules
Method	POST
Request	application/json
json	{ "name":"My PrintRule", "specimenClass" : "fluid", "specimenType" : "any", "labelType" : "Cap+Slide", "dataOnLabel" : ["specimen label","specimen type"], "printerName" : "TB2", "workstationIP" : "127.0.0.1", "loginName" : {"loginName" : "admin@admin.com", "domainName" :"catissue"}, "cpShortTitle" : "SCS_CP" }
Response	{ id: 3 name: "My PrintRule" specimenClass: "fluid" specimenType: "any" labelType: "Cap+Slide" workstationIP: "127.0.0.1" dataOnLabel: [ 2] 0: "Specimen type" 1: "Specimen Label" - printerName: "TB2" cpShortTitle: "SCS_CP" loginName: { loginName: "admin@admin.com" domainName: "catissue" } - }

Error Cases :

code	Applies to	Status Message
200	All resources	Print rule has been created successfully
400	All requests	Invalid parameters, e.g duplicate print rule name, blank print rule name etc
401	All requests	Authorization failed, user doesn’t have authority
500	All requests	Internal server error, encountered server error while performing operations