GET api/packinglist/returngoods/{branchId}

Gets all return items expected.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
branchId

A specific branch, if null all branches are used.

 integer

Required

Body Parameters

None.

Remarks

None.

Example

//Gets all the returning storage cards for branch with id 1.
http://localhost/api/packinglist/returngoods/1

Response Information

Resource Description

Collection of PackinglistReturnGoodsItem
NameDescriptionTypeAdditional information
StorageCardId

The Storage card which holds the equiment.

 globally unique identifier

None.
EquipmentSetId

The Equipment set expected to be returned.

 globally unique identifier

None.
BranchId

Which branch this return items is being return from.

 integer

None.
LicensePlate

The license plate for the storage card which is set for return.

 string

None.
StockPlaceId

The stock place id for the storage card which is set for return.

 integer

None.
StockName

The stock name for the storage card which is set for return.

 string

None.
MinTreadDepth

The lowest tread depth for the equipment that is being returned.

 decimal number

None.
Wheels

Indicates if the equipment are complete wheels.

 boolean

None.
Studs

Indicates if the equipment has studs.

 boolean

None.
SummerSeason

Indicates if the equipment set is summer (True) or winter (false) tyres.

 boolean

None.
NumberOfItems

The nuumber of items being returned.

 integer

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "StorageCardId": "29863a9d-7c91-4a36-8274-9fcbbe382286",
    "EquipmentSetId": "76e0c506-f1f6-422c-a395-baaa378d653e",
    "BranchId": 3,
    "LicensePlate": "sample string 4",
    "StockPlaceId": 1,
    "StockName": "sample string 5",
    "MinTreadDepth": 1.0,
    "Wheels": true,
    "Studs": true,
    "SummerSeason": true,
    "NumberOfItems": 9
  },
  {
    "StorageCardId": "29863a9d-7c91-4a36-8274-9fcbbe382286",
    "EquipmentSetId": "76e0c506-f1f6-422c-a395-baaa378d653e",
    "BranchId": 3,
    "LicensePlate": "sample string 4",
    "StockPlaceId": 1,
    "StockName": "sample string 5",
    "MinTreadDepth": 1.0,
    "Wheels": true,
    "Studs": true,
    "SummerSeason": true,
    "NumberOfItems": 9
  }
]

application/xml, text/xml

Sample: 
<ArrayOfPackinglistReturnGoodsItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.TyreHotel">
  <PackinglistReturnGoodsItem>
    <BranchId>3</BranchId>
    <EquipmentSetId>76e0c506-f1f6-422c-a395-baaa378d653e</EquipmentSetId>
    <LicensePlate>sample string 4</LicensePlate>
    <MinTreadDepth>1</MinTreadDepth>
    <NumberOfItems>9</NumberOfItems>
    <StockName>sample string 5</StockName>
    <StockPlaceId>1</StockPlaceId>
    <StorageCardId>29863a9d-7c91-4a36-8274-9fcbbe382286</StorageCardId>
    <Studs>true</Studs>
    <SummerSeason>true</SummerSeason>
    <Wheels>true</Wheels>
  </PackinglistReturnGoodsItem>
  <PackinglistReturnGoodsItem>
    <BranchId>3</BranchId>
    <EquipmentSetId>76e0c506-f1f6-422c-a395-baaa378d653e</EquipmentSetId>
    <LicensePlate>sample string 4</LicensePlate>
    <MinTreadDepth>1</MinTreadDepth>
    <NumberOfItems>9</NumberOfItems>
    <StockName>sample string 5</StockName>
    <StockPlaceId>1</StockPlaceId>
    <StorageCardId>29863a9d-7c91-4a36-8274-9fcbbe382286</StorageCardId>
    <Studs>true</Studs>
    <SummerSeason>true</SummerSeason>
    <Wheels>true</Wheels>
  </PackinglistReturnGoodsItem>
</ArrayOfPackinglistReturnGoodsItem>