GET papi/v1/locationoutbound/LocationInfo?level={level}

Security

Secured API

Request Information

URI Parameters

Name	Description	Type	Additional information
level		string	Default value is

Required Headers

Name	Description	Sample	Type	Default
Authorization	Represents the value of the authentication token. Allow multiple values: no.	Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ...	string	None
ConsumerId	Represents the value of the consumer id. Allow multiple values: no.	2426	integer	None

Optional Headers

Name	Description	Sample	Type	Default
ApplicationType	Represents the value of the consumer's application type. Allow multiple values: no.	1	ApplicationType	None
Accept-Language	Represents the value of the desired language for translations. Allow multiple values: yes.	es	string	en-US

Body Parameters

None.

Response Information

Resource Description

Collection of LocationDetails

Name	Type	Additional information
ImmediateLevelID	Collection of integer	None.
LocationId	integer	None.
LocationName	string	None.
LocationCode	string	None.
CompanyCode	string	None.
Address	string	None.
Country	string	None.
State_Province	string	None.
City	string	None.
County	string	None.
Postal_Zip	string	None.
LocationStatus	string	None.
BusinessType	string	None.
OperationType	string	None.
IndustryDescription	string	None.
Comments	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ImmediateLevelID": [
      1,
      2
    ],
    "LocationId": 1,
    "LocationName": "sample string 2",
    "LocationCode": "sample string 3",
    "CompanyCode": "sample string 4",
    "Address": "sample string 5",
    "Country": "sample string 6",
    "State_Province": "sample string 7",
    "City": "sample string 8",
    "County": "sample string 9",
    "Postal_Zip": "sample string 10",
    "LocationStatus": "sample string 11",
    "BusinessType": "sample string 12",
    "OperationType": "sample string 13",
    "IndustryDescription": "sample string 14",
    "Comments": "sample string 15"
  },
  {
    "ImmediateLevelID": [
      1,
      2
    ],
    "LocationId": 1,
    "LocationName": "sample string 2",
    "LocationCode": "sample string 3",
    "CompanyCode": "sample string 4",
    "Address": "sample string 5",
    "Country": "sample string 6",
    "State_Province": "sample string 7",
    "City": "sample string 8",
    "County": "sample string 9",
    "Postal_Zip": "sample string 10",
    "LocationStatus": "sample string 11",
    "BusinessType": "sample string 12",
    "OperationType": "sample string 13",
    "IndustryDescription": "sample string 14",
    "Comments": "sample string 15"
  }
]

application/xml, text/xml

Sample:

<ArrayOfLocationDetails xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <LocationDetails>
    <ImmediateLevelId>
      <int>1</int>
      <int>2</int>
    </ImmediateLevelId>
    <Id>1</Id>
    <Name>sample string 2</Name>
    <Code>sample string 3</Code>
    <CompanyCode>sample string 4</CompanyCode>
    <Address>sample string 5</Address>
    <Country>sample string 6</Country>
    <State>sample string 7</State>
    <City>sample string 8</City>
    <County>sample string 9</County>
    <PostalCode>sample string 10</PostalCode>
    <LocationStatus>sample string 11</LocationStatus>
    <BusinessType>sample string 12</BusinessType>
    <OperationType>sample string 13</OperationType>
    <IndustryDescription>sample string 14</IndustryDescription>
    <Comments>sample string 15</Comments>
  </LocationDetails>
  <LocationDetails>
    <ImmediateLevelId>
      <int>1</int>
      <int>2</int>
    </ImmediateLevelId>
    <Id>1</Id>
    <Name>sample string 2</Name>
    <Code>sample string 3</Code>
    <CompanyCode>sample string 4</CompanyCode>
    <Address>sample string 5</Address>
    <Country>sample string 6</Country>
    <State>sample string 7</State>
    <City>sample string 8</City>
    <County>sample string 9</County>
    <PostalCode>sample string 10</PostalCode>
    <LocationStatus>sample string 11</LocationStatus>
    <BusinessType>sample string 12</BusinessType>
    <OperationType>sample string 13</OperationType>
    <IndustryDescription>sample string 14</IndustryDescription>
    <Comments>sample string 15</Comments>
  </LocationDetails>
</ArrayOfLocationDetails>