Read Package

Parameters

Body Params
JSON:	json Package details needs to be passed as body parameter,it should be in JSON format.
XML:	string Package details needs to be passed as body parameter,it should be in XML format.

Path Params
yourCompany:	string The Company name need to passed in the base URL.For eg. if you enter xyzcompany name, the url https://{yourCompany}.agiliron.net/agiliron/api-40.php/Package&key=xyzkey will change to https://xyzcompany.agiliron.net/agiliron/api-40.php/Package&key=xyzkey

Path Params

yourCompany:

string The Company name need to passed in the base URL.For eg. if you enter xyzcompany name, the url **

https://{yourCompany}.agiliron.net/agiliron/api-40.php/Package&key=xyzkey

** will change to **

https://xyzcompany.agiliron.net/agiliron/api-40.php/Package&key=xyzkey

Query Params
	string In this parameter fieldname needs to be provided with condition and value to fetch related details.for eg. OrderNo,eq,36541 To fetch Package Details with OrderNo equal to 36541 and PackageNo equal to 2, the following url must be used[https://xyzcompany.agiliron.net/agiliron/api-40/Package?filter=OrderNo,eq,36541;PackageNo,eq,2&key=xyzkey To fetch Package Details with PackageId equal to 12, the following url must be used[https://xyzcompany.agiliron.net/agiliron/api-40/Package?filter=PackageId,eq,12&key=xyzkey List of condition abbrevations to be used: "cs": contain string (string contains value) "sw": start with (string starts with value) "ew": end with (string end with value) "neq": not equal (string or number should not match) "eq": equal (string or number matches exactly) "lt": lower than (number is lower than value) "le": lower or equal (number is lower than or equal to value) "ge": greater or equal (number is higher than or equal to value) "gt": greater than (number is higher than value) "bt": between (number is between two comma separated values)

Query Params

string
In this parameter fieldname needs to be provided with condition and value
to fetch related details.for eg. OrderNo,eq,36541

To fetch Package Details with OrderNo equal to 36541 and PackageNo equal to 2, the following url must be used**[https://xyzcompany.agiliron.net/agiliron/api-40/Package?filter=OrderNo,eq,36541;PackageNo,eq,2&key=xyzkey**
To fetch Package Details with PackageId equal to 12, the following url must be used**[https://xyzcompany.agiliron.net/agiliron/api-40/Package?filter=PackageId,eq,12&key=xyzkey**

List of condition abbrevations to be used:
"cs": contain string (string contains value)
"sw": start with (string starts with value)
"ew": end with (string end with value)
"neq": not equal (string or number should not match)
"eq": equal (string or number matches exactly)
"lt": lower than (number is lower than value)
"le": lower or equal (number is lower than or equal to value)
"ge": greater or equal (number is higher than or equal to value)
"gt": greater than (number is higher than value)
"bt": between (number is between two comma separated values)

Header Params
Accept:	string Response header need to be passed for eg. application/json or application/xml.

Query Auth
key:	string API key needs to be passed in this variable.The option to enter API key will appear when you click on Try it button.This will be the first option in AUTHENTICATION block.Default is SET to 0.

Header Auth
apiKey:	string Dedicated API key needs to be passed in this variable via header.The option to enter API key will appear when you click on Try it button.This will be the second option in AUTHENTICATION block.Default is SET to 0.

{
    "Packages": {
        "Package": {
            "OrderNo": "2037",
            "PackageNo": "8",
            "Length": "20.00",
            "Width": "10.00",
            "Height": "21.00",
            "Weight": "25.00",
            "PackageLineItems": {
                "PackageLineItem": [
                    {
                        "LineItemId": "25",
                        "ProductId": "499",
                        "ProductName": "ECG Electrodes",
                        "ProductCode": "415",
                        "Quantity": "1"
                    },
                    {
                        "LineItemId": "25",
                        "ProductId": "499",
                        "ProductName": "ECG Electrodes",
                        "ProductCode": "415",
                        "Quantity": "1"
                    }
                ]
            }
        },
        "TotalRecords": "1",
        "CurrentPage": "1",
        "TotalPages": "1",
        "PageSize": "50"
    }
}

<Packages>
    <Package>
        <OrderNo>2037</OrderNo>
        <PackageNo>8</PackageNo>
        <Length>20.00</Length>
        <Width>10.00</Width>
        <Height>21.00</Height>
        <Weight>25.00</Weight>
        <PackageLineItems>
            <PackageLineItem>
                <LineItemId>25</LineItemId>
                <ProductId>499</ProductId>
                <ProductName>ECG Electrodes</ProductName>
                <ProductCode>415</ProductCode>
                <Quantity>1</Quantity>
            </PackageLineItem>
            <PackageLineItem>
                <LineItemId>25</LineItemId>
                <ProductId>499</ProductId>
                <ProductName>ECG Electrodes</ProductName>
                <ProductCode>415</ProductCode>
                <Quantity>1</Quantity>
            </PackageLineItem>
        </PackageLineItems>
    </Package>
    <TotalRecords>1</TotalRecords>
    <CurrentPage>1</CurrentPage>
    <TotalPages>1</TotalPages>
    <PageSize>50</PageSize>
</Packages>

Sample Response

WADL

<?xml version="1.0" encoding="utf-8"?>
<application>
   <resources base="https://{yourCompany}.agiliron.net/agiliron/api-40/">
     <resource path="SalesOrder">
       <method name="GET">
         <resource path="{filter}">
         <request>
           <param name="key" type="xsd:string" style="query" required="true"/>
         </request> 
         <response status="200"> 
            <representation mediaType="application/xml" element="yn:ResultSet"/> 
         </response> 
         <response status="400"> 
            <representation mediaType="application/xml" element="ya:Error"/> 
         </response> 
       </method> 
     </resource> 
   </resources>
 </application>