REL documentation
properties locationsbyfac (http://api.3plcentral.com/rels/properties/locationsbyfac)
Resource:
Collection: of location
C# Rel Const:
Rels.PropertySvc.LocationListByFac
URI template:
facilities/{id}/locations{?pgsiz,pgnum,rql,sort,excludeAuditing}
Obtain URI from:
Billboard , /rels/properties/facility
Get location collection from a facility
Success status: 200; Response is cacheable
Name (* = required) Data Type Description
id * int facility id
pgsiz int max records to return per response; use "next" or "prev" link to paginate
pgnum int considering pgsiz, returns the pgnum-th page, 1-indexed
rql string see RQL documentation
sort string see RQL documentation
excludeAuditing bool true: filters out locations contained in an active audit; however, this makes the response not cacheable.
Type Description
TotalResults int
ResourceList IList<Property.Models.Location>
AllocationPriority int
Field1 string Required
Field2 string
Field3 string
Field4 string
Description string
FacilityIdentifier Generic.Models.FacilityIdentifier
Name string
Id int
LocationTypeIdentifier Generic.Models.LocationTypeIdentifier
Name string
Id int
LocationBillingTypeIdentifier Generic.Models.LocationBillingTypeIdentifier
Name string
Id int
Quarantinable bool
Height decimal? ...
Width decimal? ...
Length decimal? ...
WeightAllowed decimal? ...
TemperatureMinimum decimal? ...
QuantityMinimum decimal? ...
Zones string
PercentFill decimal? ...
StoreOnlyPallets bool
NumberPalletsAllowed int? ...
LastCountedDate DateTime? ... read-only; date when location was last counted in an inventory audit
QuantityMax decimal? ...
NonPickable bool
ReplenishLocation bool
ReplenishmentEnabled bool
PickPath int? ...
LocationId int
Name string
Deactivated bool
HasInventory bool
Links IList<WebApi.Hal.Link>
- edit
- /rels/properties/locationsactivatebyfac
- /rels/properties/facility
Links IList<WebApi.Hal.Link>
- next
- prev
Sample accept: application/hal+json
{
  "totalResults": 1,
  "_embedded": {
    "http://api.3plCentral.com/rels/properties/location": [
      {
        "allocationPriority": 1,
        "field1": "str",
        "field2": "str",
        "field3": "str",
        "field4": "str",
        "description": "str",
        "facilityIdentifier": {
          "name": "str",
          "id": 2
        },
        "locationTypeIdentifier": {
          "name": "str",
          "id": 2
        },
        "locationBillingTypeIdentifier": {
          "name": "str",
          "id": 2
        },
        "quarantinable": true,
        "height": 1.0,
        "width": 1.0,
        "length": 1.0,
        "weightAllowed": 1.0,
        "temperatureMinimum": 1.0,
        "quantityMinimum": 1.0,
        "zones": "str",
        "percentFill": 1.0,
        "storeOnlyPallets": true,
        "numberPalletsAllowed": 1,
        "lastCountedDate": "2016-12-25T23:00:00",
        "quantityMax": 1.0,
        "rowVersion": "str",
        "nonPickable": true,
        "replenishLocation": true,
        "replenishmentEnabled": true,
        "pickPath": 1,
        "locationId": 15,
        "name": "str",
        "deactivated": true,
        "hasInventory": true
      }
    ]
  }
}
Add a new location
Success status: 201; ETag response header supplied
Name (* = required) Data Type Description
id * int facility id
Type Description
AllocationPriority int
Field1 string Required
Field2 string
Field3 string
Field4 string
Description string
FacilityIdentifier Generic.Models.FacilityIdentifier
Name string
Id int
LocationTypeIdentifier Generic.Models.LocationTypeIdentifier
Name string
Id int
LocationBillingTypeIdentifier Generic.Models.LocationBillingTypeIdentifier
Name string
Id int
Quarantinable bool
Height decimal? ...
Width decimal? ...
Length decimal? ...
WeightAllowed decimal? ...
TemperatureMinimum decimal? ...
QuantityMinimum decimal? ...
Zones string
PercentFill decimal? ...
StoreOnlyPallets bool
NumberPalletsAllowed int? ...
LastCountedDate DateTime? ... read-only; date when location was last counted in an inventory audit
QuantityMax decimal? ...
NonPickable bool
ReplenishLocation bool
ReplenishmentEnabled bool
PickPath int? ...
LocationId int
Name string
Deactivated bool
HasInventory bool
Sample content-type: application/hal+json
 
{
  "allocationPriority": 1,
  "field1": "str",
  "field2": "str",
  "field3": "str",
  "field4": "str",
  "description": "str",
  "facilityIdentifier": {
    "name": "str",
    "id": 2
  },
  "locationTypeIdentifier": {
    "name": "str",
    "id": 2
  },
  "locationBillingTypeIdentifier": {
    "name": "str",
    "id": 2
  },
  "quarantinable": true,
  "height": 1.0,
  "width": 1.0,
  "length": 1.0,
  "weightAllowed": 1.0,
  "temperatureMinimum": 1.0,
  "quantityMinimum": 1.0,
  "zones": "str",
  "percentFill": 1.0,
  "storeOnlyPallets": true,
  "numberPalletsAllowed": 1,
  "lastCountedDate": "2016-12-25T23:00:00",
  "quantityMax": 1.0,
  "rowVersion": "str",
  "nonPickable": true,
  "replenishLocation": true,
  "replenishmentEnabled": true,
  "pickPath": 1,
  "locationId": 15,
  "name": "str",
  "deactivated": true,
  "hasInventory": true
}
Type Description
AllocationPriority int
Field1 string Required
Field2 string
Field3 string
Field4 string
Description string
FacilityIdentifier Generic.Models.FacilityIdentifier
Name string
Id int
LocationTypeIdentifier Generic.Models.LocationTypeIdentifier
Name string
Id int
LocationBillingTypeIdentifier Generic.Models.LocationBillingTypeIdentifier
Name string
Id int
Quarantinable bool
Height decimal? ...
Width decimal? ...
Length decimal? ...
WeightAllowed decimal? ...
TemperatureMinimum decimal? ...
QuantityMinimum decimal? ...
Zones string
PercentFill decimal? ...
StoreOnlyPallets bool
NumberPalletsAllowed int? ...
LastCountedDate DateTime? ... read-only; date when location was last counted in an inventory audit
QuantityMax decimal? ...
NonPickable bool
ReplenishLocation bool
ReplenishmentEnabled bool
PickPath int? ...
LocationId int
Name string
Deactivated bool
HasInventory bool
Links IList<WebApi.Hal.Link>
- edit
- /rels/properties/locationsactivatebyfac
- /rels/properties/facility
Sample accept: application/hal+json
{
  "allocationPriority": 1,
  "field1": "str",
  "field2": "str",
  "field3": "str",
  "field4": "str",
  "description": "str",
  "facilityIdentifier": {
    "name": "str",
    "id": 2
  },
  "locationTypeIdentifier": {
    "name": "str",
    "id": 2
  },
  "locationBillingTypeIdentifier": {
    "name": "str",
    "id": 2
  },
  "quarantinable": true,
  "height": 1.0,
  "width": 1.0,
  "length": 1.0,
  "weightAllowed": 1.0,
  "temperatureMinimum": 1.0,
  "quantityMinimum": 1.0,
  "zones": "str",
  "percentFill": 1.0,
  "storeOnlyPallets": true,
  "numberPalletsAllowed": 1,
  "lastCountedDate": "2016-12-25T23:00:00",
  "quantityMax": 1.0,
  "rowVersion": "str",
  "nonPickable": true,
  "replenishLocation": true,
  "replenishmentEnabled": true,
  "pickPath": 1,
  "locationId": 15,
  "name": "str",
  "deactivated": true,
  "hasInventory": true
}
Delete a selection of locations from a facility
Success status: 204
Name (* = required) Data Type Description
id * int facility id
rql * string see RQL documentation

This documentation is subject to change, and is updated often and without warning. The models documented may or may not be available to users now or in the future. Use this documentation at your own risk.
Contact api@3plcentral.com with any questions about this documentation.