Using the SOAP Submit Constituent Web Service Operation

This is a description of the SOAP Submit Constituent Web Service Operation:

Service

SCC_CONSTITUENT

Operation

SCC_SUBMITCONST

Summary

The inbound Submit Constituent service updates (submits) personal and demographic information about a person within Campus Solutions.

Description

This Service Operation submits personal information details of a constituent to the Campus Solutions database.

  • Request Parameter:

    Constituent entity – The Constituent options that are provided are derived from the SCC_SUBMITCONST service operation. For example Address, Name, Email Address, Phone, Person SA data.

  • Validation performed for Submit Constituent:

    • Self-service – Submit Constituent requests are always built with EMPLID = UserId’s EMPLID.

    • Email Validations – Conduct all the standard checks to see if the email provided is valid:

      The e-mail address must contain “@” and “.” characters.

      The e-mail address shall not contain “@” and “.” as the first character.

      Two at signs (@) are not allowed

      The e-mail address shall not contain - as the first character in Domain name.

      The e-mail address shall contain at least one character between "." and ".".

      The e-mail address shall not contain “@” and “.” as the last character.

      Validate that domain name consists of at least 2 characters (letters, digits and hyphens separated by dots) after @ sign but not more than 255 character letters, digits and hyphens separated by dots.

      Validate that the local part consists of at least 1 character before the @ sign but not more not more than 64 characters.

      Make sure that at least two characters are present between “@” and “.”.

  • Validates the type Control setting on the Email type being processed and applies the appropriate display mask.

  • Checks to determine if an email type is set as preferred; else service errors out.

  • Data update rule is evaluated to decide as to overwrite or create a new row.

  • Phone Validations:

    • Validates the type Control setting on the Phone type being processed and applies appropriate display mask.

    • Checks to determine if a phone type is set as preferred, else service errors out.

    • Data Update Rule is evaluated to determine which data is overwritten or if a new row needs to be inserted.

  • Address Validations:

    • An Address record must contain one of the ADDRESS1,2,3 or 4 fields.

    • Validates the type Control setting on the Address type being processed and applies appropriate display mask.

    • Data Update Rule is evaluated before processing the data. If the Address data is already existing it is updated otherwise it is inserted.

  • Name Validations:

    All Names validations that are implemented as part of ValidatePersonName Service (NAMEGBL_SBR.NAME.SaveEdit) ValidateNameService function. It validates the Country specific name formatting.

Users

Student

Processing

This service operation performs the following steps:

  • Verify required input parameters exist.

  • Performs the above mentioned validations on the input parameters.

  • Creates an entry or update to data within the constituent entity data model.

  • Responds with information/error messages.

Output

Response message contains information/error messages for constituent.

Error Conditions

The service operation results in error in the following conditions:

  • Invalid input parameters.

  • Any of the validations mentioned above fail.