GET api/customercontact/{id}/{option}

Returns a set of Customer Contact records based on the option parameter. The id parameter may or may not be used. Possible values for the option parameter are: 'ByCustomerId' - all billing records for Customer where id = customerId, ...

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required
option		string	Required

Body Parameters

None.

Response Information

Resource Description

CustomerContact

Name	Description	Type	Additional information
CustomerContactId	Autonumber from AR_Customer_Contact	integer	None.
CustomerId	foreign key from AR_Customer	integer	Required
CustomerBillId	foreign key from AR_Customer_Bill (pass in to designate this as Bill Contact)	integer	None.
BillContactId	view only; do not set explicitly	integer	None.
CustomerSiteId	foreign key from AR_Customer_Site (pass in to designate this as Site Contact)	integer	None.
SiteContactId	view only; do not set explicitly	integer	None.
ContactName	If a person, usually First/Middle/Last concatenated	string	Required String length: inclusive between 0 and 255
Salutation		string	String length: inclusive between 0 and 10
FirstName		string	String length: inclusive between 0 and 50
MiddleName		string	String length: inclusive between 0 and 50
LastName		string	String length: inclusive between 0 and 50
Suffix		string	String length: inclusive between 0 and 10
Title		string	String length: inclusive between 0 and 50
Phone		string	String length: inclusive between 0 and 25
Extension		string	String length: inclusive between 0 and 5
Fax		string	String length: inclusive between 0 and 25
Pager		string	String length: inclusive between 0 and 25
EMail		string	String length: inclusive between 0 and 50
AllSites		boolean	None.
Mobile		string	String length: inclusive between 0 and 25
CollectionContact		boolean	None.
InvoiceContact		boolean	None.
Notes		string	String length: inclusive between 0 and 255
Inactive	set to true on POST/PUT to inactivate this contact	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "CustomerContactId": 1,
  "CustomerId": 2,
  "CustomerBillId": 3,
  "BillContactId": 4,
  "CustomerSiteId": 5,
  "SiteContactId": 6,
  "ContactName": "sample string 7",
  "Salutation": "sample string 8",
  "FirstName": "sample string 9",
  "MiddleName": "sample string 10",
  "LastName": "sample string 11",
  "Suffix": "sample string 12",
  "Title": "sample string 13",
  "Phone": "sample string 14",
  "Extension": "sample string 15",
  "Fax": "sample string 16",
  "Pager": "sample string 17",
  "EMail": "sample string 18",
  "AllSites": true,
  "Mobile": "sample string 20",
  "CollectionContact": true,
  "InvoiceContact": true,
  "Notes": "sample string 21",
  "Inactive": true
}

application/xml, text/xml

Sample:

<CustomerContact xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SedonaServices.Models">
  <AllSites>true</AllSites>
  <BillContactId>4</BillContactId>
  <CollectionContact>true</CollectionContact>
  <ContactName>sample string 7</ContactName>
  <CustomerBillId>3</CustomerBillId>
  <CustomerContactId>1</CustomerContactId>
  <CustomerId>2</CustomerId>
  <CustomerSiteId>5</CustomerSiteId>
  <EMail>sample string 18</EMail>
  <Extension>sample string 15</Extension>
  <Fax>sample string 16</Fax>
  <FirstName>sample string 9</FirstName>
  <Inactive>true</Inactive>
  <InvoiceContact>true</InvoiceContact>
  <LastName>sample string 11</LastName>
  <MiddleName>sample string 10</MiddleName>
  <Mobile>sample string 20</Mobile>
  <Notes>sample string 21</Notes>
  <Pager>sample string 17</Pager>
  <Phone>sample string 14</Phone>
  <Salutation>sample string 8</Salutation>
  <SiteContactId>6</SiteContactId>
  <Suffix>sample string 12</Suffix>
  <Title>sample string 13</Title>
</CustomerContact>