The User Groups quick integration import allows Hiperos 3PM users to directly upload spreadsheets via the HTTPS protocol. This
allows customers to perform inbound imports in an automated manner without the need of a Engagement interface. The various code
snippets below provide working examples of how this is performed using a variety of popular programming languages.
Schema
The first row of the worksheet must include the field names as the column headers. Hiperos 3PM Quick Integration reads this text to import
the data to the appropriate fields. NOTE: When importing setup data values, the setup code must be used rather than the display name.
Note: Required fields are marked with an asterisk (*).
Field
Description
GroupName (*)
Enter the name of the group. Must match an existing group name defined under Group Management.
Description (*)
Enter a short description of the group.
Activated (*)
Enter Yes to activate the user group.
Member (*)
Enter the email address of the internal Client user. Must match an existing username/email address.
HTTP Headers
Authentication
Valid credentials must be supplied for each Hiperos 3PM Quick Integration request issued in order to succeed.
The 3PM user supplied must be a member of either the 'QuickIntegration' group or the
'QuickIntegration-UserGroups' group. The QuickIntegration group allows an account
to access all Quick Integration resources. The QuickIntegration-UserGroups group
limits access to only the Quick Integration UserGroups resource. If these groups currently
do not exist in your Hiperos 3PM instance, please contact your local 3PM administrator or your Hiperos Customer Services
representative to have them created.
HTTP Header
Description
username
Valid Hiperos 3PM Username
password
Valid Hiperos 3PM Password
Content Type
The content type header must contain one of the following types listed below. This is used to identify the
file format that is being uploaded. Note: If sending data as an octet-stream, filename is required in the
Content-Disposition header.
namespace QuickIntegration_Sample
{ class Program
{ staticvoid Main()
{ conststring uriString = "https://rportal.hiperos.com/QuickIntegration/UserGroups"; conststring fileName = @"c:\\hiperos\\outbox\\UserGroups_import.xlsx";
// Create a new WebClient instance.
WebClient client = new WebClient();
// Add authentication headers to request.
client.Headers.Add("username", "Your_3PM_Username_Here");
client.Headers.Add("password", "Your_3PM_Password_Here");
// Upload the file to the URI. // The 'UploadFile(uriString,fileName)' method implicitly uses HTTP POST method. byte[] responseArray = client.UploadFile(uriString, fileName);