Connection information for POST

URL = https://<SPECTRUM-SERVER>:8482/serviceContract/Visit

Authentication: Basic Authentication, Enhanced Authentication

Supported methods: POST

Supported formats: JSON

Sample JSON Body

{
	"serviceContractVisits": [
		{
			"Company_Code": "md2",
			"Site_ID": "mld",
			"Contract_Number": "woequip",
			"Visit_Date": "12/17/2021",
			"Work_Summary": "Testing insert 2",
			"Budget_Hours": "2",
			"Budget_Cost": "100.00",
			"Preupdate_Alert": "This is my alert test 12/18",
			"SC_Visit_Notes": "Here are my visit notes",
			"Visit_Tasks": [
				{
					"Equipment": "stuff",
					"Task": "lll1",
					"Task_Unit_Price": "25",
					"Quantity": "1",
					"SC_Equip_Task_Notes": "Here are some task notes"
				},
				{
					"Equipment": "",
					"Task": "",
					"Task_Unit_Price": "",
					"Quantity": "",
					"SC_Equip_Task_Notes": ""
				}
			]
		}
	]
}

Underlying File Maintenance

Prior to importing Service Contract Visits information, the following file maintenance areas must be completed:

• System Administration > Installation > Service Contract

• System Administration > Installation > Service Contract > Service Contract

• System Administration > Installation > Work Order > Site ID

Assumptions and Dependencies

• The web service will add new Visits with equipment tasks if needed to the Service Contract.

• A Valid combination of Site_ID and Contract_Number must exist to add the data.

• To add multiple pieces of Equipment to the Visit then the following fields must match:

  • Company_Code

  • Site_ID

  • Contract_Number

  • Visit_Date

  • Work_Summary

  • Budget_Hours

  • Budget_Cost

• The number of scheduled visits shown on the header record will be managed within the Web service logic so that is is correct with existing dates and newly added.

• The Equipment must be valid as a covered equipment for the service contract and exist on the work order site.

• If multiple visits on the same date exist, then the Equipment will be applied to the first available date.

Field Descriptions

Use the table below for reference when using this service.