GET v2/Customers/Name/{name}

Retrieves a customer by name. The name must be an exact match to a customer account within the lineage of the requester.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
name

The customer name

 string

Required

Body Parameters

None.

Response Information

Resource Description

Lhp.EquipmentIntelligence.WebApi.Client.Models.Customer
NameDescriptionTypeAdditional information
CustomerId

The customer ID

 integer

None.
ParentCustomerId

The parent customer ID

 integer

None.
CustomerTypeId

The customer type

 integer

None.
Name

The customer name

 string

None.
AddressStreet

Gets or sets the address street.

 string

None.
AddressCity

Gets or sets the address city.

 string

None.
AddressStateId

Gets or sets the address state identifier.

 string

None.
AddressStateProvince

Gets or sets the address state province.

 string

None.
AddressPostalCode

Gets or sets the address postal code.

 string

None.
AddressCountryId

Gets or sets the address country identifier.

 string

None.
MainContactName

Gets or sets the name of the main contact.

 string

None.
MainContactPhone

Gets or sets the main contact phone.

 string

None.
MainContactFax

Gets or sets the main contact fax.

 string

None.
MainContactEmail

Gets or sets the main contact email.

 string

None.
ExternalReferenceKey

Reference key used by external agency to identify the customer.

 string

None.

Response Formats

application/json, text/json

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

application/xml, text/xml

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