Megaventory API v2017a

<back to all web services

DashboardBoxGetData

The following routes are available for this service:
GET POST/DashboardBox/DashboardBoxGetDataGets orders/documentsUses your API key and a DashboardBoxId to return a result based on the Dashboard box type. Optionally, you may use the Page and Limit parameters to control the data you receive. Use Page to specify a subset of data and Limit to set the maximum number of entries (up to 100) for that subset. Within the API result, you will find the "__type" variable which serves as an indicator of the type of elements that are returned.

Examples:



A.


Return the first two documents for the DashboardBoxId


Value: 

 
{
  "DashboardBoxId": 4531,
  "Page": "1",
  "Limit": "2"
}

Response: 

{
  "Data": [
    {
      "__type": "Megaventory.Models.Types.mvPurchaseOrder, Megaventory.Models",
      "PurchaseOrderId": 67564,
      "PurchaseOrderTypeId": 175,
      "PurchaseOrderTypeAbbreviation": "PO-TEST",
      "PurchaseOrderTypeDescription": "TEST PO",
      "PurchaseOrderNo": "PT4",
      "PurchaseOrderReferenceNo": "",
      "PurchaseOrderReferenceApplication": "",
      "PurchaseOrderDate": "/Date(1684789200000-0000)/",
      "PurchaseOrderCustomOrderDate1": "/Date(-62135596800000-0000)/",
      "PurchaseOrderCustomOrderDate2": "/Date(-62135596800000-0000)/",
      "PurchaseOrderCurrencyCode": "USD",
      "PurchaseOrderSupplierID": 5466,
      "PurchaseOrderSupplierName": "Jason M.",
      "PurchaseOrderAddress": "",
      "PurchaseOrderPickupAddress": "",
      "PurchaseOrderAddresses": [
        {
          "AddressType": "Billing",
          "AddressLine1": "",
          "AddressLine2": "",
          "AddressLine3": "",
          "TaxIdNumber": "",
          "Organization": "",
          "City": "",
          "State": "",
          "Country": "NONE",
          "CountryName": "",
          "Longitude": "",
          "Latitude": "",
          "ZipCode": ""
        },
        {
          "AddressType": "Shipping1",
          "AddressLine1": "",
          "AddressLine2": "",
          "AddressLine3": "",
          "TaxIdNumber": "",
          "Organization": "",
          "City": "",
          "State": "",
          "Country": "NONE",
          "CountryName": "",
          "Longitude": "",
          "Latitude": "",
          "ZipCode": ""
        }
      ],
      "PurchaseOrderContactPerson": "",
      "PurchaseOrderInventoryLocationID": 0,
      "PurchaseOrderCustomFlag1": false,
      "PurchaseOrderCustomFlag2": false,
      "PurchaseOrderCustomFlag3": false,
      "PurchaseOrderCustomFlag4": false,
      "PurchaseOrderCustomFlag5": false,
      "PurchaseOrderCustomFlag6": false,
      "PurchaseOrderCustomFlag7": false,
      "PurchaseOrderCustomFlag8": false,
      "PurchaseOrderCustomFlag9": false,
      "PurchaseOrderCustomFlag10": false,
      "PurchaseOrderComments": "",
      "PurchaseOrderTags": "",
      "PurchaseOrderPaymentTermsEnumeration": "None",
      "PurchaseOrderPaymentMethod": "None",
      "PurchaseOrderTotalQuantity": 1,
      "PurchaseOrderAmountSubtotalWithoutTaxAndDiscount": 0,
      "PurchaseOrderAmountTotalDiscount": 0,
      "PurchaseOrderAmountTotalTax": 0,
      "PurchaseOrderAmountGrandTotal": 0,
      "PurchaseOrderDetails": [
        {
          "PurchaseOrderRowDetailID": 82972,
          "PurchaseOrderRowProductID": 60512,
          "PurchaseOrderRowProductSKU": "gins-4",
          "PurchaseOrderRowProductDescription": "My Gins",
          "PurchaseOrderRowQuantity": 1,
          "PurchaseOrderRowReceivedQuantity": 0,
          "PurchaseOrderRowInvoicedQuantity": 0,
          "PurchaseOrderRowUnitPriceWithoutTaxOrDiscount": 0,
          "PurchaseOrderRowTaxID": 0,
          "PurchaseOrderTotalTaxAmount": 0,
          "PurchaseOrderRowDiscountID": 0,
          "PurchaseOrderRowTotalDiscountAmount": 0,
          "PurchaseOrderRowTotalAmount": 0,
          "PurchaseOrderRowSerialNumbers": [],
          "PurchaseOrderRowBatchNumbers": [],
          "PurchaseOrderRowRemarks": "",
          "PurchaseOrderRowExpectedReceivingDateEarliest": "/Date(1684789200000-0000)/",
          "PurchaseOrderRowExpectedReceivingDateLatest": "/Date(1693429200000-0000)/"
        }
      ],
      "PurchaseOrderStatus": "Pending",
      "chkReOpenOrCloseRelatedDocs": false,
      "PurchaseOrderCreationDate": "/Date(1684801100700-0000)/",
      "PurchaseOrderLastUpdatedDate": "/Date(1684801100700-0000)/",
      "PurchaseOrderExpectedReceivingDateEarliest": "/Date(1684789200000-0000)/",
      "PurchaseOrderExpectedReceivingDateLatest": "/Date(1693429200000-0000)/"
    },
    {
      "__type": "Megaventory.Models.Types.mvPurchaseOrder, Megaventory.Models",
      "PurchaseOrderId": 67563,
      "PurchaseOrderTypeId": 4,
      "PurchaseOrderTypeAbbreviation": "PO",
      "PurchaseOrderTypeDescription": "Purchase Order",
      "PurchaseOrderNo": "126",
      "PurchaseOrderReferenceNo": "",
      "PurchaseOrderReferenceApplication": "",
      "PurchaseOrderDate": "/Date(1684789200000-0000)/",
      "PurchaseOrderCustomOrderDate1": "/Date(-62135596800000-0000)/",
      "PurchaseOrderCustomOrderDate2": "/Date(-62135596800000-0000)/",
      "PurchaseOrderCurrencyCode": "USD",
      "PurchaseOrderSupplierID": 5451,
      "PurchaseOrderSupplierName": "Bread supplier",
      "PurchaseOrderAddress": "",
      "PurchaseOrderPickupAddress": "",
      "PurchaseOrderAddresses": [
        {
          "AddressType": "Billing",
          "AddressLine1": "",
          "AddressLine2": "",
          "AddressLine3": "",
          "TaxIdNumber": "",
          "Organization": "",
          "City": "",
          "State": "",
          "Country": "NONE",
          "CountryName": "",
          "Longitude": "",
          "Latitude": "",
          "ZipCode": ""
        },
        {
          "AddressType": "Shipping1",
          "AddressLine1": "",
          "AddressLine2": "",
          "AddressLine3": "",
          "TaxIdNumber": "",
          "Organization": "",
          "City": "",
          "State": "",
          "Country": "NONE",
          "CountryName": "",
          "Longitude": "",
          "Latitude": "",
          "ZipCode": ""
        }
      ],
      "PurchaseOrderContactPerson": "",
      "PurchaseOrderInventoryLocationID": 0,
      "PurchaseOrderCustomFlag1": false,
      "PurchaseOrderCustomFlag2": false,
      "PurchaseOrderCustomFlag3": false,
      "PurchaseOrderCustomFlag4": false,
      "PurchaseOrderCustomFlag5": false,
      "PurchaseOrderCustomFlag6": false,
      "PurchaseOrderCustomFlag7": false,
      "PurchaseOrderCustomFlag8": false,
      "PurchaseOrderCustomFlag9": false,
      "PurchaseOrderCustomFlag10": false,
      "PurchaseOrderComments": "",
      "PurchaseOrderTags": "",
      "PurchaseOrderPaymentTermsEnumeration": "None",
      "PurchaseOrderPaymentMethod": "None",
      "PurchaseOrderTotalQuantity": 1,
      "PurchaseOrderAmountSubtotalWithoutTaxAndDiscount": 0,
      "PurchaseOrderAmountTotalDiscount": 0,
      "PurchaseOrderAmountTotalTax": 0,
      "PurchaseOrderAmountGrandTotal": 0,
      "PurchaseOrderDetails": [
        {
          "PurchaseOrderRowDetailID": 82971,
          "PurchaseOrderRowProductID": 60475,
          "PurchaseOrderRowProductSKU": "bread",
          "PurchaseOrderRowProductDescription": "bread",
          "PurchaseOrderRowQuantity": 1,
          "PurchaseOrderRowReceivedQuantity": 0,
          "PurchaseOrderRowInvoicedQuantity": 0,
          "PurchaseOrderRowUnitPriceWithoutTaxOrDiscount": 0,
          "PurchaseOrderRowTaxID": 0,
          "PurchaseOrderTotalTaxAmount": 0,
          "PurchaseOrderRowDiscountID": 0,
          "PurchaseOrderRowTotalDiscountAmount": 0,
          "PurchaseOrderRowTotalAmount": 0,
          "PurchaseOrderRowSerialNumbers": [],
          "PurchaseOrderRowBatchNumbers": [],
          "PurchaseOrderRowRemarks": "",
          "PurchaseOrderRowExpectedReceivingDateEarliest": "/Date(1684789200000-0000)/",
          "PurchaseOrderRowExpectedReceivingDateLatest": "/Date(1693429200000-0000)/"
        }
      ],
      "PurchaseOrderStatus": "Pending",
      "chkReOpenOrCloseRelatedDocs": false,
      "PurchaseOrderCreationDate": "/Date(1684800844533-0000)/",
      "PurchaseOrderLastUpdatedDate": "/Date(1684800844533-0000)/",
      "PurchaseOrderExpectedReceivingDateEarliest": "/Date(1684789200000-0000)/",
      "PurchaseOrderExpectedReceivingDateLatest": "/Date(1693429200000-0000)/"
    }
  ],
  "ResponseStatus": {
    "ErrorCode": "0"
  }
}

To override the Content-type in your clients HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/DashboardBoxGetData HTTP/1.1 
Host: api.megaventory.com 
Content-Type: application/xml
Content-Length: length

<DashboardBoxGetData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Megaventory.APIEndpoints.Operations">
  <APIKEY>String</APIKEY>
  <DashboardBoxId>0</DashboardBoxId>
  <Page>0</Page>
  <Limit>0</Limit>
</DashboardBoxGetData>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DashboardBoxGetDataResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Megaventory.APIEndpoints.Operations">
  <Data xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
  <InternalErrorCode>String</InternalErrorCode>
</DashboardBoxGetDataResponse>