POST v1/Generic/CustomerContactList

Request Information

URI Parameters

None.

Body Parameters

CustomerContactDetailRequest
NameDescriptionTypeAdditional information
CustomerID

integer

None.

ContactID

integer

None.

FirstName

string

None.

MiddleName

string

None.

LastName

string

None.

EmailAddress

string

None.

Active

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "CustomerID": 1,
  "ContactID": 1,
  "FirstName": "sample string 1",
  "MiddleName": "sample string 2",
  "LastName": "sample string 3",
  "EmailAddress": "sample string 4",
  "Active": true
}

application/xml, text/xml

Sample:
<CustomerContactDetailRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CustomerID>1</CustomerID>
  <ContactID>1</ContactID>
  <FirstName>sample string 1</FirstName>
  <MiddleName>sample string 2</MiddleName>
  <LastName>sample string 3</LastName>
  <EmailAddress>sample string 4</EmailAddress>
  <Active>true</Active>
</CustomerContactDetailRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CustomerContactDetailRequest'.

Response Information

Resource Description

Collection of CustomerContactDetailResponse
NameDescriptionTypeAdditional information
Salutation

string

None.

Suffix

string

None.

Title

string

None.

Company

string

None.

ContactTypeId

integer

None.

Address1

string

None.

Address2

string

None.

Address3

string

None.

City

string

None.

StateCode

string

None.

ZipCode

string

None.

CountryCode

string

None.

IsDefault

integer

None.

ContactPhones

Collection of Phone

None.

CustomerID

integer

None.

ContactID

integer

None.

FirstName

string

None.

MiddleName

string

None.

LastName

string

None.

EmailAddress

string

None.

Active

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Salutation": "sample string 1",
    "Suffix": "sample string 2",
    "Title": "sample string 3",
    "Company": "sample string 4",
    "ContactTypeId": 5,
    "Address1": "sample string 6",
    "Address2": "sample string 7",
    "Address3": "sample string 8",
    "City": "sample string 9",
    "StateCode": "sample string 10",
    "ZipCode": "sample string 11",
    "CountryCode": "sample string 12",
    "IsDefault": 13,
    "ContactPhones": [
      {
        "PhoneNumber": "sample string 2",
        "Extension": "sample string 3",
        "PhoneTypeId": 4,
        "Primary": true
      },
      {
        "PhoneNumber": "sample string 2",
        "Extension": "sample string 3",
        "PhoneTypeId": 4,
        "Primary": true
      }
    ],
    "CustomerID": 1,
    "ContactID": 1,
    "FirstName": "sample string 14",
    "MiddleName": "sample string 15",
    "LastName": "sample string 16",
    "EmailAddress": "sample string 17",
    "Active": true
  },
  {
    "Salutation": "sample string 1",
    "Suffix": "sample string 2",
    "Title": "sample string 3",
    "Company": "sample string 4",
    "ContactTypeId": 5,
    "Address1": "sample string 6",
    "Address2": "sample string 7",
    "Address3": "sample string 8",
    "City": "sample string 9",
    "StateCode": "sample string 10",
    "ZipCode": "sample string 11",
    "CountryCode": "sample string 12",
    "IsDefault": 13,
    "ContactPhones": [
      {
        "PhoneNumber": "sample string 2",
        "Extension": "sample string 3",
        "PhoneTypeId": 4,
        "Primary": true
      },
      {
        "PhoneNumber": "sample string 2",
        "Extension": "sample string 3",
        "PhoneTypeId": 4,
        "Primary": true
      }
    ],
    "CustomerID": 1,
    "ContactID": 1,
    "FirstName": "sample string 14",
    "MiddleName": "sample string 15",
    "LastName": "sample string 16",
    "EmailAddress": "sample string 17",
    "Active": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfCustomerContactDetailResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CustomerContactDetailResponse>
    <CustomerID>1</CustomerID>
    <ContactID>1</ContactID>
    <FirstName>sample string 14</FirstName>
    <MiddleName>sample string 15</MiddleName>
    <LastName>sample string 16</LastName>
    <EmailAddress>sample string 17</EmailAddress>
    <Active>true</Active>
    <Salutation>sample string 1</Salutation>
    <Suffix>sample string 2</Suffix>
    <Title>sample string 3</Title>
    <Company>sample string 4</Company>
    <ContactTypeId>5</ContactTypeId>
    <Address1>sample string 6</Address1>
    <Address2>sample string 7</Address2>
    <Address3>sample string 8</Address3>
    <City>sample string 9</City>
    <StateCode>sample string 10</StateCode>
    <ZipCode>sample string 11</ZipCode>
    <CountryCode>sample string 12</CountryCode>
    <IsDefault>13</IsDefault>
    <ContactPhones>
      <Phone>
        <PhoneId>1</PhoneId>
        <PhoneNumber>sample string 2</PhoneNumber>
        <Extension>sample string 3</Extension>
        <PhoneTypeId>4</PhoneTypeId>
        <Active>true</Active>
        <Primary>true</Primary>
        <OwnerId>7</OwnerId>
        <Owner>sample string 8</Owner>
        <Remove>true</Remove>
      </Phone>
      <Phone>
        <PhoneId>1</PhoneId>
        <PhoneNumber>sample string 2</PhoneNumber>
        <Extension>sample string 3</Extension>
        <PhoneTypeId>4</PhoneTypeId>
        <Active>true</Active>
        <Primary>true</Primary>
        <OwnerId>7</OwnerId>
        <Owner>sample string 8</Owner>
        <Remove>true</Remove>
      </Phone>
    </ContactPhones>
  </CustomerContactDetailResponse>
  <CustomerContactDetailResponse>
    <CustomerID>1</CustomerID>
    <ContactID>1</ContactID>
    <FirstName>sample string 14</FirstName>
    <MiddleName>sample string 15</MiddleName>
    <LastName>sample string 16</LastName>
    <EmailAddress>sample string 17</EmailAddress>
    <Active>true</Active>
    <Salutation>sample string 1</Salutation>
    <Suffix>sample string 2</Suffix>
    <Title>sample string 3</Title>
    <Company>sample string 4</Company>
    <ContactTypeId>5</ContactTypeId>
    <Address1>sample string 6</Address1>
    <Address2>sample string 7</Address2>
    <Address3>sample string 8</Address3>
    <City>sample string 9</City>
    <StateCode>sample string 10</StateCode>
    <ZipCode>sample string 11</ZipCode>
    <CountryCode>sample string 12</CountryCode>
    <IsDefault>13</IsDefault>
    <ContactPhones>
      <Phone>
        <PhoneId>1</PhoneId>
        <PhoneNumber>sample string 2</PhoneNumber>
        <Extension>sample string 3</Extension>
        <PhoneTypeId>4</PhoneTypeId>
        <Active>true</Active>
        <Primary>true</Primary>
        <OwnerId>7</OwnerId>
        <Owner>sample string 8</Owner>
        <Remove>true</Remove>
      </Phone>
      <Phone>
        <PhoneId>1</PhoneId>
        <PhoneNumber>sample string 2</PhoneNumber>
        <Extension>sample string 3</Extension>
        <PhoneTypeId>4</PhoneTypeId>
        <Active>true</Active>
        <Primary>true</Primary>
        <OwnerId>7</OwnerId>
        <Owner>sample string 8</Owner>
        <Remove>true</Remove>
      </Phone>
    </ContactPhones>
  </CustomerContactDetailResponse>
</ArrayOfCustomerContactDetailResponse>