Overview
Configuration is provided for establishing connections with the SimplyDigi service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Configuration
Base URL address: https://[domain]/sws/rest.
-
The authentication uses a parameters-based authentication.
The authentication has the following user-defined parameters:
- setcompanyid:
- seamlesssignonkey:
The following request parameters will be automatically processed during the authentication process:
-
setcompanyid:
{{=connection.user.setcompanyid}} -
seamlesssignonkey:
{{=connection.user.seamlesssignonkey}}
Documentation: http://ecomm.simplydigi.com/SWS/Documentation#HowToAccess.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/users.Documentation: http://ecomm.simplydigi.com/SWS/Documentation#GetUserList.
- [Create] action
-
Endpoint URL address:
/users.Documentation: http://ecomm.simplydigi.com/SWS/Documentation#CreateUser.
- [Update] action
-
Endpoint URL address:
/users/{{=item.UserUUID}}.Documentation: http://ecomm.simplydigi.com/SWS/Documentation#UpdateUser.
- UserUUID
A key field. Data type: DT_GUID
- FirstName
Template: ShortText.
- LastName
Template: ShortText.
- MiddleName
Template: ShortText.
- GotoPageAfterLogin
Template: ShortText.
- PrefixName
Template: ShortText.
- SuffixName
Template: ShortText.
- SSN
Template: ShortText.
- Createdate_ClientUsage
Data type: DT_DBTIMESTAMP
- Deletedate_ClientUsage
Data type: DT_DBTIMESTAMP
- Reassignmentdate
Data type: DT_DBTIMESTAMP
- Status
Template: ShortText.
- UniqueID_ClientSpecified
Data type: DT_GUID
- AllRequiredProfileFieldsCompleted
Data type: DT_BOOL
- SelfAssessmentCompleted
Data type: DT_BOOL
- isActiveIPDP
Data type: DT_BOOL
- APIRecordStatus
Data type: DT_I4 A read-only field.
- APIRecordStatusMessage
Template: ShortText. A read-only field.
- LoginID
Template: ShortText.
- SetLoginPassword
Template: ShortText.
- CompanyNode_NonAdmin
Data type: DT_GUID
- CompanyNode_Admin
Data type: DT_GUID
- PhoneNumberDay
Template: ShortText.
- PhoneNumberDayExt
Template: ShortText.
- PhoneNumberEvening
Template: ShortText.
- PhoneNumberEveningext
Template: ShortText.
- EmailAddress
Template: ShortText.
- Address1
Template: ShortText.
- Address2
Template: ShortText.
- City
Template: ShortText.
- State
Template: ShortText.
- PostalCode
Template: ShortText.
- Birthdate
Data type: DT_DBTIMESTAMP
- Gender
Template: ShortText.
- ImportDeleteExempt
Data type: DT_BOOL
- DisableonDeleteDate
Data type: DT_BOOL
- Country
Template: ShortText.
- SetSeamlessSignonKey
Template: ShortText.
- UserFreeFormField1Value
Template: LongText.
- UserFreeFormField2Value
Template: LongText.
- UserFreeFormField3Value
Template: LongText.
- UserFreeFormField4Value
Template: LongText.
- PermissionGroups
Template: ShortText.
- StudentNodes
Field components:
- An array.
- Contains the following components: NodeUniqueID, CompanyNodeID.
- UserAttributes1
Field components:
- An array.
- Contains the following components: AttributeID, AttributeName.
- UserAttributes2
Field components:
- An array.
- Contains the following components: AttributeID, AttributeName.
- UserAttributes3
Field components:
- An array.
- Contains the following components: AttributeID, AttributeName.
- UserAttributes4
Field components:
- An array.
- Contains the following components: AttributeID, AttributeName.
- UserCompanyNodes
-
A read-only field. Field components:
-
Uses template:
ShortText. - Contains the following components: UserID, CompanyNodeID, CompanyNodeName, CompanyNodeUniqueID, MetaData.
Documentation: http://ecomm.simplydigi.com/SWS/Documentation#UserCompanyNodeDTO.
-
Uses template:
- UserProfileFields
-
A read-only field. Field components:
-
Uses template:
ShortText. - Contains the following components: UserProfileFieldId, FieldName, FieldValue.
Documentation: http://ecomm.simplydigi.com/SWS/Documentation#UserProfileFieldDTO.
-
Uses template:
- UserCourseRegistrations
-
Field components:
-
Uses template:
ShortText. - Contains the following components: CourseRegistrationId, CourseID, UserID, UniqueID_ClientSpecified, FirstName, LastName, UserStatus, EnrollDate, CompletionDate, Score, Status, SecondsinRegistration, CourseVersion, CourseName, CourseNumber, Credits.
Documentation: http://ecomm.simplydigi.com/SWS/Documentation#CourseRegistrationDTO.
-
Uses template:
- UserCredentialsSummaries
-
A read-only field. Field components:
-
Uses template:
ShortText. - Contains the following components: UserID, CredentialGroupID, CredentialGroupName, UserRankValue, UserRankName.
Documentation: http://ecomm.simplydigi.com/SWS/Documentation#UserCredentialSummaryDTO.
-
Uses template:
- UserCredentials
-
A read-only field. Field components:
-
Uses template:
ShortText. - Contains the following components: UserID, CredentialGroupID, CredentialGroupName, CredentialID, CredentialName, DateAwarded, PointsOnAwardDate, ExpirationDate.
Documentation: http://ecomm.simplydigi.com/SWS/Documentation#UserCredentialDTO.
-
Uses template:
- UserWorkExperiences
-
A read-only field. Field components:
-
Uses template:
ShortText. - Contains the following components: UserID, WorkExperienceID, WorkExperienceName, ExperienceMetric, Experience.
Documentation: http://ecomm.simplydigi.com/SWS/Documentation#UserWorkExperienceDTO.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/courseregistrations.Documentation: http://ecomm.simplydigi.com/SWS/Documentation#GetCourseRegistrations.
- [Read UserID] action
-
Endpoint URL address:
/users/{{=parameters.UserID}}/courseregistration.The action has the following user-defined parameters:
- UserID: Required. Specify user identifier.
Documentation: http://ecomm.simplydigi.com/SWS/Documentation#GetRegistrationsList.
- [Create] action
-
Endpoint URL address:
/users/{{=item.UserID}}/courseregistrations.Documentation: http://ecomm.simplydigi.com/SWS/Documentation#CreateRegistration.
- [Update] action
-
Endpoint URL address:
/users/{{=item.UserID}}/courseregistrations/{{=item.CourseRegistrationId}}.Documentation: http://ecomm.simplydigi.com/SWS/Documentation#UpdateRegistration.
- CourseRegistrationId
A key field. Data type: DT_GUID
- CourseID
Data type: DT_GUID
- UserID
Data type: DT_GUID A read-only field.
- UniqueID_ClientSpecified
Template: ShortText. A read-only field.
- FirstName
Template: ShortText. A read-only field.
- LastName
Template: ShortText. A read-only field.
- UserStatus
Template: ShortText. A read-only field.
- EnrollDate
Data type: DT_DBTIMESTAMP A read-only field.
- CompletionDate
Data type: DT_DBTIMESTAMP
- Score
Data type: DT_I4
- Status
Template: ShortText.
- SecondsinRegistration
Data type: DT_I4 A read-only field.
- CourseVersion
Data type: DT_I4 A read-only field.
- CourseName
Template: ShortText. A read-only field.
- CourseNumber
Template: ShortText.
- Credits
Field components:
- An array.
- Contains the following components: Name, Hours.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/articles.Documentation: http://ecomm.simplydigi.com/SWS/Documentation#GetArticleList.
- [Create] action
-
Endpoint URL address:
/articles.Documentation: http://ecomm.simplydigi.com/SWS/Documentation#CreateArticle.
- [Update] action
-
Endpoint URL address:
/articles/{{=item.ID}}.Documentation: http://ecomm.simplydigi.com/SWS/Documentation#UpdateArticle.
- ID
Data type: DT_GUID
- Title
Template: ShortText.
- Content
Data type: DT_NTEXT
- CategoryID
Data type: DT_GUID
- ArticleType
Template: ShortText.
- RelativeURL
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/instructorprofiles.Documentation: http://ecomm.simplydigi.com/SWS/Documentation#GetInstructorProfileList.
- FirstName
Template: ShortText.
- LastName
Template: ShortText.
- Status
Template: ShortText.
- UserUUID
A key field. Data type: DT_GUID
- UniqueID_ClientSpecified
Data type: DT_GUID
- Createdate_ClientUsage
Data type: DT_DBTIMESTAMP
- AllRequiredProfileFieldsCompleted
Data type: DT_BOOL
- EmailAddress
Template: ShortText.
- SelfAssessmentCompleted
Data type: DT_BOOL
- isActiveIPDP
Data type: DT_BOOL
- APIRecordStatus
Data type: DT_I4 A read-only field.
- APIRecordStatusMessage
Template: ShortText. A read-only field.
- UserCompanyNodes
-
A read-only field. Field components:
-
Uses template:
ShortText. - Contains the following components: UserID, CompanyNodeID, CompanyNodeName, CompanyNodeUniqueID, MetaData.
Documentation: http://ecomm.simplydigi.com/SWS/Documentation#UserCompanyNodeDTO.
-
Uses template:
- UserProfileFields
-
A read-only field. Field components:
-
Uses template:
ShortText. - Contains the following components: UserProfileFieldId, FieldName, FieldValue.
Documentation: http://ecomm.simplydigi.com/SWS/Documentation#UserProfileFieldDTO.
-
Uses template:
- UserCourseRegistrations
-
Field components:
-
Uses template:
ShortText. - Contains the following components: CourseRegistrationId, CourseID, UserID, UniqueID_ClientSpecified, FirstName, LastName, UserStatus, EnrollDate, CompletionDate, Score, Status, SecondsinRegistration, CourseVersion, CourseName, CourseNumber, Credits.
Documentation: http://ecomm.simplydigi.com/SWS/Documentation#CourseRegistrationDTO.
-
Uses template:
- UserCredentialsSummaries
-
A read-only field. Field components:
-
Uses template:
ShortText. - Contains the following components: UserID, CredentialGroupID, CredentialGroupName, UserRankValue, UserRankName.
Documentation: http://ecomm.simplydigi.com/SWS/Documentation#UserCredentialSummaryDTO.
-
Uses template:
- UserCredentials
-
A read-only field. Field components:
-
Uses template:
ShortText. - Contains the following components: UserID, CredentialGroupID, CredentialGroupName, CredentialID, CredentialName, DateAwarded, PointsOnAwardDate, ExpirationDate.
Documentation: http://ecomm.simplydigi.com/SWS/Documentation#UserCredentialDTO.
-
Uses template:
- UserWorkExperiences
-
A read-only field. Field components:
-
Uses template:
ShortText. - Contains the following components: UserID, WorkExperienceID, WorkExperienceName, ExperienceMetric, Experience.
Documentation: http://ecomm.simplydigi.com/SWS/Documentation#UserWorkExperienceDTO.
-
Uses template:
- [Read] action
-
The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
_includeUserParameters:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Update] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
What's New
- New: Introduced connection.
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.