GET api/Customers/{cid}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
cid

integer

Required

Body Parameters

None.

Response Information

Resource Description

CustomerDTO
NameDescriptionTypeAdditional information
Id

integer

None.

JdeNum

string

None.

Name

string

None.

CustomerType

string

None.

CustomerType2

string

None.

CustomerType3

string

None.

SalesTax

decimal number

None.

LicenseNumber

string

None.

Specialty

string

None.

IsPrivate

boolean

None.

Status

string

None.

PrivateCustomerBypass

boolean

None.

DisplayConfirmationModal

boolean

None.

PhoneNum

string

None.

FaxNum

string

None.

CustomerContact

CustomerContactDTO

None.

CustomerContactName

string

None.

Addresses

Collection of AddressDTO

None.

Address

AddressDTO

None.

ShippingAddress

AddressDTO

None.

BillingAddress

AddressDTO

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "JdeNum": "sample string 2",
  "Name": "sample string 3",
  "CustomerType": "sample string 4",
  "CustomerType2": "sample string 5",
  "CustomerType3": "sample string 6",
  "SalesTax": 1.0,
  "LicenseNumber": "sample string 7",
  "Specialty": "sample string 8",
  "IsPrivate": true,
  "Status": "Private",
  "PrivateCustomerBypass": true,
  "DisplayConfirmationModal": true,
  "PhoneNum": "sample string 12",
  "FaxNum": "sample string 13",
  "CustomerContact": {
    "CustomerContactId": 1,
    "Title": "sample string 2",
    "FirstName": "sample string 3",
    "LastName": "sample string 4",
    "Email": "sample string 5",
    "PhoneNumber": "sample string 6"
  },
  "CustomerContactName": "sample string 3 sample string 4",
  "Addresses": [
    {
      "Seq": 1,
      "AddressId": 2,
      "Line1": "sample string 3",
      "Line2": "sample string 4",
      "City": "sample string 5",
      "StateId": 1,
      "StateCode": "sample string 6",
      "ZipCode": "sample string 7",
      "LocationCode": "sample string 8",
      "Contact": "sample string 9",
      "CustomerId": 10,
      "CountryId": 1
    },
    {
      "Seq": 1,
      "AddressId": 2,
      "Line1": "sample string 3",
      "Line2": "sample string 4",
      "City": "sample string 5",
      "StateId": 1,
      "StateCode": "sample string 6",
      "ZipCode": "sample string 7",
      "LocationCode": "sample string 8",
      "Contact": "sample string 9",
      "CustomerId": 10,
      "CountryId": 1
    }
  ],
  "Address": {
    "Seq": 1,
    "AddressId": 2,
    "Line1": "sample string 3",
    "Line2": "sample string 4",
    "City": "sample string 5",
    "StateId": 1,
    "StateCode": "sample string 6",
    "ZipCode": "sample string 7",
    "LocationCode": "sample string 8",
    "Contact": "sample string 9",
    "CustomerId": 10,
    "CountryId": 1
  },
  "ShippingAddress": {
    "Seq": 1,
    "AddressId": 2,
    "Line1": "sample string 3",
    "Line2": "sample string 4",
    "City": "sample string 5",
    "StateId": 1,
    "StateCode": "sample string 6",
    "ZipCode": "sample string 7",
    "LocationCode": "sample string 8",
    "Contact": "sample string 9",
    "CustomerId": 10,
    "CountryId": 1
  },
  "BillingAddress": {
    "Seq": 1,
    "AddressId": 2,
    "Line1": "sample string 3",
    "Line2": "sample string 4",
    "City": "sample string 5",
    "StateId": 1,
    "StateCode": "sample string 6",
    "ZipCode": "sample string 7",
    "LocationCode": "sample string 8",
    "Contact": "sample string 9",
    "CustomerId": 10,
    "CountryId": 1
  }
}

text/html, multipart/form-data, application/zip

Sample:
{"Id":1,"JdeNum":"sample string 2","Name":"sample string 3","CustomerType":"sample string 4","CustomerType2":"sample string 5","CustomerType3":"sample string 6","SalesTax":1.0,"LicenseNumber":"sample string 7","Specialty":"sample string 8","IsPrivate":true,"Status":"Private","PrivateCustomerBypass":true,"DisplayConfirmationModal":true,"PhoneNum":"sample string 12","FaxNum":"sample string 13","CustomerContact":{"CustomerContactId":1,"Title":"sample string 2","FirstName":"sample string 3","LastName":"sample string 4","Email":"sample string 5","PhoneNumber":"sample string 6"},"CustomerContactName":"sample string 3 sample string 4","Addresses":[{"Seq":1,"AddressId":2,"Line1":"sample string 3","Line2":"sample string 4","City":"sample string 5","StateId":1,"StateCode":"sample string 6","ZipCode":"sample string 7","LocationCode":"sample string 8","Contact":"sample string 9","CustomerId":10,"CountryId":1},{"Seq":1,"AddressId":2,"Line1":"sample string 3","Line2":"sample string 4","City":"sample string 5","StateId":1,"StateCode":"sample string 6","ZipCode":"sample string 7","LocationCode":"sample string 8","Contact":"sample string 9","CustomerId":10,"CountryId":1}],"Address":{"Seq":1,"AddressId":2,"Line1":"sample string 3","Line2":"sample string 4","City":"sample string 5","StateId":1,"StateCode":"sample string 6","ZipCode":"sample string 7","LocationCode":"sample string 8","Contact":"sample string 9","CustomerId":10,"CountryId":1},"ShippingAddress":{"Seq":1,"AddressId":2,"Line1":"sample string 3","Line2":"sample string 4","City":"sample string 5","StateId":1,"StateCode":"sample string 6","ZipCode":"sample string 7","LocationCode":"sample string 8","Contact":"sample string 9","CustomerId":10,"CountryId":1},"BillingAddress":{"Seq":1,"AddressId":2,"Line1":"sample string 3","Line2":"sample string 4","City":"sample string 5","StateId":1,"StateCode":"sample string 6","ZipCode":"sample string 7","LocationCode":"sample string 8","Contact":"sample string 9","CustomerId":10,"CountryId":1}}

application/xml, text/xml

Sample:
<CustomerDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DentaCad.DTO">
  <Address>
    <AddressId>2</AddressId>
    <City>sample string 5</City>
    <Contact>sample string 9</Contact>
    <CountryId>1</CountryId>
    <CustomerId>10</CustomerId>
    <Line1>sample string 3</Line1>
    <Line2>sample string 4</Line2>
    <LocationCode>sample string 8</LocationCode>
    <Seq>1</Seq>
    <StateCode>sample string 6</StateCode>
    <StateId>1</StateId>
    <ZipCode>sample string 7</ZipCode>
  </Address>
  <Addresses>
    <AddressDTO>
      <AddressId>2</AddressId>
      <City>sample string 5</City>
      <Contact>sample string 9</Contact>
      <CountryId>1</CountryId>
      <CustomerId>10</CustomerId>
      <Line1>sample string 3</Line1>
      <Line2>sample string 4</Line2>
      <LocationCode>sample string 8</LocationCode>
      <Seq>1</Seq>
      <StateCode>sample string 6</StateCode>
      <StateId>1</StateId>
      <ZipCode>sample string 7</ZipCode>
    </AddressDTO>
    <AddressDTO>
      <AddressId>2</AddressId>
      <City>sample string 5</City>
      <Contact>sample string 9</Contact>
      <CountryId>1</CountryId>
      <CustomerId>10</CustomerId>
      <Line1>sample string 3</Line1>
      <Line2>sample string 4</Line2>
      <LocationCode>sample string 8</LocationCode>
      <Seq>1</Seq>
      <StateCode>sample string 6</StateCode>
      <StateId>1</StateId>
      <ZipCode>sample string 7</ZipCode>
    </AddressDTO>
  </Addresses>
  <BillingAddress>
    <AddressId>2</AddressId>
    <City>sample string 5</City>
    <Contact>sample string 9</Contact>
    <CountryId>1</CountryId>
    <CustomerId>10</CustomerId>
    <Line1>sample string 3</Line1>
    <Line2>sample string 4</Line2>
    <LocationCode>sample string 8</LocationCode>
    <Seq>1</Seq>
    <StateCode>sample string 6</StateCode>
    <StateId>1</StateId>
    <ZipCode>sample string 7</ZipCode>
  </BillingAddress>
  <CustomerContact>
    <CustomerContactId>1</CustomerContactId>
    <Email>sample string 5</Email>
    <FirstName>sample string 3</FirstName>
    <LastName>sample string 4</LastName>
    <PhoneNumber>sample string 6</PhoneNumber>
    <Title>sample string 2</Title>
  </CustomerContact>
  <CustomerType>sample string 4</CustomerType>
  <CustomerType2>sample string 5</CustomerType2>
  <CustomerType3>sample string 6</CustomerType3>
  <DisplayConfirmationModal>true</DisplayConfirmationModal>
  <FaxNum>sample string 13</FaxNum>
  <Id>1</Id>
  <IsPrivate>true</IsPrivate>
  <JdeNum>sample string 2</JdeNum>
  <LicenseNumber>sample string 7</LicenseNumber>
  <Name>sample string 3</Name>
  <PhoneNum>sample string 12</PhoneNum>
  <PrivateCustomerBypass>true</PrivateCustomerBypass>
  <SalesTax>1</SalesTax>
  <ShippingAddress>
    <AddressId>2</AddressId>
    <City>sample string 5</City>
    <Contact>sample string 9</Contact>
    <CountryId>1</CountryId>
    <CustomerId>10</CustomerId>
    <Line1>sample string 3</Line1>
    <Line2>sample string 4</Line2>
    <LocationCode>sample string 8</LocationCode>
    <Seq>1</Seq>
    <StateCode>sample string 6</StateCode>
    <StateId>1</StateId>
    <ZipCode>sample string 7</ZipCode>
  </ShippingAddress>
  <Specialty>sample string 8</Specialty>
</CustomerDTO>