Location
A Location represents a grouping of readers.
Related guide: Fleet management
The Location object
Attributes
- idstring
Unique identifier for the object.
- addressobject
The full address of the location.
- display_
namestring The display name of the location.
- metadataobject
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
More attributes
- objectstring
- configuration_
overridesnullable string - livemodeboolean
Create a Location
Creates a new Location
object. For further details, including which address fields are required in each country, see the Manage locations guide.
Parameters
- addressobjectRequired
The full address of the location.
- display_
namestringRequired A name for the location.
- metadataobject
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata
.
More parameters
- configuration_
overridesstring
Returns
Returns a Location
object if creation succeeds.
Update a Location
Updates a Location
object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Parameters
- addressobject
The full address of the location.
- display_
namestring A name for the location.
- metadataobject
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata
.
More parameters
- configuration_
overridesstring
Returns
Returns an updated Location
object if a valid identifier was provided.
Retrieve a Location
Retrieves a Location
object.
Parameters
No parameters.
Returns
Returns a Location
object if a valid identifier was provided.