Overview

This article contains documentation for the Location web service and all related API calls.

For more information about all available Web Services and corresponding methods, refer to the Introduction to Web Services article.

Information

This web service includes the following methods:

This service method allows you to create Locations.

Ordinal	DataType	Can be Null?	Description
Name	String	No	The Name of the Location
landmarkType	String	No	The type of the Location
Location	svLocation	No	The address of the Location
Referencenumber	String	No	The unique number used to update locations
Divisions	svDivisions	Yes	Array of divisions (groups) for which this Location will be available. If it is empty, the location will be available to all divisions.
Return Result	SvResult	No	SvResult object that indicates the success or failure of the method call.

This service method allows you to create or update Locations.

Ordinal	DataType	Can be Null?	Description
Name	String	No	The Name of the Location
landmarkType	String	No	The type of the Location
Location	svLocation	No	The address of the location
Divisions	svDivisions	Yes	Array of divisions (groups) for which this Location will be available. If it is empty, the location will be available to all divisions.
Referencenumber	String	No	The unique number used to update locations
Return Result	SvResult	No	SvResult object that indicates the success or failure of the method call.

This service method allows Locations to be updated.

Ordinal	DataType	Can be Null?	Description
Name	String	Yes	The Name of the Location
landmarkType	String	Yes	The type of the Location
Location	svLocation	Yes	The address of the Location
Referencenumber	String	No	The unique number used to update locations
Return Result	SvResult	No	SvResult object that indicates the success or failure of the method call.

This service method returns all Locations for the specified landmark (location) types.

Ordinal	DataType	Can be Null?	Description
landmarkType	String	No	The type of the Location
Return Result	SvLandmark	No	Landmark information.

This service method deletes the specified Locations.

Ordinal	DataType	Can be Null?	Description
referenceNumber	String	Yes	Deletes a location with the reference number. If the location is found, then returns true as the result. If the location is not found, then returns false with the message 'Landmark reference number not specified'.