REL documentation
Resource:Collection: of palletC# Rel Const:Rels.InventorySvc.PalletsURI template:pallets{?pgsiz,pgnum,rql,sort}Obtain URI from:
Success status: 200
| Name | Data Type | Description |
|---|---|---|
| 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 |
| Type | Description | |
|---|---|---|
| TotalResults | int | |
| ResourceList | IList<Inventory.Models.Pallet> | |
| Label | string | new unique label or leave blank for system to generate unique label number |
| FacilityIdentifier | Generic.Models.FacilityIdentifier | |
| Name | string | |
| Id | int | |
| PalletTypeIdentifier | Generic.Models.PalletTypeIdentifier | |
| Name | string | |
| Id | int | |
| Metric | Generic.Models.Dimension | |
| Length | decimal? ... | |
| Width | decimal? ... | |
| Height | decimal? ... | |
| Weight | decimal? ... | |
| Imperial | Generic.Models.Dimension | |
| Length | decimal? ... | |
| Width | decimal? ... | |
| Height | decimal? ... | |
| Weight | decimal? ... | |
| Links | IList<WebApi.Hal.Link> | |
| - edit | ||
| - /rels/properties/facility | ||
| Links | IList<WebApi.Hal.Link> | |
| - next | ||
| - prev |
{
"totalResults": 1,
"_embedded": {
"http://api.3plCentral.com/rels/inventory/pallet": [
{
"label": "str",
"facilityIdentifier": {
"name": "str",
"id": 2
},
"palletTypeIdentifier": {
"name": "str",
"id": 2
},
"metric": {
"length": 1.0,
"width": 1.0,
"height": 1.0,
"weight": 1.0
},
"imperial": {
"length": 1.0,
"width": 1.0,
"height": 1.0,
"weight": 1.0
},
"rowVersion": "str"
}
]
}
}
Success status: 200; ETag response header supplied
| Type | Description | |
|---|---|---|
| Label | string | new unique label or leave blank for system to generate unique label number |
| FacilityIdentifier | Generic.Models.FacilityIdentifier | |
| Name | string | |
| Id | int | |
| PalletTypeIdentifier | Generic.Models.PalletTypeIdentifier | |
| Name | string | |
| Id | int | |
| Metric | Generic.Models.Dimension | |
| Length | decimal? ... | |
| Width | decimal? ... | |
| Height | decimal? ... | |
| Weight | decimal? ... | |
| Imperial | Generic.Models.Dimension | |
| Length | decimal? ... | |
| Width | decimal? ... | |
| Height | decimal? ... | |
| Weight | decimal? ... |
Sample content-type: application/hal+json |
{
"label": "str",
"facilityIdentifier": {
"name": "str",
"id": 2
},
"palletTypeIdentifier": {
"name": "str",
"id": 2
},
"metric": {
"length": 1.0,
"width": 1.0,
"height": 1.0,
"weight": 1.0
},
"imperial": {
"length": 1.0,
"width": 1.0,
"height": 1.0,
"weight": 1.0
},
"rowVersion": "str"
}
| Type | Description | |
|---|---|---|
| Label | string | new unique label or leave blank for system to generate unique label number |
| FacilityIdentifier | Generic.Models.FacilityIdentifier | |
| Name | string | |
| Id | int | |
| PalletTypeIdentifier | Generic.Models.PalletTypeIdentifier | |
| Name | string | |
| Id | int | |
| Metric | Generic.Models.Dimension | |
| Length | decimal? ... | |
| Width | decimal? ... | |
| Height | decimal? ... | |
| Weight | decimal? ... | |
| Imperial | Generic.Models.Dimension | |
| Length | decimal? ... | |
| Width | decimal? ... | |
| Height | decimal? ... | |
| Weight | decimal? ... | |
| Links | IList<WebApi.Hal.Link> | |
| - edit | ||
| - /rels/properties/facility |
{
"label": "str",
"facilityIdentifier": {
"name": "str",
"id": 2
},
"palletTypeIdentifier": {
"name": "str",
"id": 2
},
"metric": {
"length": 1.0,
"width": 1.0,
"height": 1.0,
"weight": 1.0
},
"imperial": {
"length": 1.0,
"width": 1.0,
"height": 1.0,
"weight": 1.0
},
"rowVersion": "str"
}
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.