GET api/CommonLocations?User={User}&Pass={Pass}&Code={Code}&Context={Context}

Use this function to retrieve a list of Common Consignees for a Shipper, or Common Shippers for a Consignee.

Request Information

URI Parameters

Name	Description	Type	Additional information
User	Enter the Logon Code assigned to your account (1-8 characters)	string	Required
Pass	Enter the Password associated with your Logon Code	string	Required
Code	Enter the Location Code from which you want to search for Common Locations	string	Required
Context	Enter 'S' to indicate that 'Code' represents a Shipper searching for Consignees, or 'C' to represent a Consignee searching for Shippers	string	Required

Body Parameters

None.

Response Information

Resource Description

an XML or JSON representation of the Accessorial list.

CommonLocations

Name	Description	Type	Additional information
Errorinfo	Blank if no errors were encountered, otherwise contains a description of the issues at hand.	string	None.
Code	Supply the alphanumeric code of the Shipper (or Consignee) (1-8 alphanumeric characters)	string	None.
Context	Supply the context for the Code submitted: S=Shipper or C=Consignee. Submitting a Shipper code will return a list of Consignees common to that Shipper; Conversely, submitting a Consignee code will return a list of Shippers common to that Consignee	string	None.
Common	Returns a list of locations in common with the location code and context provided	Collection of NameAddr	None.

Response Formats

application/json, text/json

Sample:

{
  "Errorinfo": "sample string 1",
  "Code": "sample string 2",
  "Context": "sample string 3",
  "Common": [
    {
      "Code": "sample string 1",
      "Name": "sample string 2",
      "Address1": "sample string 3",
      "Address2": "sample string 4",
      "Address3": "sample string 5",
      "City": "sample string 6",
      "State": "sample string 7",
      "Zip": "sample string 8",
      "ContactList": [
        {
          "FirstName": "sample string 1",
          "LastName": "sample string 2",
          "Phone": "sample string 3",
          "Fax": "sample string 4",
          "Email": "sample string 5",
          "bShipper": true,
          "bConsignee": true,
          "bBillTo": true,
          "beBilling": true
        },
        {
          "FirstName": "sample string 1",
          "LastName": "sample string 2",
          "Phone": "sample string 3",
          "Fax": "sample string 4",
          "Email": "sample string 5",
          "bShipper": true,
          "bConsignee": true,
          "bBillTo": true,
          "beBilling": true
        }
      ]
    },
    {
      "Code": "sample string 1",
      "Name": "sample string 2",
      "Address1": "sample string 3",
      "Address2": "sample string 4",
      "Address3": "sample string 5",
      "City": "sample string 6",
      "State": "sample string 7",
      "Zip": "sample string 8",
      "ContactList": [
        {
          "FirstName": "sample string 1",
          "LastName": "sample string 2",
          "Phone": "sample string 3",
          "Fax": "sample string 4",
          "Email": "sample string 5",
          "bShipper": true,
          "bConsignee": true,
          "bBillTo": true,
          "beBilling": true
        },
        {
          "FirstName": "sample string 1",
          "LastName": "sample string 2",
          "Phone": "sample string 3",
          "Fax": "sample string 4",
          "Email": "sample string 5",
          "bShipper": true,
          "bConsignee": true,
          "bBillTo": true,
          "beBilling": true
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<CommonLocations xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RudeWebAPI">
  <Code>sample string 2</Code>
  <Common>
    <NameAddr>
      <Address1>sample string 3</Address1>
      <Address2>sample string 4</Address2>
      <Address3>sample string 5</Address3>
      <City>sample string 6</City>
      <Code>sample string 1</Code>
      <ContactList>
        <Contact>
          <Email>sample string 5</Email>
          <Fax>sample string 4</Fax>
          <FirstName>sample string 1</FirstName>
          <LastName>sample string 2</LastName>
          <Phone>sample string 3</Phone>
          <bBillTo>true</bBillTo>
          <bConsignee>true</bConsignee>
          <bShipper>true</bShipper>
          <beBilling>true</beBilling>
        </Contact>
        <Contact>
          <Email>sample string 5</Email>
          <Fax>sample string 4</Fax>
          <FirstName>sample string 1</FirstName>
          <LastName>sample string 2</LastName>
          <Phone>sample string 3</Phone>
          <bBillTo>true</bBillTo>
          <bConsignee>true</bConsignee>
          <bShipper>true</bShipper>
          <beBilling>true</beBilling>
        </Contact>
      </ContactList>
      <Name>sample string 2</Name>
      <State>sample string 7</State>
      <Zip>sample string 8</Zip>
    </NameAddr>
    <NameAddr>
      <Address1>sample string 3</Address1>
      <Address2>sample string 4</Address2>
      <Address3>sample string 5</Address3>
      <City>sample string 6</City>
      <Code>sample string 1</Code>
      <ContactList>
        <Contact>
          <Email>sample string 5</Email>
          <Fax>sample string 4</Fax>
          <FirstName>sample string 1</FirstName>
          <LastName>sample string 2</LastName>
          <Phone>sample string 3</Phone>
          <bBillTo>true</bBillTo>
          <bConsignee>true</bConsignee>
          <bShipper>true</bShipper>
          <beBilling>true</beBilling>
        </Contact>
        <Contact>
          <Email>sample string 5</Email>
          <Fax>sample string 4</Fax>
          <FirstName>sample string 1</FirstName>
          <LastName>sample string 2</LastName>
          <Phone>sample string 3</Phone>
          <bBillTo>true</bBillTo>
          <bConsignee>true</bConsignee>
          <bShipper>true</bShipper>
          <beBilling>true</beBilling>
        </Contact>
      </ContactList>
      <Name>sample string 2</Name>
      <State>sample string 7</State>
      <Zip>sample string 8</Zip>
    </NameAddr>
  </Common>
  <Context>sample string 3</Context>
  <Errorinfo>sample string 1</Errorinfo>
</CommonLocations>