SmartPost API

The values that are required for a Send SmartPost console application can be divided into two types. That is, environment-depending values and argument values.

Environment-depending values for Send SmartPost

Environment-depending values are properties such as domain name and the name of the server that hosts WorkZone Process. The values are defined by the environment where you use the SmartPost process.

Name	Description	Example
ProcessTemplate	`ProcessTemplate` is a constant for the current version of WorkZone Process and this value should not be changed. `ProcessTemplate` helps create the URL to the process service.	http://{0}/Process/Process.svc/
SendSmartPostGuid	`SendSmartPostGuid` is a GUID which uniquely identifies the Send SmartPost process definition. This value is a constant and it should not be changed in this context.	0577b569-f10b-47ea-8718-c8912ce70a0a
Dsn	`Dsn` is the data service name under which WorkZone Process is hosted.	host
Username	The name of the user who connects to the WorkZone Process service.
Password	The password of the user who connects to the WorkZone Process service.
Domain	The domain in which the user is registered.

Argument values for Send SmartPost

Argument values are value properties that define the arguments for the process to be started. The arguments are closely related to the definition of the Send SmartPost process, the configuration of SmartPost, and the state of WorkZone Content Server.

Name	Type	Description	Example
AdditionalCases	Array of string	Customer-specific variable which is not used in the standard solution. Initiate the property as an empty array of strings.	new string[]{}
AttachmentRecordIds	Array of string	Use AttachmentRecordIds to provide the document attachments to letters created by SmartPost. Each attachment is identified by a unique key (RECORD_KEY) of the record identifier for the documents that will be used as attachments. For details, refer to the RECORD table. If the value is set to “179”, “139”, the documents with the record keys 179 and 139 will be used as attachments.	new[] {“179”, “139”}
CaseState	String	Customer-specific variable which is not used in the standard solution. Initiate the property as null.	null
CloseCase	Boolean	Customer-specific variable which is not used in the standard solution. Initiate the property as false.	false
ContextId	String	This is the unique key to the case file (FILE_KEY) from which the Send SmartPost process is started. Note, that the value is not the same as the file number. Use the column FILE_NO in the table FILE to map it to the FILE_KEY value.	“81”
CopyPartIds	Array of strings	This is a list of keys to identify copy recipients of the Send SmartPost process. Each key in the list represents an address of a contact which is used as a copy recipient. To find the correct keys, please refer to the NAME_ADDRESS table.	new[] {“179”, “139”}
Deadline	DateTime	If a shipment is sent for preview or approval, a deadline can be set. If the deadline for the preview or approval is exceeded, a reminder is sent to the previewer or approver. This argument defines the deadline.	new DateTime(2016, 7, 14)
DecisionCode	String	Customer-specific variable which is not used in the standard solution. Initiate the property as an empty string.	“”
DecisionCodeDissension	String	Customer-specific variable which is not used in the standard solution. Initiate the property as an empty string.	“”
DecisionDate	DateTime	Customer-specific variable which is not used in the standard solution. Initiate the property with the current date and time.	DateTime.Now()
IsApproval	Boolean	This argument indicates that the shipment will be forwarded to the case handler for approval. IsApproval and IsPreview are mutually exclusive so only one of them or none of them can be true.	false
IsDeleteOriginal	Boolean	This argument indicates whether the original template (see LetterRecordId) is deleted by the Send SmartPost process after a successful shipment.	true
IsEnableReply	Boolean	This argument indicates, whether the Digital Post recipients should be able to reply directly to the SmartPost message.	true
IsPreview	Boolean	This argument indicates that the shipment is sent to the process initiator for preview before the shipment continues. IsPreview and IsApproval are mutually exclusive so only one of them or none of them can be true.	true
LetterRecordId	String	Use LetterRecordId to specify the main document template for letters created by SmartPost. The main document template is identified by a unique key (RECORD_KEY) of the record identifier for the document to be used. For details, please refer to the RECORD table. If the value is set to 10, the document with the record key 10 will be used as the main document template.	“10”
LetterTypeId	String	Customer-specific variable which is not used in the standard solution. Initiate the property by the string.	“0”
LogicalSubscriptionGroupId	String	Identifies the logical subscription group which will be used by SmartPost to determine the material ID Digital Postcommunication. The argument is a LOGICAL_SUBSCR_GRP_KEY value found in the LOGICAL_SUBCR_GRP table.	“1001”
PartsIds	String	This is a list of keys to identify the main recipient of the Send SmartPost process. Usually one main recipient is provided; however, multiple main recipients are supported. Each key in the list represents an address of a contact which is used as main recipient. To find the correct keys, please refer to NAME_ADDRESS table.	new[]{“178”}
RemotePrintTypeId	String	The type of remote print configuration that will be used for letters sent to Strålfors [*KAN MAN BARE SIGE "that will be usedfor handling letters" eller noget i den retning ? *]. The argument is one of the REMOTE_PRINT_TYPE_KEY values from the REMOTE_PRINT_TYPE table.	“0”
ShipmentTypeID	String	The type of shipment that will be used by Send SmartPost to select the channel for delivery of letters. The argument is a value of the type SHIPMENT_TYPE_KEY in the SHIPMENT_TYPE table.	“1”
Subject	String	This is the title of the dispatch. The text that you specify will be the title of the letters that are received in Digital Post.	“My letter to you”