Document toolboxDocument toolbox

Appointment Search Object

Owned by Andrew Hill (Deactivated)
Last updated: Oct 18, 2024 by Jason Andrew

The Appointment Search object contains properties related to search criteria. Customer's CRM system will utilize search parameters to find open appointment slots.


On this page:



Appointment Search Object Formats

JSON Format 
{
	"Account": {
		"AccountNum": "",
		"AccountType": "",
		"Name": ""
	},
	"Assets": [{
		"AssetNum": "",
		"Desc": "",
		"FlexForms": [
			"${FlexFormID}"
		],
		"FlexView": [{
			"ID": "",
			"Title": "GroupName1",
			"Items": [{
				"ID": "",
				"Label": "labeltext",
				"Value": "value text",
				"Delete": true
			}],
			"Delete": false
		}],
		"InServiceDate": "",
		"IsComponent": false,
		"LastServiceDate": "",
		"Location": "",
		"Mfg": "",
		"Model": "",
		"ProdNum": "",
		"SerialNum": "",
		"ServiceCodes": [],
		"ServiceCodesDesc": [],
		"Status": "",
		"Type": "",
		"Delete": false
	}],
	"FlexAttrs": {
		"${FlexFormID}": {
			"${FlexAttrID}": ["", ""]
		}
	},
	"FlexForms": [
		"${FlexFormID}",
		"${FlexFormID}"
	],
	"Location": {
		"Address": {
			"AddrLine1": "",
			"AddrLine2": "",
			"AddrLine3": "",
			"AddrLine4": "",
			"AddrType": "",
			"City": "",
			"Country": "",
			"Intersection": "",
			"Lat": "",
			"Lon": "",
			"Region": "",
			"Zip": ""
		},
		"Contacts": [{
			"Email": "",
			"FirstName": "",
			"IsPrimary": true,
			"LastName": "",
			"Phones": [{
				"PhoneNum": "",
				"PhoneType": ""
			}]
		}],
		"Email": "",
		"LanguageID": "",
		"LocationNum": "",
		"Name": "",
		"Notes": "",
		"POReq": false,
		"ServiceAreaID": "",
		"SigReq": true,
		"StorageLocationID": ""
	},
	"OrderType": "",
	"OriginalOrderNum": "",
	"RequiredParts": [{
		"EstimatedDelivery": "2014-12-18T10:00:00.000Z",
		"ProdNum": "",
		"PartStatus": "{free text}",
		"Price": 0.0,
		"ShipToLocation": "",
		"SupersededParts": [{
			"ProdNum": "",
			"PartStatus": "{free text}",
			"ProdAttrs": {
				"Desc": "",
				"IsBatch": false,
				"IsInvCtrl": false,
				"IsSerialized": false,
				"ProdType": "1001"
			},
			"Qty": 10.0
		}],
		"Urgency": ""
	}],
	"TimeConstraints": [{
		"Desc": "",
		"Type": "",
		"Period": {
			"Start": "",
			"End": ""
		}
	}],
	"UserName": ""
}

Appointment Search Object Properties

(info) Required properties are in bold.

PropertyTypeDescription
Accountobject

The Account Location Related Objects Account Object object is used to identify the account the work order is assigned to.

Assetscollection

Contains a collection of Asset Objects associated with the account location (address).

3.34.0

FlexAttrsobject

This property contains the FlexAttr values that were entered.

PropertyTypeDescription
${FlexFormID}object

Identifies the FlexForm

PropertyTypeDescription
${FlexAttrID}array

Contains an collection of values entered for the FlexAttr field identified by ${FlexAttrID}.

3.31.0

FlexFormscollection

An optional collection of FlexForm IDs. Each form specified in the collection will be available for the identified task.

See: FlexForm Object

3.31.0

Locationobject

The account location identifies the actual location (address) of where the service is to be completed. For residential customers this is typically the same as the account information. However, there are cases such as in the auto insurance industry where this could be an auto body shop where a vehicle was towed after an accident. 

See: Account Location Object

OrderTypestring

Contains a Work Order Type System Category value identifying the type of work order.

Valid values are:

  • 1001 – Install (default) 
  • 1002 – Inspection
  • 1003 – Maintenance
  • 1004 – De-Install
  • 1005 – Repair
  • 1006 – Demo
  • 1007 – Training
OriginalOrderNumstring

Identifies order number associated with original work order to schedule a follow-up call.

RequiredPartscollection

This optional collection contains a list of parts that will be required by the mobile worker to complete the work order. The appointment scheduling system should consider availability for required parts in searching open appointment slots.

See: Required Part Object

TimeConstraintscollectionSpecifies zero or more TimeConstraints Objects. Time constraints informs appointment scheduling system when the customer is available or not available.
UserNamestring

This property identifies the ID of the mobile worker that has been assigned to the original work order.

3.19.0