PUT v1/Contacts

Insert a contact into Catalyst with a simple contract

Request Information

URI Parameters

None.

Body Parameters

Contact

Name	Description	Type	Additional information
TrimExceptions	Trim exceptions	Collection of string	None.
XDate	Contact xDate	string	None.
XDateDescription	xDate description	string	None.
XDateLineAcordCode	xDate line ACORD code	string	None.
XDateLineInternalCode	xDate line internal code	string	None.
AdditionalActivityNote	Additional activity note	string	None.
XDatePeriod	xDate period	string	None.
AgentId	Agent	integer	None.
CsrID	CSR	integer	None.
CustomerNo	Customer no	string	None.
ContactSubType	C - Customer, P - Prospect, E - Employee, M - MGA, H - Certholder, L - Leinholder, F - Finance Compnay, R - Carrier	string	None.
FirstName	First name of the contact	string	None.
MiddleName	Middle name of the contact	string	None.
LastName	Last name of the contact	string	None.
Phone	Phone of the contact	string	None.
Email	Email of the contact	string	None.
Line1	Line 1	string	None.
Line2	Line 2	string	None.
City	City	string	None.
State	State	string	None.
County	County	string	None.
Zip	ZIP code	string	None.
Country	Country	string	None.
LocationID	Location id	integer	None.
Status	Status	string	None.
ContactType	C - Commercial, P - Personal, E - Employee, B - Business	string	None.
BusinessName	Business name	string	None.

Request Formats

application/json, text/json

Sample:

{
  "TrimExceptions": null,
  "XDate": "sample string 1",
  "XDateDescription": "sample string 2",
  "XDateLineAcordCode": "sample string 3",
  "XDateLineInternalCode": "sample string 4",
  "AdditionalActivityNote": "sample string 5",
  "XDatePeriod": "sample string 6",
  "AgentId": 1,
  "CsrID": 1,
  "CustomerNo": "sample string 7",
  "ContactSubType": "sample string 8",
  "FirstName": "sample string 9",
  "MiddleName": "sample string 10",
  "LastName": "sample string 11",
  "Phone": "sample string 12",
  "Email": "sample string 13",
  "Line1": "sample string 14",
  "Line2": "sample string 15",
  "City": "sample string 16",
  "State": "sample string 17",
  "County": "sample string 18",
  "Zip": "sample string 19",
  "Country": "sample string 20",
  "LocationID": 1,
  "Status": "sample string 21",
  "ContactType": "sample string 22",
  "BusinessName": "sample string 23"
}

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 'InsertContactDTO'.

application/xml, text/xml

Sample:

<InsertContactDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Contacts">
  <BusinessName>sample string 23</BusinessName>
  <City>sample string 16</City>
  <ContactSubType>sample string 8</ContactSubType>
  <ContactType>sample string 22</ContactType>
  <Country>sample string 20</Country>
  <County>sample string 18</County>
  <CustomerNo>sample string 7</CustomerNo>
  <Email>sample string 13</Email>
  <FirstName>sample string 9</FirstName>
  <LastName>sample string 11</LastName>
  <Line1>sample string 14</Line1>
  <Line2>sample string 15</Line2>
  <LocationID>1</LocationID>
  <MiddleName>sample string 10</MiddleName>
  <Phone>sample string 12</Phone>
  <State>sample string 17</State>
  <Status>sample string 21</Status>
  <Zip>sample string 19</Zip>
  <AdditionalActivityNote>sample string 5</AdditionalActivityNote>
  <AgentId>1</AgentId>
  <CsrID>1</CsrID>
  <TrimExceptions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <XDate>sample string 1</XDate>
  <XDateDescription>sample string 2</XDateDescription>
  <XDateLineAcordCode>sample string 3</XDateLineAcordCode>
  <XDateLineInternalCode>sample string 4</XDateLineInternalCode>
  <XDatePeriod>sample string 6</XDatePeriod>
</InsertContactDTO>

Response Information

Resource Description

Action result

ActionResultDTOOfString

Name	Description	Type	Additional information
Result		string	None.
CreatedBy		string	None.
EntityID		integer	None.
RowSource		string	None.
PolicyID		integer	None.
IsSuccess	Signifies whether action is successful	boolean	None.
ErrorCode	Error code	string	None.
ErrorMessage	Error message	string	None.
InfoMessage	Information message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Result": "sample string 1",
  "CreatedBy": "sample string 2",
  "EntityID": 3,
  "RowSource": "sample string 4",
  "PolicyID": 5,
  "IsSuccess": true,
  "ErrorCode": "sample string 7",
  "ErrorMessage": "sample string 8",
  "InfoMessage": "sample string 9"
}

application/xml, text/xml

Sample:

<ActionResultOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects">
  <ErrorCode>sample string 7</ErrorCode>
  <ErrorMessage>sample string 8</ErrorMessage>
  <InfoMessage>sample string 9</InfoMessage>
  <IsSuccess>true</IsSuccess>
  <CreatedBy>sample string 2</CreatedBy>
  <EntityID>3</EntityID>
  <PolicyID>5</PolicyID>
  <Result>sample string 1</Result>
  <RowSource>sample string 4</RowSource>
</ActionResultOfstring>