Connection Information

URL: https://<SPECTRUM-SERVER>:8482/employee/images

Authentication: Basic Authentication, Enhanced Authentication

Supported methods: POST

Supported formats: JSON

Sample JSON Body

{"employeeImages":[
	{
		"companyCode": "SP1",
		"employeeCode": "536",
		"drawer": "Resume",
		"imageType": "PDF",
		"imageDescription": "John Smith Resume",
		"documentID": "",
		"imageFile": "JVBERi0...NDY2NjQKJSVFT0YK"
	},
	{
		"companyCode": "SP1",
		"employeeCode": "536",
		"drawer": "I9",
		"imageType": "PDF",
		"imageDescription": "I-9 Documentation",
		"documentID": "",
		"imageFile": "JVBERi0xLjMNJf////8NMSAw...w0lJUVPRg0="
	}
]}

Assumptions and Dependencies

• The companyCode and employeeCode will be a valid record in employee master table.

• The drawer passed in must be non-blank and a valid drawer for the EMPLOYEE cabinet in that company.

• The documentID can be blank, which will indicate that a new document is being added. If not blank, it must be a valid documentID, and have a transactionID matching the companyCode, employeeCode, and drawer values.

  • The Web Service will determine the applicable Path for the Image File by reading for the company-wide default "Path" variable specified in Document Imaging Installation

    • Document Imaging offers an option to store images by Year and Period. The Web Service will automatically store imported work order images as if the DIPathByYearAndPeriod value variable is <blank>.

  • The Web Service will generate a new Transaction_ID as a GUID.

    • If documentID is passed in, then the existing Transaction_ID will be used.

  • The Web Service will insert a record for the incoming employee DI transaction into DI_MASTER_MC, as follows, if no documentID is passed in:

    • Company_Code = passed in

    • Cabinet = "EMPLOYEE"

    • Drawer = passed in

    • Folder = employeeCode (with any leading blanks removed)

    • Reference = new unique GUID

    • Transaction_Description = imageDescription passed in (if blank, use the drawer name and current date as 'mm/dd/yyyy')

    • Keywords = tbd

    • Transaction_ID = new unique GUID

  • The Web Service will insert a record for the incoming employee image into DI_IMAGE_MASTER, as follows:

    • Document_ID = Use text string from Import File, if specified

      • However, if no Document ID is imported, the Web Service will generate unique Document ID.

      • In the case where the Web Service generates the Document ID, the value will be returned to a 3rd party calling the web service.

    • Image_Path = Path determined above

    • Image_Filename = Unique file name devised by Web Service

    • Create_Operator = Set to 3-character Spectrum Operator Code associated with the Authorization ID in Data Exchange Installation

    • Create_Date = Set to current system date

    • Create_Time = Set to current system time

    • Change_Operator = <leave blank>

    • Change_Date = <leave blank>

    • Change_Time = <leave blank>

    • Image_Description = Use text string from Import File. If blank, use transaction Description from above.

• Image Cross-Reference Table:

  • The Web Service will insert a record into the DI_IMAGE_XREF Table:

    • Transaction_ID = same as field in DI_MASTER_MC

    • Document_ID = Same value as above for DI_IMAGE_MASTER

Field Descriptions