GET v1/Customers

Retrieves a list of all customers who are children of the requesting user's customer. Note that this will only retrieve immediate descendants and not the full depth tree.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Lhp.EquipmentIntelligence.WebApi.Models.V1.CustomerModel
NameDescriptionTypeAdditional information
CustomerId

Unique identifier for the Customer.

 integer

None.
ParentCustomerId

Unique identifier of the parent of this customer.

 integer

None.
CustomerTypeId

Identifies the type of customer account.

 integer

None.
Name

Name of the customer.

 string

None.
AddressStreet

Street address of the customer.

 string

None.
AddressCity

City for the customer.

 string

None.
AddressStateId

ID of the state. Use two letter postal state abbreviations.

 string

None.
AddressStateProvince

State province of the customer.

 string

None.
AddressPostalCode

Postal code of the customer.

 string

None.
AddressCountryId

ID of the country by postal country code.

 string

None.
MainContactName

Name of the primary contact at the customer.

 string

None.
MainContactPhone

Primary phone number to use when contacting the customer.

 string

None.
MainContactFax

Primary FAX number to use when contacting the customer.

 string

None.
MainContactEmail

Primary email to use when contacting the customer.

 string

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "CustomerId": 1,
    "ParentCustomerId": 2,
    "CustomerTypeId": 3,
    "Name": "sample string 4",
    "AddressStreet": "sample string 5",
    "AddressCity": "sample string 6",
    "AddressStateId": "sample string 7",
    "AddressStateProvince": "sample string 8",
    "AddressPostalCode": "sample string 9",
    "AddressCountryId": "sample string 10",
    "MainContactName": "sample string 11",
    "MainContactPhone": "sample string 12",
    "MainContactFax": "sample string 13",
    "MainContactEmail": "sample string 14"
  },
  {
    "CustomerId": 1,
    "ParentCustomerId": 2,
    "CustomerTypeId": 3,
    "Name": "sample string 4",
    "AddressStreet": "sample string 5",
    "AddressCity": "sample string 6",
    "AddressStateId": "sample string 7",
    "AddressStateProvince": "sample string 8",
    "AddressPostalCode": "sample string 9",
    "AddressCountryId": "sample string 10",
    "MainContactName": "sample string 11",
    "MainContactPhone": "sample string 12",
    "MainContactFax": "sample string 13",
    "MainContactEmail": "sample string 14"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfCustomerModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CustomerModel>
    <CustomerId>1</CustomerId>
    <ParentCustomerId>2</ParentCustomerId>
    <CustomerTypeId>3</CustomerTypeId>
    <Name>sample string 4</Name>
    <AddressStreet>sample string 5</AddressStreet>
    <AddressCity>sample string 6</AddressCity>
    <AddressStateId>sample string 7</AddressStateId>
    <AddressStateProvince>sample string 8</AddressStateProvince>
    <AddressPostalCode>sample string 9</AddressPostalCode>
    <AddressCountryId>sample string 10</AddressCountryId>
    <MainContactName>sample string 11</MainContactName>
    <MainContactPhone>sample string 12</MainContactPhone>
    <MainContactFax>sample string 13</MainContactFax>
    <MainContactEmail>sample string 14</MainContactEmail>
  </CustomerModel>
  <CustomerModel>
    <CustomerId>1</CustomerId>
    <ParentCustomerId>2</ParentCustomerId>
    <CustomerTypeId>3</CustomerTypeId>
    <Name>sample string 4</Name>
    <AddressStreet>sample string 5</AddressStreet>
    <AddressCity>sample string 6</AddressCity>
    <AddressStateId>sample string 7</AddressStateId>
    <AddressStateProvince>sample string 8</AddressStateProvince>
    <AddressPostalCode>sample string 9</AddressPostalCode>
    <AddressCountryId>sample string 10</AddressCountryId>
    <MainContactName>sample string 11</MainContactName>
    <MainContactPhone>sample string 12</MainContactPhone>
    <MainContactFax>sample string 13</MainContactFax>
    <MainContactEmail>sample string 14</MainContactEmail>
  </CustomerModel>
</ArrayOfCustomerModel>