Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

Parts Locator Response Object Formats

JSON Format
{
	"TotalRecords": "",
	"Items": [{
		"Address": {
			"AddrLine1": "",
			"AddrLine2": "",
			"AddrLine3": "",
			"AddrLine4": "",
			"AddrType": "",
			"City": "",
			"Country": "",
			"Intersection": "",
			"Lat": "",
			"Lon": "",
			"Region": "",
			"Zip": ""
		},
		"AvailableQty": 5.0,
		"Distance": 1.5,
		"Contact": {
			"Email": "",
			"FirstName": "",
			"IsPrimary": true,
			"LastName": "",
			"Phones": [{
				"PhoneNum": "",
				"PhoneType": ""
			}]
		},
		"Name": "",
		"LocationType": ""
	}]
}

Parts Locator Response Object Properties

PropertyTypeDescription
TotalRecordsintegerThe total number of records returned within the response body.
Itemsobject

This object provides details associated with the technicians and warehouses retrieved from the parts locator request.

PropertyTypeDescription
AddressobjectThe address of the source. If it is a warehouse, the address will be populated along latitude and longitude. If the address is not known (as in the case for a technician), only the latitude and longitude will be popluated. see (REST Object Definitions Account Location Related Objects Address Object)
AvailableQtydecimalThe total number of available parts specified in the request
DistancedecimalTotal distance (as the crow flies) from the source's last known location. The unit of measure (mi/km) is determined by the input parameter.
Contactobject

Contact Details (see REST Object Definitions Account Location Related Objects Contact Object)

NamestringThe source's name
LocationTypestring

Codes

Activity CodeReservedDescription
1001Yes

Vehicle.

Identifies the storage location as a vehicle.

1002Yes

Warehouse.

Identifies the storage location as a warehouse.

  • No labels