Contacts

This component runs the Contacts (CON) function.

Note: This Help contains hyperlinks that are enabled when the Help is accessed within the application. However, if you have accessed this Help via the SunSystems Web portal, hyperlinks are not enabled.

Methods

Amend: Driver Type: SASI; Use this method to amend one or more contacts. If a contact does not exist, an error message is produced and the payload is rejected.; Note: Open, Hidden, SuspendedHeld or Closed methods.
Closed: Driver Type: SASI; Use this method to change the status of one or more contacts to Closed.
Create: Driver Type: SASI; Use this method to create one or more contacts. If a contact already exists, an error message is produced and the payload rejected.
CreateAsDraft: Driver Type: SASI; Use this method to create one or more draft contacts.
CreateOrAmend: Driver Type: SASI; Use this method to create or amend one or more contacts. A contact is created if it does not exist and amended if it does. Whereas the Create method requires you to know in advance if a contact exists, this method can be used if you are unsure.
Delete: Driver Type: SASI; Use this method to delete one or more contacts.
Hidden: Driver Type: SASI; Use this method to change the status of one or more contacts to Hidden.
Closed: Driver Type: SASI; Use this method to change the status of one or more contacts to Open.
Query: Driver Type: Export; Use this method to obtain contact details or to extract contact details data from SunSystems.
SuspendedHeld: Driver Type: SASI; Use this method to change the status of one or more contacts to Suspended/Held.

Mandatory fields

When creating or amending contacts the following must be supplied for Contact Code - payload element <ContactCode> .

Note: At runtime the component validates the payload contents to ensure that the values supplied are correct. Various combinations of values may require other elements in the payload to be specified before the payload can be processed successfully.

Related data

Standard Text
Standard Text Language

The attachment of Standard Text is supported by these methods:

Amend
Create
CreateAsDraft
CreateOrAmend

If the standard text supplied in the payload does not exist then it is created. However, it is not possible to amend existing standard text by this means; existing standard text is attached by key only, and any non-key fields in the SSC payload are ignored. Standard text can be amended using the Standard Text Language Variants function from SunSystems or the SSC component StandardTextLanguageVariants.

The standard text to be attached is language specific and therefore must be included within the StandardTextLang part of the payload in order to be detected by the SSC component, as shown in the following example:

<Contacts>
	...
		<StandardText>
			<StandardTextLang>
				<Description>Delivery</Description>
				<LanguageCode>1</LanguageCode>
				<Paragraph1>Follow the special Instructions on the Invoice</Paragraph1>
				<ShortHeading>Delivery</ShortHeading>
				<StandardTextClassCode>SALES</StandardTextClassCode>
				<StandardTextCode>DELIVERY</StandardTextCode>
			</StandardTextLang>
		</StandardText>
</Contacts>