POST api/Lists/Upload/Detail

Request Information

URI Parameters

None.

Body Parameters

CustList
NameDescriptionTypeAdditional information
ListName

string

None.

NoOfAddedItems

integer

None.

ListDetails

Collection of ListDetail

None.

hasUploadedFile

boolean

None.

Id

globally unique identifier

None.

Comments

string

None.

DateCreated

date

None.

DateModified

date

None.

Request Formats

application/json, text/json

Sample:
{
  "ListName": "sample string 1",
  "NoOfAddedItems": 2,
  "ListDetails": [
    {
      "CustListId": "2a2224bc-808d-45d1-b189-71ebb6997898",
      "Id": "344bafce-8d87-4312-8911-7980ee4d2053",
      "UnitPrice": "sample string 4",
      "Quantity": 5,
      "MaterialID": "sample string 6",
      "Material": {
        "MaterialID": "sample string 1",
        "Description": "sample string 2",
        "Family": "sample string 3",
        "SubFamily": "sample string 4",
        "Brand": "sample string 5",
        "DisplayUPC": "sample string 6",
        "GTIN": "sample string 7",
        "ShelfLife": "sample string 8",
        "CodeDating": "sample string 9",
        "RefrigerationText": "sample string 10",
        "Establishment": "sample string 11",
        "Characteristics": "sample string 12",
        "Allergens": "sample string 13",
        "UMConversions": "sample string 14",
        "Package": "sample string 15",
        "Case": "sample string 16",
        "CaseWeightType": "sample string 17",
        "CaseWt": "sample string 18",
        "ShippingWt": "sample string 19",
        "Pallet": "sample string 20",
        "SellingRestriction": "sample string 21",
        "CaseUPC": "sample string 22",
        "ImageUrl": "sample string 23",
        "NutritionFactsUrl": "sample string 24",
        "SellingUnit": "sample string 25",
        "ConversionFactor": "sample string 26"
      },
      "DateAdded": "2024-11-21T10:10:49.1749727+00:00"
    },
    {
      "CustListId": "2a2224bc-808d-45d1-b189-71ebb6997898",
      "Id": "344bafce-8d87-4312-8911-7980ee4d2053",
      "UnitPrice": "sample string 4",
      "Quantity": 5,
      "MaterialID": "sample string 6",
      "Material": {
        "MaterialID": "sample string 1",
        "Description": "sample string 2",
        "Family": "sample string 3",
        "SubFamily": "sample string 4",
        "Brand": "sample string 5",
        "DisplayUPC": "sample string 6",
        "GTIN": "sample string 7",
        "ShelfLife": "sample string 8",
        "CodeDating": "sample string 9",
        "RefrigerationText": "sample string 10",
        "Establishment": "sample string 11",
        "Characteristics": "sample string 12",
        "Allergens": "sample string 13",
        "UMConversions": "sample string 14",
        "Package": "sample string 15",
        "Case": "sample string 16",
        "CaseWeightType": "sample string 17",
        "CaseWt": "sample string 18",
        "ShippingWt": "sample string 19",
        "Pallet": "sample string 20",
        "SellingRestriction": "sample string 21",
        "CaseUPC": "sample string 22",
        "ImageUrl": "sample string 23",
        "NutritionFactsUrl": "sample string 24",
        "SellingUnit": "sample string 25",
        "ConversionFactor": "sample string 26"
      },
      "DateAdded": "2024-11-21T10:10:49.1749727+00:00"
    }
  ],
  "hasUploadedFile": true,
  "Id": "764d81fb-0f88-4fdc-8d25-1d0213900e7b",
  "Comments": "sample string 6",
  "DateCreated": "2024-11-21T10:10:49.1749727+00:00",
  "DateModified": "2024-11-21T10:10:49.1749727+00:00"
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CustList'.

Response Information

Resource Description

DataResultOfCustList
NameDescriptionTypeAdditional information
Value

RetVal

None.

Message

string

None.

Data

CustList

None.

Response Formats

application/json, text/json

Sample:
{
  "Value": 0,
  "Message": "sample string 1",
  "Data": {
    "ListName": "sample string 1",
    "NoOfAddedItems": 2,
    "ListDetails": [
      {
        "CustListId": "0f9365cf-cd78-4f44-a29a-c6aa1b8413e2",
        "Id": "28ec3d7b-8605-40cb-b0d5-10ff1fec9de6",
        "UnitPrice": "sample string 4",
        "Quantity": 5,
        "MaterialID": "sample string 6",
        "Material": {
          "MaterialID": "sample string 1",
          "Description": "sample string 2",
          "Family": "sample string 3",
          "SubFamily": "sample string 4",
          "Brand": "sample string 5",
          "DisplayUPC": "sample string 6",
          "GTIN": "sample string 7",
          "ShelfLife": "sample string 8",
          "CodeDating": "sample string 9",
          "RefrigerationText": "sample string 10",
          "Establishment": "sample string 11",
          "Characteristics": "sample string 12",
          "Allergens": "sample string 13",
          "UMConversions": "sample string 14",
          "Package": "sample string 15",
          "Case": "sample string 16",
          "CaseWeightType": "sample string 17",
          "CaseWt": "sample string 18",
          "ShippingWt": "sample string 19",
          "Pallet": "sample string 20",
          "SellingRestriction": "sample string 21",
          "CaseUPC": "sample string 22",
          "ImageUrl": "sample string 23",
          "NutritionFactsUrl": "sample string 24",
          "SellingUnit": "sample string 25",
          "ConversionFactor": "sample string 26"
        },
        "DateAdded": "2024-11-21T10:10:49.1749727+00:00"
      },
      {
        "CustListId": "0f9365cf-cd78-4f44-a29a-c6aa1b8413e2",
        "Id": "28ec3d7b-8605-40cb-b0d5-10ff1fec9de6",
        "UnitPrice": "sample string 4",
        "Quantity": 5,
        "MaterialID": "sample string 6",
        "Material": {
          "MaterialID": "sample string 1",
          "Description": "sample string 2",
          "Family": "sample string 3",
          "SubFamily": "sample string 4",
          "Brand": "sample string 5",
          "DisplayUPC": "sample string 6",
          "GTIN": "sample string 7",
          "ShelfLife": "sample string 8",
          "CodeDating": "sample string 9",
          "RefrigerationText": "sample string 10",
          "Establishment": "sample string 11",
          "Characteristics": "sample string 12",
          "Allergens": "sample string 13",
          "UMConversions": "sample string 14",
          "Package": "sample string 15",
          "Case": "sample string 16",
          "CaseWeightType": "sample string 17",
          "CaseWt": "sample string 18",
          "ShippingWt": "sample string 19",
          "Pallet": "sample string 20",
          "SellingRestriction": "sample string 21",
          "CaseUPC": "sample string 22",
          "ImageUrl": "sample string 23",
          "NutritionFactsUrl": "sample string 24",
          "SellingUnit": "sample string 25",
          "ConversionFactor": "sample string 26"
        },
        "DateAdded": "2024-11-21T10:10:49.1749727+00:00"
      }
    ],
    "hasUploadedFile": true,
    "Id": "93d356fe-b8ff-43cd-8dd0-c59b51fa0d26",
    "Comments": "sample string 6",
    "DateCreated": "2024-11-21T10:10:49.1749727+00:00",
    "DateModified": "2024-11-21T10:10:49.1749727+00:00"
  }
}