Advanced Shared CROMERR SOAP Services

Available REST services:

https://encromerrdev.epacdxnode.net/scs-portal-rest/

Available SOAP services:

Service	Description	WSDL
SharedPortalRegisterService	Various services for manipulating users, roles, organizations, etc.	https://encromerrdev.epacdxnode.net/scs-portal-ws/services/SharedPortalService?wsdl
SharedPortalReviewerService	Control access to activities and search activity history.	https://encromerrdev.epacdxnode.net/scs-portal-ws/services/SharedPortalReviewerService?wsdl
SharedPortalSecurityService	Create and validate security tokens for specific Advanced SCS users.	https://encromerrdev.epacdxnode.net/scs-portal-ws/services/SharedPortalSecurityService?wsdl

SharedPortalRegisterService

Expand all | Collapse all | Return to top

Various services for manipulating users, roles, organizations, etc.

Authenticate

[+]

Authenticate to the service. The client must be authenticated before subsequent services are invoked.

Parameter Name	Type	Description	Required?	Default Value
userId	String	User ID	Yes
credential	String	Credential	Yes

AuthenticateUser

[+]

Authenticates a user.

Parameter Name	Type	Description	Required?
securityToken	String	Security token	Yes
userId	String	User ID	Yes
credential	String	Credential	Yes

CreatePartnerOrganization

[+]

Creates a new partner organization.

Parameter Name	Type	Description	Required?	Default Value
securityToken	String	Security token	Yes
org	PartnerOrganization	Organization information	Yes

RetrieveOrganizations

[+]

Retrieves organizations for the specified user.

Parameter Name	Type	Description	Required?	Default Value
securityToken	String	Security token	Yes
userId	String	User ID	Yes

RetrieveOrganizationsByDataflow

[+]

Retrieves organizations for the specified user and dataflow.

Parameter Name	Type	Description	Required?
securityToken	String	Security token	Yes
userId	String	User ID	Yes
dataflow	String	Dataflow acronym	No

RetrievePartnerOrganization

[+]

Retrieve partner organization by internal ID.

Parameter Name	Type	Description	Required?	Default Value
securityToken	String	Security token	Yes
partnerOrganizationId	Long	Internal ID	Yes

RetrievePartnerOrganizationByExternalId

[+]

Retrieve partner organization by external ID.

Parameter Name	Type	Description	Required?	Default Value
securityToken	String	Security token	Yes
externalPartnerOrganizationId	Long	External ID	Yes

RetrievePublishedAlerts

[+]

Retrieve published alerts and news & updates.

Parameter Name	Type	Description	Required?	Default Value
securityToken	String	Security token	Yes
criteria	RegisterAnnouncementSearchCriteria	Search criteria	Yes

RetrieveRoles

[+]

Retrieves roles for the specified user, organization, and dataflow.

Parameter Name	Type	Description	Required?
securityToken	String	Security token	Yes
userId	String	User ID	Yes
userOrganizationId	Long	User organization ID	No
dataflow	String	Dataflow acronym	Yes

RetrieveRolesForDataflowAndPartner

[+]

Retrieves roles for the specified user, organization, dataflow, and partner.

Parameter Name	Type	Description	Required?
securityToken	String	Security token	Yes
userId	String	User ID	Yes
dataflow	String	Dataflow acronym	Yes
partnerId	String	Partner ID	Yes

RetrieveRolesWithOrganizations

[+]

Retrieves roles for the specified user, organization, and dataflow.

Parameter Name	Type	Description	Required?
securityToken	String	Security token	Yes
userId	String	User ID	Yes
userOrganizationId	Long	User organization ID	No
dataflow	String	Dataflow acronym	Yes

RetrieveRolesWithOrganizationsForDataflowAndPartner

[+]

Retrieves roles for the specified user, organization, dataflow, and partner.

Parameter Name	Type	Description	Required?
securityToken	String	Security token	Yes
userId	String	User ID	Yes
dataflow	String	Dataflow acronym	Yes
partnerId	String

RetrieveUser

[+]

Retrieves a user.

Parameter Name	Type	Description	Required?	Default Value
securityToken	String	Security token	Yes
userId	String	User ID	Yes

RetrieveUserWithPrimaryOrganization

[+]

Retrieves a user.

Parameter Name	Type	Description	Required?	Default Value
securityToken	String	Security token	Yes
userId	String	User ID	Yes

UpdatePartnerOrganization

[+]

Update partner organization information. NOTE: Organization name cannot be updated.

Parameter Name	Type	Description	Required?	Default Value
securityToken	String	Security token	Yes
org	PartnerOrganization	Organization information	Yes

UpdateUserOrganizationAssociations

[+]

Updates all users with a specified old organization, to the specified new organization. This will: 1) create a new association between the user & the new organization; 2) for all of the user's roles associated to the old organization, deactivate the old user role, and pre-register the user for each role & the new organization; and 3) email the user with a link to complete each new pre-registration.

Parameter Name	Type	Description	Required?
securityToken	String	Security token	Yes
dataflow	String	Dataflow acronym	Yes
roleId	Long	Role ID	No
externalFlag	Boolean	True if the old & new organization IDs are external organization IDs; false if they're internal	Yes
oldOrganizationId	Long	Old organization ID	Yes
newOrganizationId	Long	New organization ID	Yes

SharedPortalReviewerService

Expand all | Collapse all | Return to top

Control access to activities and search activity history.

Authenticate

[+]

Authenticate to the service. The client must be authenticated before subsequent services are invoked.

Parameter Name	Type	Description	Required?	Default Value
userId	String	User ID	Yes
credential	String	Credential	Yes

CreateActivityAcl

[+]

Grant access for an activity to a particular role.

Parameter Name	Type	Description	Required?	Default Value
securityToken	String	Security token	Yes
acl	ActivityRoleAcl	Access grant information	Yes

SearchForActivityHistorySummary

[+]

Search CROMERR activities.

Parameter Name	Type	Description	Required?	Default Value
securityToken	String	Security token	Yes
searchCriteria	ReviewerSearchCriteria	Search criteria	Yes

SharedPortalSecurityService

Expand all | Collapse all | Return to top

Create and validate security tokens for specific Advanced SCS users.

CreateBasicSecurityToken

[+]

Create a basic security token. NOTE: This creates a token for a specific Advanced SCS user. For general service authentication, use that service's Authenticate method.

Parameter Name	Type	Description	Required?
adminUserId	String	User ID	Yes
adminCredential	String	Credential	Yes
subjectUserId	String	User ID included in token	Yes
ip	String	Client IP address	Yes

CreateSecurityToken

[+]

Create a security token. NOTE: This creates a token for a specific Advanced SCS user. For general service authentication, use that service's Authenticate method.

Parameter Name	Type	Description	Required?
adminUserId	String	User ID	Yes
adminCredential	String	Credential	Yes
userRoleId	Long	User role ID included in token	Yes
ip	String	Client IP address	Yes

ValidateSecurityToken

[+]

Validates a previously generated token

Parameter Name	Type	Description	Required?
adminUserId	String	User ID	Yes
adminCredential	String	Credential	Yes
token	String	Security token	Yes
ip	String	Client IP address	Yes

Type Definitions

Definitions for data types that are used in service calls.

ActivityRoleAcl

Information for granting access to an activity.

String activityId - CROMERR activity ID
Long roleId - Role ID

PartnerOrganization

Represents organization properties.

Long organizationId - Organization ID
String organizationName - Organization name
String mailingAddress1 - Mailing address (line 1)
String mailingAddress2 - Mailing address (line 2)
String mailingAddress3 - Mailing address (line 3)
String mailingAddress4 - Mailing address (line 4)
String city - City
String state - State code (e.g. VA)
String country - Country code (e.g. US)
String zip - ZIP code
PartnerOrganizationStatus status
PartnerOrganizationMetaData metaData
String partnerId - Partner ID

PartnerOrganizationMetaData

Represents additional organization metadata.

Long externalOrganizationId - External organization ID
String externalOrganizationType - External organization ID type

PartnerOrganizationStatus

Organization status.

Valid values are:

ACTIVE
INACTIVE

RegisterAnnouncement

Represents a published announcement (aka alert).

RegisterAnnouncementType alertType
String partnerId - Partner ID
String dataflow - Dataflow acronym
Long roleId - Role ID
Date startDate - Start date of alert
Date endDate - End date of alert
String text - Alert text

RegisterAnnouncementSearchCriteria

Criteria for searching announcements (aka alerts).

RegisterAnnouncementType alertType
String dataflow - Dataflow acronym
Long roleId - Role ID
Date startDate - Start date of alert
Date endDate - End date of alert

RegisterAnnouncementType

Alert type

Valid values are:

ALERTS
NEWS_AND_UPDATES
HOME_PAGE

RegisterOrganization

Represents user organization properties.

Long userOrganizationId - User organization ID
String email - Email address
String phone - Phone number (digits only)
String phoneExtension - Phone extension
String fax - Fax number (digits only)
String esaStatus - ESA status
String esaApprovalMethod - ESA approval method
Date esaApprovalDate - ESA approval date

RegisterOrganizationWithDataflows

Represents user organization properties.

List<String> dataflows

RegisterRole

Represents a user role.

Long userRoleId - User role ID
String userRoleStatus - User role status
String userRoleSubject - Program ID (aka Client ID, aka Subject)
String dataflow - Dataflow acronym
Long roleId - Role ID
String roleName - Role name
Long userOrganizationId - User organization ID
String partnerId - Partner ID

RegisterRoleWithOrganization

Represents a user role with organization.

Long userRoleId - User role ID
String userRoleStatus - User role status
String userRoleSubject - Program ID (aka Client ID, aka Subject)
String dataflow - Dataflow acronym
Long roleId - Role ID
String roleName - Role name
String partnerId - Partner ID
RegisterOrganization organization

RegisterUser

Represents basic properties of a SCS user account.

String userId - User ID
String firstName - First name
String lastName - Last name
String middleInitial - Middle initial
Date lastLogin - Last login date
Date registrationDate - Registration date
Long verificationIndexElectronic - LexisNexis verification index (electronic)
Long verificationIndexPaper - LexisNexis verification index (paper)
Long passwordResetAttempts - Number of password reset attempts
Long idProofAttempts - Number of LexisNexis attempts
String status - Account status
String partnerId - Partner ID
Long primaryUserOrgId - User organization ID for user's primary organization

RegisterUserWithPrimaryOrganization

Represents basic properties of a SCS user account, plus the user's primary organization.

String userId - User ID
String firstName - First name
String lastName - Last name
String middleInitial - Middle initial
Date lastLogin - Last login date
Date registrationDate - Registration date
Long verificationIndexElectronic - LexisNexis verification index (electronic)
Long verificationIndexPaper - LexisNexis verification index (paper)
Long passwordResetAttempts - Number of password reset attempts
Long idProofAttempts - Number of LexisNexis attempts
String status - Account status
String partnerId - Partner ID
RegisterOrganization primaryOrganization

ReviewerActivitySummary

Represents a CROMERR activity.

String activityId - CROMERR activity ID
String dataflow - Dataflow acronym
Date createdDate - Activity creation date
ReviewerActivitySummaryUser user

ReviewerActivitySummaryUser

Represents a user associated to a CROMERR activity.

String userId - User ID
String firstName - First name
String lastName - Last name
String middleInitial - Middle initial

ReviewerSearchCriteria

Criteria for searching activities.

String activityId - CROMERR activity ID
String dataflow - Dataflow acronym
String userId - User ID
String documentId - CROMERR document ID
String documentName - Document name
Date startDate - Activity creation date (start)
Date endDate - Activity creation date (end)
Long aclRoleId - Role ID that has been granted access to activity

SecurityTokenUser

Represents a user determined via security token validation.

String userId - User ID
String title - Title (Mr, Ms, etc.)
String firstName - First name
String lastName - Last name
String middleInitial - Middle initial
Long organizationId - Organization ID
String organizationName - Organization name
String address1 - Mailing address (line 1)
String address2 - Mailing address (line 2)
String address3 - Mailing address (line 3)
String address4 - Mailing address (line 4)
String city - City
String state - State code (e.g. VA)
String country - Country code (e.g. US)
String postalCode - ZIP code
Long userOrganizationId - User organization ID
String organizationStatus
String organizationType
Long externalOrganizationId - External organization ID
String email - Email address
String phoneNumber - Phone number (digits only)
String phoneExtension - Phone extension
String faxNumber - Fax number (digits only)
String dataflow - Dataflow acronym
Long userRoleId - User role ID
Long roleId - Role ID
String roleName - Role name
String subject - Program ID (aka Client ID, aka Subject)
String userRoleStatus - User role status
String rolePartnerId