Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation
Guide That Contains This Content
[+] Expand All
[-] Collapse All

    Get End Customer Address Groups by ID

    Use this API to retrieve the address group of an end-customer.

    Note: This service is available only when Service Now is running in Proxy mode.

    URI

    https://[host]/api/juniper/servicenow/address-group-management/endCustomerAddressGroups /{id} (HTTP method = GET)

    URI Parameters

    Parameter

    Type

    Required

    Description

    id

    Integer

    Yes

    ID of the address group for which information is to be retireved

    Consumes

    None

    Produces

    • application/vnd.juniper.servicenow.address-group-management.endcustomeraddressgroup +xml;version=1
    • application/vnd.juniper.servicenow.address-group-management.endcustomeraddressgroup +json;version=1

    Response Elements

    Element

    Type

    Description

    uri

    String

    URI of the address group

    id

    Integer

    ID of the address group

    name

    String

    Name of the location, such as the business name

    address1 and address2

    String

    Address, such as street number and street name, to be associated with the device

    city, state and zipCode

    String

    City, State and Zip Code of the location

    contactName

    String

    Name of contact associated with this address group

    connectedMember

    String

    End customer associated with the address group

    devices

    device

    Collection of devices with which the address group is associated

    href

    String

    Link to the collection of devices

    size

    Integer

    Number of devices in the collection

    device

    device

    A device in the collection

    href

    String

    Link to the device

    key

    Integer

    ID of the device

    hostName

    String

    Hostname of device associated with this address group

    serialNumber

    String

    Serial number of device associated with this address group

    platform

    String

    Platform of device associated with this address group

    Sample Output

    Sample XML Output

    <endCustomerAddressGroup uri="/api/juniper/servicenow/address-group-management/endCustomerAddressGroups /20000002">
      <id>20000002</id>
      <name>ECAddressGroup</name>
      <address1>Plot No. 66</address1>    
      <address2>Bagmane Tech Park</address2>
      <city>Bangalore</city>
      <state>Karnataka</state>
      <country>India</country>
      <contactName>Biru</contactName>
      <zipCode>5600879</zipCode>
      <connectedMember>VijaySystem</connectedMember>
      <devices size="3" href="/api/juniper/servicenow/device-management/devices">
        <device key="1867778" href="/api/juniper/servicenow/device-management/devices/1867778">
          <hostName>srx650_191</hostName>
          <serialNumber>AJ4410AA0031</serialNumber>
          <platform>junos-es</platform>
        </device>
        <device key="1671208" href="/api/juniper/servicenow/device-management/devices/1671208">
          <hostName>EX4200.24T.180</hostName>
          <serialNumber>BM0210435717</serialNumber>
          <platform>junos-ex</platform>
        </device>
        <device key="1671197" href="/api/juniper/servicenow/device-management/devices/1671197">
          <hostName>ex-4200.50.182</hostName>
          <serialNumber>BM0210435487</serialNumber>
          <platform>junos-ex</platform>
        </device>
      </devices>
    </ endCustomerAddressGroup>
    

    Sample JSON Output

    {
      "endCustomerAddressGroup": {
        "@uri": "/api/juniper/servicenow/address-group-management/endCustomerAddressGroups /20000002",
        "id": 20000002,
        "name": "ECAddressGroup",
         "address1": " Plot No. 66",
         "address2": "Bagmane Tech Park",
        "city": "Bangalore",
        "state": "Karnataka",
        "country": "India",
        "contactName": "Biru",
        "zipCode": 5600879,
        "connectedMember": "VijaySystem",
        "devices": {
          "@size": "3",
          "@href": "/api/juniper/servicenow/device-management/devices",
          "device": [
            {
              "@key": "1867778",
              "@href": "/api/juniper/servicenow/device-management/devices/1867778",
              "hostName": "srx650_191",
              "serialNumber": "AJ4410AA0031",
              "platform": "junos-es"
            },
            {
              "@key": "1671208",
              "@href": "/api/juniper/servicenow/device-management/devices/1671208",
              "hostName": "EX4200.24T.180",
              "serialNumber": "BM0210435717",
              "platform": "junos-ex"
            },
            {
              "@key": "1671197",
              "@href": "/api/juniper/servicenow/device-management/devices/1671197",
              "hostName": "ex-4200.50.182",
              "serialNumber": "BM0210435487",
              "platform": "junos-ex"
            }
          ]
        }
      }
    }
    

    Response Status Code

    Message

    Description

    404 Not Found

    Invalid address group ID.

    403 Forbidden

    Service Now is not running in Proxy mode.

    Modified: 2016-08-11