Retrieves the location for the location ID.
name | description | type | default | type |
---|---|---|---|---|
id | ID for the RowLocation to be returned | path | String | |
includeComments | if related Comment records should be included | query | false | Boolean |
includeContacts | if related Contact records should be included | query | false | Boolean |
the requested RowLocation object
Additional attributes:
__categoryDescr
This value represents the description of the category, found in the location.category
field.__defCommodityDescr
This value represents the description of the commodity, found in the location.def_commodity_id
field.__dispatchZone
This value represents the description of the location's dispatch zoneRowSalesperson
This element represent the salesperson associated with the location, by the location.salesperson
field.
The element contains a __name
attribute with the value salesperson
.RowCustomer
This element represent the customer associated with the location, by the location.customer_id
field.
The element contains a __name
attribute with the value customer
.RowContact
These elements represent the contacts associated with the location.
The element contains a __name
attribute with the value contacts
.
*Note this is only returned if the includeContacts
Query Parameter is passed as true.RowComments
These elements represent the comments associated with the location.
The element contains a __name
attribute with the value comments
.
*Note this is only returned if the includeComments
Query Parameter is passed as true.