API query ContactById (optimised)

Description

To retrieve contact details by providing the contactID

query filter (table tFilter)

tcBusinessFieldName	tcDataType	tcOperator
iiContactID	i	=
tContact.ContactEmail	c	=,>=,>,<>,<=,<,begins,can-do,matches
tContact.ContactFax	c	=,>=,>,<>,<=,<,begins,can-do,matches
tContact.ContactFunction	c	=,>=,>,<>,<=,<,begins,can-do,matches
tContact.ContactGender	c	=,>=,>,<>,<=,<,begins,can-do,matches
tContact.ContactInitials	c	=,>=,>,<>,<=,<,begins,can-do,matches
tContact.ContactIsPrimary	l	=,<>
tContact.ContactIsSecondary	l	=,<>
tContact.ContactMobilePhone	c	=,>=,>,<>,<=,<,begins,can-do,matches
tContact.ContactName	c	=,>=,>,<>,<=,<,begins,can-do,matches
tContact.ContactTelephone	c	=,>=,>,<>,<=,<,begins,can-do,matches
tContact.ContactTitle	c	=,>=,>,<>,<=,<,begins,can-do,matches
tContact.LastModifiedDate	t	=,>=,>,<>,<=,<
tContact.LastModifiedTime	i	=,>=,>,<>,<=,<
tContact.LastModifiedUser	c	=,>=,>,<>,<=,<,begins,can-do,matches

Parameters (internal)

iiContactID

integer

query condition

each Contact where

Contact.Contact_ID = iiContactID

first Address (inner-join) where

Address.Address_ID = Contact.Address_ID AND

first Lng (inner-join) where

Lng.Lng_ID = Contact.Lng_ID AND

query resultset tqContactById

field name	data type	db field	description
tiAddress_ID	integer	Contact.Address_ID	Link to Address
tiContact_ID	integer	Contact.Contact_ID	Record ID
tcContactEmail	character	Contact.ContactEmail	E-mail. The E-Mail address of the contact. This field can be blank.
tcContactFax	character	Contact.ContactFax	Fax. The fax or telex number to use when sending documents to the contact. This field can be blank.
tcContactFunction	character	Contact.ContactFunction	Function. The function of the contact to the address. This field can be blank.
tcContactGender	character	Contact.ContactGender	Gender. indicates whether the contact is male or femail. This field is mandatory
tcContactInitials	character	Contact.ContactInitials	Initials. The initials of the contact. This field can be blank.
tlContactIsPrimary	logical	Contact.ContactIsPrimary	Primary Contact. This field indicates if the contact is the primary contact of the address. Only one primary contact per address type is allowed.
	api annotation:		PartialUpdate = yes - defaults to false
tlContactIsSecondary	logical	Contact.ContactIsSecondary	Secondary Contact. This field indicates if the contact is the primary contact of the address. Only one secondary contact per address type is allowed.
	api annotation:		PartialUpdate = yes - defaults to false
tcContactMobilePhone	character	Contact.ContactMobilePhone	Mobile. The mobile phone number of the contact. This field can be blank.
tcContactName	character	Contact.ContactName	Name. The full name of the contact. This field is mandatory.
tcContactTelephone	character	Contact.ContactTelephone	Telephone. The telephone number of the contact. This field can be blank.
tcContactTitle	character	Contact.ContactTitle	Title. Title of the contact. This field can be blank.
tcCustomNote	character	Contact.CustomNote	Custom Note Field
ttLastModifiedDate	date	Contact.LastModifiedDate	Last Modified Date
tiLastModifiedTime	integer	Contact.LastModifiedTime	Last Modified Time
tcLastModifiedUser	character	Contact.LastModifiedUser	Last Modified User
tiLng_ID	integer	Contact.Lng_ID	Language Code
ContactCustom	character	calculated	custom fields
ti_sequence	integer	calculated	primary index
tc_rowid	character	calculated	= rowid(Contact),rowid(Address),rowid(Lng)

Internal usage

unused

Sample code: how to call this query through RPCRequestService (QXtend Inbound)

define temp-table ttContext no-undo
    field propertyQualifier as character
    field propertyName as character
    field propertyValue as character
    index entityContext is primary unique
        propertyQualifier
        propertyName
    index propertyQualifier
        propertyQualifier.

define dataset dsContext for ttContext.

define variable vhContextDS as handle no-undo.
define variable vhExceptionDS as handle no-undo.
define variable vhServer as handle no-undo.
define variable vhInputDS as handle no-undo.
define variable vhInputOutputDS as handle no-undo.
define variable vhOutputDS as handle no-undo.
define variable vhParameter as handle no-undo.

/* Create context */
create ttContext.
assign ttContext.propertyName = "programName"
       ttContext.propertyValue = "BBusinessRelation".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "ContactById".
create ttContext.
assign ttContext.propertyName = "applicationId"
       ttContext.propertyValue = "fin".
create ttContext.
assign ttContext.propertyName = "entity"
       ttContext.propertyValue = "1000".
create ttContext.
assign ttContext.propertyName = "userName"
       ttContext.propertyValue = "mfg".
create ttContext.
assign ttContext.propertyName = "password"
       ttContext.propertyValue = "".

/* Create input dataset */
create dataset vhInputDS.
vhInputDS:read-xmlschema("file", "xml/bbusinessrelation.contactbyid.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().

assign vhParameter::icRange = "A"
       vhParameter::icRowid = ""
       vhParameter::iiRownum = 0
       vhParameter::iiNumber = 5 /* Number of records to read */
       vhParameter::icSortColumns = ""
       vhParameter::ilCountOnly = false
       vhParameter::ilForwardRead = true
       vhParameter::iiMaximumBrowseRecordsToCount = 0.

vhParameter = vhInputDS:get-buffer-handle("tFilter").
vhParameter:buffer-create().

assign vhParameter::<field-name-1> = <field-value-1>
       vhParameter::<field-name-2> = <field-value-2>
       ...

/* Connect the AppServer */
create server vhServer.
vhServer:connect("-URL <appserver-url>").

if not vhServer:connected()
then do:
    message "Could not connect AppServer" view-as alert-box error title "Error".
    return.
end.

/* Run */
assign vhContextDS = dataset dsContext:handle.

run program/rpcrequestservice.p on vhServer
    (input-output dataset-handle vhContextDS by-reference,
           output dataset-handle vhExceptionDS,
     input        dataset-handle vhInputDS by-reference,
     input-output dataset-handle vhInputOutputDS by-reference,
           output dataset-handle vhOutputDS).

/* Handle output however you want, in this example, we dump it to xml */
if valid-handle(vhExceptionDS)
then vhExceptionDS:write-xml("file", "Exceptions.xml", true).

if valid-handle(vhOutputDS)
then vhOutputDS:write-xml("file", "Output.xml", true).

/* Cleanup */
vhServer:disconnect().
assign vhServer = ?.

if valid-handle(vhInputDS)
then delete object vhInputDS.

if valid-handle(vhOutputDS)
then delete object vhOutputDS.

if valid-handle(vhExceptionDS)
then delete object vhExceptionDS.