Element

SQL Data Type

Mandatory

Description

VendorTokenGUID

GUID

Yes

Specific GUID that Synergetic will give the third party app to validate them upon every web service request.

VendorPassword

Varchar(100)

Yes

Password provided to the vendor by CDA.

VersionNumber

Decimal(4,2)

Yes

To cater for extending the web service and return the version specific format. Default 2.5.

ConfigFileName

Varchar(max)

No

Optional - if missing or blank then the authentication details into DB are found in WebServiceSynergetic.XML in the website folder. An example of why this might be necessary is if three different third party companies connect to a school's web service and the school wants to connect to their live servers yet one that is under development may want to connect to their test DB servers. Default blank.

ID

Integer

Yes

Synergetic Community ID for the required person.

Element

SQL Data Type

Description

ID

Integer

Person's community ID, same as passed in ID.

Surname

Varchar(30)

Family name.

Given1

Varchar(20)

First given name.

Given2

Varchar(20)

Second given name.

Preferred

Varchar(20)

Preferred name.

SurnamePrevious

Varchar(30)

Previous surname.

SpouseID

Integer

Spouse's community ID.

BirthDate

Varchar(10)

Birth date in dd/mm/yyyy format.

HomeAddress1

Varchar(40)

Home address line 1.

HomeAddress2

Varchar(40)

Home address line 2.

HomeAddress3

Varchar(40)

Home address line 3.

HomeSuburb

Varchar(40)

Home suburb.

HomeState

Varchar(5)

Home state, eg. VIC.

HomePostCode

Varchar(5)

Home post code.

HomeCountryDescription

Varchar(40)

Home country description. eg. Australia.

PostalAddress1

Varchar(40)

Postal address line 1.

PostalAddress2

Varchar(40)

Postal address line 2.

PostalAddress3

Varchar(40)

Postal address line 3.

PostalSuburb

Varchar(40)

Postal suburb.

PostalState

Varchar(5)

Postal state, eg VIC.

PostalPostCode

Varchar(5)

Postal post code.

PostalCountryDescription

Varchar(40)

Postal country description. eg. Australia.

HomePhone

Varchar(15)

Home phone number. If silent number then shows 'Silent Phone'.

HomePhoneAlt

Varchar(15)

Alternative phone number.

MobilePhone

Varchar(15)

Mobile phone number.

Email

Varchar(100)

Home email address.

OccupEmail

Varchar(100)

Work email address.

DefaultEmail

Varchar(100)

Default email address (either work or home address).

MailFlag

Bit

Person wants to receive mail.

MagazineFlag

Bit

Person wants to receive magazine.

SolicitationFlag

Bit

Person wants to receive solicitation.

RaffleFlag

Bit

Person wants to receive raffle tickets.

CountryOfBirthDescription

Varchar(40)

Country of birth. Eg. New Zealand.

NationalityDescription

Varchar(40)

Nationality.

HomeLanguageDescription

Varchar(40)

Home language.

ReligionDescription

Varchar(40)

Religion.