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 All End Customer Address Groups

    Use this API to retrieve address groups associted with end customers.

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

    URI

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

    Consumes

    None

    Produces

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

    Response Elements

    Element

    Type

    Description

    uri

    String

    URI of the collection of address groups associated with end customers

    size

    Integer

    Number of address groups in the collection

    endCustomerAddressGroup

    endCustomerAddressGroup

    An address grou associated with end customers

    uri

    String

    URI of the address group

    href

    String

    Link to the address group

    key

    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

    Sample Output

    Sample XML Output

    <endCustomerAddressGroup size="2" uri="/api/juniper/servicenow/address-group-management/endCustomerAddressGroups">
      <endCustomerAddressGroup key="20000002" uri="/api/juniper/servicenow/address-group-management/endCustomerAddressGroups /20000002" href="/api/juniper/servicenow/address-group-management/endCustomerAddressGroups /20000002">
        <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>
      </endCustomerAddressGroup>
      <endCustomerAddressGroup key="20000003" uri="/api/juniper/servicenow/address-group-management/endCustomerAddressGroups /20000003" href="/api/juniper/servicenow/address-group-management/endCustomerAddressGroups /20000003">
        <name>ECAddressGroup1</name>
        <address>Pandu</address>
        <city>Guwahati</city>
        <state>Assam</state>
        <country>India</country>
        <contactName>Debu</contactName>
        <contactPhone>9886478512</contactPhone>
        <zipCode>781012</zipCode>
        <connectedMember>VijaySystem</connectedMember>
      </endCustomerAddressGroup>
    </ endCustomerAddressGroups>
    

    Sample JSON Output

    {
      " endCustomerAddressGroups": {
        "@size": "2",
        "@uri": "/api/juniper/servicenow/address-group-management/endCustomerAddressGroups",
        " endCustomerAddressGroup": [
          {
            "@key": "20000002",
            "@uri": "/api/juniper/servicenow/address-group-management/endCustomerAddressGroups /20000002",
            "@href": "/api/juniper/servicenow/address-group-management/endCustomerAddressGroups /20000002",
            "name": "ECAddressGroup",
            "address1": " Plot No. 66",
            "address2": "Bagmane Tech Park",
            "city": "Bangalore",
            "state": "Karnataka",
            "country": "India",
            "contactName": "Biru",
            "zipCode": 5600879,
            "connectedMember": "VijaySystem"
          },
          {
            "@key": "20000003",
            "@uri": "/api/juniper/servicenow/address-group-management/endCustomerAddressGroups /20000003",
            "@href": "/api/juniper/servicenow/address-group-management/endCustomerAddressGroups /20000003",
            "name": "ECAddressGroup1",
            "address": "Pandu",
            "city": "Guwahati",
            "state": "Assam",
            "country": "India",
            "contactName": "Debu",
            "contactPhone": 9886478512,
            "zipCode": 781012,
            "connectedMember": "VijaySystem"
          }
        ]
      }
    }
    

    Response Status Code

    Message

    Description

    204 No Content

    No end-customer address groups found.

    403 Forbidden

    Service Now is not running in Partner Proxy mode.

    Modified: 2016-08-10