GET v1/company-locations

Gets list of company locations

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

SearchResultOfCompanyLocationSearchResult
NameDescriptionTypeAdditional information
TotalCount

integer

None.

Data

Collection of CompanyLocationSearchResult

None.

Response Formats

application/json, text/json

Sample:
{
  "totalCount": 1,
  "data": [
    {
      "phones": [
        {
          "id": 1,
          "phoneType": {
            "id": 1,
            "name": "sample string 2"
          },
          "countryDialCode": 2,
          "number": "sample string 3",
          "extension": "sample string 4",
          "isPreferred": true,
          "active": true
        },
        {
          "id": 1,
          "phoneType": {
            "id": 1,
            "name": "sample string 2"
          },
          "countryDialCode": 2,
          "number": "sample string 3",
          "extension": "sample string 4",
          "isPreferred": true,
          "active": true
        }
      ],
      "id": 1,
      "name": "sample string 2",
      "isPrimary": true,
      "address": {
        "address1": "sample string 1",
        "address2": "sample string 2",
        "address3": "sample string 3",
        "city": "sample string 4",
        "state": "sample string 5",
        "postalCode": "sample string 6",
        "country": "sample string 7",
        "latitude": 8.0,
        "longitude": 9.0,
        "fullAddress": "sample string 10"
      }
    },
    {
      "phones": [
        {
          "id": 1,
          "phoneType": {
            "id": 1,
            "name": "sample string 2"
          },
          "countryDialCode": 2,
          "number": "sample string 3",
          "extension": "sample string 4",
          "isPreferred": true,
          "active": true
        },
        {
          "id": 1,
          "phoneType": {
            "id": 1,
            "name": "sample string 2"
          },
          "countryDialCode": 2,
          "number": "sample string 3",
          "extension": "sample string 4",
          "isPreferred": true,
          "active": true
        }
      ],
      "id": 1,
      "name": "sample string 2",
      "isPrimary": true,
      "address": {
        "address1": "sample string 1",
        "address2": "sample string 2",
        "address3": "sample string 3",
        "city": "sample string 4",
        "state": "sample string 5",
        "postalCode": "sample string 6",
        "country": "sample string 7",
        "latitude": 8.0,
        "longitude": 9.0,
        "fullAddress": "sample string 10"
      }
    }
  ]
}

application/xml, text/xml

Sample:
<SearchResultOfCompanyLocationSearchResult3KdDVibf xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models.Core">
    <d2p1:CompanyLocationSearchResult>
      <d2p1:Address>
        <d2p1:Address1>sample string 1</d2p1:Address1>
        <d2p1:Address2>sample string 2</d2p1:Address2>
        <d2p1:Address3>sample string 3</d2p1:Address3>
        <d2p1:City>sample string 4</d2p1:City>
        <d2p1:Country>sample string 7</d2p1:Country>
        <d2p1:FullAddress>sample string 10</d2p1:FullAddress>
        <d2p1:Latitude>8</d2p1:Latitude>
        <d2p1:Longitude>9</d2p1:Longitude>
        <d2p1:PostalCode>sample string 6</d2p1:PostalCode>
        <d2p1:State>sample string 5</d2p1:State>
      </d2p1:Address>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsPrimary>true</d2p1:IsPrimary>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Phones>
        <d2p1:Phone>
          <d2p1:Active>true</d2p1:Active>
          <d2p1:CountryDialCode>2</d2p1:CountryDialCode>
          <d2p1:Extension>sample string 4</d2p1:Extension>
          <d2p1:Id>1</d2p1:Id>
          <d2p1:IsPreferred>true</d2p1:IsPreferred>
          <d2p1:Number>sample string 3</d2p1:Number>
          <d2p1:PhoneType xmlns:d6p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
            <d6p1:_x003C_Id_x003E_k__BackingField>1</d6p1:_x003C_Id_x003E_k__BackingField>
            <d6p1:_x003C_Name_x003E_k__BackingField>sample string 2</d6p1:_x003C_Name_x003E_k__BackingField>
          </d2p1:PhoneType>
        </d2p1:Phone>
        <d2p1:Phone>
          <d2p1:Active>true</d2p1:Active>
          <d2p1:CountryDialCode>2</d2p1:CountryDialCode>
          <d2p1:Extension>sample string 4</d2p1:Extension>
          <d2p1:Id>1</d2p1:Id>
          <d2p1:IsPreferred>true</d2p1:IsPreferred>
          <d2p1:Number>sample string 3</d2p1:Number>
          <d2p1:PhoneType xmlns:d6p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
            <d6p1:_x003C_Id_x003E_k__BackingField>1</d6p1:_x003C_Id_x003E_k__BackingField>
            <d6p1:_x003C_Name_x003E_k__BackingField>sample string 2</d6p1:_x003C_Name_x003E_k__BackingField>
          </d2p1:PhoneType>
        </d2p1:Phone>
      </d2p1:Phones>
    </d2p1:CompanyLocationSearchResult>
    <d2p1:CompanyLocationSearchResult>
      <d2p1:Address>
        <d2p1:Address1>sample string 1</d2p1:Address1>
        <d2p1:Address2>sample string 2</d2p1:Address2>
        <d2p1:Address3>sample string 3</d2p1:Address3>
        <d2p1:City>sample string 4</d2p1:City>
        <d2p1:Country>sample string 7</d2p1:Country>
        <d2p1:FullAddress>sample string 10</d2p1:FullAddress>
        <d2p1:Latitude>8</d2p1:Latitude>
        <d2p1:Longitude>9</d2p1:Longitude>
        <d2p1:PostalCode>sample string 6</d2p1:PostalCode>
        <d2p1:State>sample string 5</d2p1:State>
      </d2p1:Address>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsPrimary>true</d2p1:IsPrimary>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Phones>
        <d2p1:Phone>
          <d2p1:Active>true</d2p1:Active>
          <d2p1:CountryDialCode>2</d2p1:CountryDialCode>
          <d2p1:Extension>sample string 4</d2p1:Extension>
          <d2p1:Id>1</d2p1:Id>
          <d2p1:IsPreferred>true</d2p1:IsPreferred>
          <d2p1:Number>sample string 3</d2p1:Number>
          <d2p1:PhoneType xmlns:d6p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
            <d6p1:_x003C_Id_x003E_k__BackingField>1</d6p1:_x003C_Id_x003E_k__BackingField>
            <d6p1:_x003C_Name_x003E_k__BackingField>sample string 2</d6p1:_x003C_Name_x003E_k__BackingField>
          </d2p1:PhoneType>
        </d2p1:Phone>
        <d2p1:Phone>
          <d2p1:Active>true</d2p1:Active>
          <d2p1:CountryDialCode>2</d2p1:CountryDialCode>
          <d2p1:Extension>sample string 4</d2p1:Extension>
          <d2p1:Id>1</d2p1:Id>
          <d2p1:IsPreferred>true</d2p1:IsPreferred>
          <d2p1:Number>sample string 3</d2p1:Number>
          <d2p1:PhoneType xmlns:d6p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
            <d6p1:_x003C_Id_x003E_k__BackingField>1</d6p1:_x003C_Id_x003E_k__BackingField>
            <d6p1:_x003C_Name_x003E_k__BackingField>sample string 2</d6p1:_x003C_Name_x003E_k__BackingField>
          </d2p1:PhoneType>
        </d2p1:Phone>
      </d2p1:Phones>
    </d2p1:CompanyLocationSearchResult>
  </Data>
  <TotalCount>1</TotalCount>
</SearchResultOfCompanyLocationSearchResult3KdDVibf>