Infoplus.LocationApi

All URIs are relative to https://kingsrook.localhost-testsubdomain1.infopluswms.com:8443/infoplus-wms/api

Method	HTTP request	Description
add_location	POST /beta/location	Create a location
add_location_audit	PUT /beta/location/{locationId}/audit/{locationAudit}	Add new audit for a location
add_location_file	POST /beta/location/{locationId}/file/{fileName}	Attach a file to a location
add_location_file_by_url	POST /beta/location/{locationId}/file	Attach a file to a location by URL.
add_location_tag	PUT /beta/location/{locationId}/tag/{locationTag}	Add new tags for a location.
delete_location	DELETE /beta/location/{locationId}	Delete a location
delete_location_file	DELETE /beta/location/{locationId}/file/{fileId}	Delete a file for a location.
delete_location_tag	DELETE /beta/location/{locationId}/tag/{locationTag}	Delete a tag for a location.
get_duplicate_location_by_id	GET /beta/location/duplicate/{locationId}	Get a duplicated a location by id
get_location_by_filter	GET /beta/location/search	Search locations by filter
get_location_by_id	GET /beta/location/{locationId}	Get a location by id
get_location_files	GET /beta/location/{locationId}/file	Get the files for a location.
get_location_tags	GET /beta/location/{locationId}/tag	Get the tags for a location.
update_location	PUT /beta/location	Update a location
update_location_custom_fields	PUT /beta/location/customFields	Update a location custom fields

add_location

Location add_location(body)

Create a location

Inserts a new location using the specified data.

Example

from __future__ import print_function
import time
import Infoplus
from Infoplus.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = Infoplus.Configuration()
configuration.api_key['API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['API-Key'] = 'Bearer'

# create an instance of the API class
api_instance = Infoplus.LocationApi(Infoplus.ApiClient(configuration))
body = Infoplus.Location() # Location | Location to be inserted.

try:
    # Create a location
    api_response = api_instance.add_location(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LocationApi->add_location: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	Location	Location to be inserted.

Return type

Location

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

add_location_audit

add_location_audit(location_id, location_audit)

Add new audit for a location

Adds an audit to an existing location.

Example

from __future__ import print_function
import time
import Infoplus
from Infoplus.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = Infoplus.Configuration()
configuration.api_key['API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['API-Key'] = 'Bearer'

# create an instance of the API class
api_instance = Infoplus.LocationApi(Infoplus.ApiClient(configuration))
location_id = 56 # int | Id of the location to add an audit to
location_audit = 'location_audit_example' # str | The audit to add

try:
    # Add new audit for a location
    api_instance.add_location_audit(location_id, location_audit)
except ApiException as e:
    print("Exception when calling LocationApi->add_location_audit: %s\n" % e)

Parameters

Name	Type	Description	Notes
location_id	int	Id of the location to add an audit to
location_audit	str	The audit to add

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

add_location_file

add_location_file(location_id, file_name)

Attach a file to a location

Adds a file to an existing location.

Example

from __future__ import print_function
import time
import Infoplus
from Infoplus.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = Infoplus.Configuration()
configuration.api_key['API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['API-Key'] = 'Bearer'

# create an instance of the API class
api_instance = Infoplus.LocationApi(Infoplus.ApiClient(configuration))
location_id = 56 # int | Id of the location to add a file to
file_name = 'file_name_example' # str | Name of file

try:
    # Attach a file to a location
    api_instance.add_location_file(location_id, file_name)
except ApiException as e:
    print("Exception when calling LocationApi->add_location_file: %s\n" % e)

Parameters

Name	Type	Description	Notes
location_id	int	Id of the location to add a file to
file_name	str	Name of file

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

add_location_file_by_url

add_location_file_by_url(body, location_id)

Attach a file to a location by URL.

Adds a file to an existing location by URL.

Example

from __future__ import print_function
import time
import Infoplus
from Infoplus.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = Infoplus.Configuration()
configuration.api_key['API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['API-Key'] = 'Bearer'

# create an instance of the API class
api_instance = Infoplus.LocationApi(Infoplus.ApiClient(configuration))
body = Infoplus.RecordFile() # RecordFile | The url and optionly fileName to be used.
location_id = 56 # int | Id of the location to add an file to

try:
    # Attach a file to a location by URL.
    api_instance.add_location_file_by_url(body, location_id)
except ApiException as e:
    print("Exception when calling LocationApi->add_location_file_by_url: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	RecordFile	The url and optionly fileName to be used.
location_id	int	Id of the location to add an file to

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

add_location_tag

add_location_tag(location_id, location_tag)

Add new tags for a location.

Adds a tag to an existing location.

Example

from __future__ import print_function
import time
import Infoplus
from Infoplus.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = Infoplus.Configuration()
configuration.api_key['API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['API-Key'] = 'Bearer'

# create an instance of the API class
api_instance = Infoplus.LocationApi(Infoplus.ApiClient(configuration))
location_id = 56 # int | Id of the location to add a tag to
location_tag = 'location_tag_example' # str | The tag to add

try:
    # Add new tags for a location.
    api_instance.add_location_tag(location_id, location_tag)
except ApiException as e:
    print("Exception when calling LocationApi->add_location_tag: %s\n" % e)

Parameters

Name	Type	Description	Notes
location_id	int	Id of the location to add a tag to
location_tag	str	The tag to add

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_location

delete_location(location_id)

Delete a location

Deletes the location identified by the specified id.

Example

from __future__ import print_function
import time
import Infoplus
from Infoplus.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = Infoplus.Configuration()
configuration.api_key['API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['API-Key'] = 'Bearer'

# create an instance of the API class
api_instance = Infoplus.LocationApi(Infoplus.ApiClient(configuration))
location_id = 56 # int | Id of the location to be deleted.

try:
    # Delete a location
    api_instance.delete_location(location_id)
except ApiException as e:
    print("Exception when calling LocationApi->delete_location: %s\n" % e)

Parameters

Name	Type	Description	Notes
location_id	int	Id of the location to be deleted.

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_location_file

delete_location_file(location_id, file_id)

Delete a file for a location.

Deletes an existing location file using the specified data.

Example

from __future__ import print_function
import time
import Infoplus
from Infoplus.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = Infoplus.Configuration()
configuration.api_key['API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['API-Key'] = 'Bearer'

# create an instance of the API class
api_instance = Infoplus.LocationApi(Infoplus.ApiClient(configuration))
location_id = 56 # int | Id of the location to remove file from
file_id = 56 # int | Id of the file to delete

try:
    # Delete a file for a location.
    api_instance.delete_location_file(location_id, file_id)
except ApiException as e:
    print("Exception when calling LocationApi->delete_location_file: %s\n" % e)

Parameters

Name	Type	Description	Notes
location_id	int	Id of the location to remove file from
file_id	int	Id of the file to delete

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_location_tag

delete_location_tag(location_id, location_tag)

Delete a tag for a location.

Deletes an existing location tag using the specified data.

Example

from __future__ import print_function
import time
import Infoplus
from Infoplus.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = Infoplus.Configuration()
configuration.api_key['API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['API-Key'] = 'Bearer'

# create an instance of the API class
api_instance = Infoplus.LocationApi(Infoplus.ApiClient(configuration))
location_id = 56 # int | Id of the location to remove tag from
location_tag = 'location_tag_example' # str | The tag to delete

try:
    # Delete a tag for a location.
    api_instance.delete_location_tag(location_id, location_tag)
except ApiException as e:
    print("Exception when calling LocationApi->delete_location_tag: %s\n" % e)

Parameters

Name	Type	Description	Notes
location_id	int	Id of the location to remove tag from
location_tag	str	The tag to delete

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_duplicate_location_by_id

Location get_duplicate_location_by_id(location_id)

Get a duplicated a location by id

Returns a duplicated location identified by the specified id.

Example

from __future__ import print_function
import time
import Infoplus
from Infoplus.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = Infoplus.Configuration()
configuration.api_key['API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['API-Key'] = 'Bearer'

# create an instance of the API class
api_instance = Infoplus.LocationApi(Infoplus.ApiClient(configuration))
location_id = 56 # int | Id of the location to be duplicated.

try:
    # Get a duplicated a location by id
    api_response = api_instance.get_duplicate_location_by_id(location_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LocationApi->get_duplicate_location_by_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
location_id	int	Id of the location to be duplicated.

Return type

Location

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_location_by_filter

list[Location] get_location_by_filter(filter=filter, page=page, limit=limit, sort=sort)

Search locations by filter

Returns the list of locations that match the given filter.

Example

from __future__ import print_function
import time
import Infoplus
from Infoplus.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = Infoplus.Configuration()
configuration.api_key['API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['API-Key'] = 'Bearer'

# create an instance of the API class
api_instance = Infoplus.LocationApi(Infoplus.ApiClient(configuration))
filter = 'filter_example' # str | Query string, used to filter results. (optional)
page = 56 # int | Result page number.  Defaults to 1. (optional)
limit = 56 # int | Maximum results per page.  Defaults to 20.  Max allowed value is 250. (optional)
sort = 'sort_example' # str | Sort results by specified field. (optional)

try:
    # Search locations by filter
    api_response = api_instance.get_location_by_filter(filter=filter, page=page, limit=limit, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LocationApi->get_location_by_filter: %s\n" % e)

Parameters

Name	Type	Description	Notes
filter	str	Query string, used to filter results.	[optional]
page	int	Result page number. Defaults to 1.	[optional]
limit	int	Maximum results per page. Defaults to 20. Max allowed value is 250.	[optional]
sort	str	Sort results by specified field.	[optional]

Return type

list[Location]

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_location_by_id

Location get_location_by_id(location_id)

Get a location by id

Returns the location identified by the specified id.

Example

from __future__ import print_function
import time
import Infoplus
from Infoplus.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = Infoplus.Configuration()
configuration.api_key['API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['API-Key'] = 'Bearer'

# create an instance of the API class
api_instance = Infoplus.LocationApi(Infoplus.ApiClient(configuration))
location_id = 56 # int | Id of the location to be returned.

try:
    # Get a location by id
    api_response = api_instance.get_location_by_id(location_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LocationApi->get_location_by_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
location_id	int	Id of the location to be returned.

Return type

Location

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_location_files

get_location_files(location_id)

Get the files for a location.

Get all existing location files.

Example

from __future__ import print_function
import time
import Infoplus
from Infoplus.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = Infoplus.Configuration()
configuration.api_key['API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['API-Key'] = 'Bearer'

# create an instance of the API class
api_instance = Infoplus.LocationApi(Infoplus.ApiClient(configuration))
location_id = 56 # int | Id of the location to get files for

try:
    # Get the files for a location.
    api_instance.get_location_files(location_id)
except ApiException as e:
    print("Exception when calling LocationApi->get_location_files: %s\n" % e)

Parameters

Name	Type	Description	Notes
location_id	int	Id of the location to get files for

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_location_tags

get_location_tags(location_id)

Get the tags for a location.

Get all existing location tags.

Example

from __future__ import print_function
import time
import Infoplus
from Infoplus.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = Infoplus.Configuration()
configuration.api_key['API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['API-Key'] = 'Bearer'

# create an instance of the API class
api_instance = Infoplus.LocationApi(Infoplus.ApiClient(configuration))
location_id = 56 # int | Id of the location to get tags for

try:
    # Get the tags for a location.
    api_instance.get_location_tags(location_id)
except ApiException as e:
    print("Exception when calling LocationApi->get_location_tags: %s\n" % e)

Parameters

Name	Type	Description	Notes
location_id	int	Id of the location to get tags for

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_location

update_location(body)

Update a location

Updates an existing location using the specified data.

Example

from __future__ import print_function
import time
import Infoplus
from Infoplus.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = Infoplus.Configuration()
configuration.api_key['API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['API-Key'] = 'Bearer'

# create an instance of the API class
api_instance = Infoplus.LocationApi(Infoplus.ApiClient(configuration))
body = Infoplus.Location() # Location | Location to be updated.

try:
    # Update a location
    api_instance.update_location(body)
except ApiException as e:
    print("Exception when calling LocationApi->update_location: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	Location	Location to be updated.

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_location_custom_fields

update_location_custom_fields(body)

Update a location custom fields

Updates an existing location custom fields using the specified data.

Example

from __future__ import print_function
import time
import Infoplus
from Infoplus.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = Infoplus.Configuration()
configuration.api_key['API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['API-Key'] = 'Bearer'

# create an instance of the API class
api_instance = Infoplus.LocationApi(Infoplus.ApiClient(configuration))
body = Infoplus.Location() # Location | Location to be updated.

try:
    # Update a location custom fields
    api_instance.update_location_custom_fields(body)
except ApiException as e:
    print("Exception when calling LocationApi->update_location_custom_fields: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	Location	Location to be updated.

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

LocationApi.md

Latest commit

History

LocationApi.md

File metadata and controls

Infoplus.LocationApi

add_location

Example

Parameters

Return type

Authorization

HTTP request headers

add_location_audit

Example

Parameters

Return type

Authorization

HTTP request headers

add_location_file

Example

Parameters

Return type

Authorization

HTTP request headers

add_location_file_by_url

Example

Parameters

Return type

Authorization

HTTP request headers

add_location_tag

Example

Parameters

Return type

Authorization

HTTP request headers

delete_location

Example

Parameters

Return type

Authorization

HTTP request headers

delete_location_file

Example

Parameters

Return type

Authorization

HTTP request headers

delete_location_tag

Example

Parameters

Return type

Authorization

HTTP request headers

get_duplicate_location_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

get_location_by_filter

Example

Parameters

Return type

Authorization

HTTP request headers

get_location_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

get_location_files

Example

Parameters

Return type

Authorization

HTTP request headers

get_location_tags