ABCD
1
Processing RulesXML FormatJSON Format
2
The processing rules below apply to child tags located within each user tag
3
4
5
Membership Import
6
7
First name tag - There can only be one first name<firstName>User1</firstName>"firstName": "User1",
8
Last name tag - There can only be one last name<lastName>Test1</lastName>"lastName": "TEST1",
9
Email tag - you can have multiple email addresses (one or more) separated by a semicolon (;)
<email>user1test1@email.com</email> or

<email>user1test1@email.com;user2test2@email.com</email>
"email": "user1test1@email.com", OR

"email": "user1test1@email.com;user2test2@email.com"
10
User id tag - There can only be one user id<userID>user1test1</userID>"userID": "user1test1",
11
Phone tag - you can have multiple phone numbers(one or more) seperated by a semicolon (;), as well as other functions explained in the next cell
<phone>5551234567</phone> or

<phone>5551234567;5551234568</phone>
"phone": "5551234567", OR

"phone": "5551234567;5551234568",
12
Phone tag - To designate the carrier or service provider (optional):<phone>5551234567|att</phone>"phone": "5551234567|att"
13
Phone - tag To designate the type of messages the phone will receive
1 = text only
2 = voice only
3 = text and voice - the default setting
(optional - by default numbers entered with no message type will receive both text and voice alerts)
<phone>5551234567||1</phone> or

<phone>5551234567||2</phone> or

<phone>5551234567||3</phone>
"phone": "5551234567||1", OR

"phone": "5551234567||2", OR

"phone": "5551234567||3"
14
Phone tag To designate the country code of the phone number (numbers entered without a country code will default to a country code of 1)
<phone>5551234567|||1</phone>"phone": "5551234567|||1"
15
Phone tag To designate the type of phone this is
home
work
cell
other
(by default numbers entered will be labeled as cell)
<phone>5551234567||||home</phone> or

<phone>5551234567||||work</phone> or

<phone>5551234567||||cell</phone> or

<phone>5551234567||||other</phone>
"phone": "5551234567||||home", OR

"phone": "5551234567||||work", OR

"phone": "5551234567||||cell", OR,

"phone": "5551234567||||other"
16
Phone tag You can include full or partial entries, all that is needed is a 10 digit phone number, the other fields are optional. As shown above the fields can be included without the other preceding field. Below is an example of a full entry
<phone>5551234567|sprint|2|1|cell</phone>"phone": "5551234567|sprint|2|1|cell"
17
Phone tag To delete a telephone number (if you are not including a database id)<phone>1|5551234567</phone>"phone": "1|5551234567"
18
Group id tag - you can have multiple (one or more) group id's separated by a semicolon (;), as well as other functions explained in the following cells
<groupID>xxxxxx</groupID>
or

<groupID>xxxxxx;yyyyyy</groupID>
"groupID": "xxxxxx", OR

"groupID": "xxxxxx;yyyyyy"
19
Group id tag - To delete a member from the network/systemGroup id = 00000

<groupID>00000</groupID>
Group id = 00000

"groupID": "00000",
20
Group id tag - To remove a user from all groups on the network ( you can remove a user from all groups in one row, and add then to new groups in a second row)
Group id = 00001

<groupID>00001</groupID>
Group id = 00001

"groupID": "00001",
21
Group id tag - to remove a user from specific groups( you can remove a user from all groups included in the column with the remove code)
Grooup id = 00002

<groupID>00002;xxxxxx;yyyyyy</groupID>
Group id = 00002

"groupID": "00002;xxxxxx;yyyyyy",
22
Group id tag - To remove a user from a specific group while adding them to other groupsGroup id = xxxxxx|00002

<groupID>xxxxxx|00002;xxxxxx;yyyyyy</groupID>
Group id = xxxxxx|00002

"groupID": "xxxxxx|00002;xxxxxx;yyyyyy"
23
To set the permission level for user on a group level
Groupid | permission level | message type | restrict emails

Permission levels
0 = remove admin permissions (set as a regular user)
1 = group admin
2 = network admin
3 = limited admin
4 = authorized sender
00002 = remove user from group
<groupID>xxxxxx|0</groupID> OR

<groupID>xxxxxx|1</groupID> OR

<groupID>xxxxxx|2</groupID> OR

<groupID>xxxxxx|3</groupID> OR

<groupID>xxxxxx|4</groupID>
"groupID": "xxxxxx|0", OR

"groupID": "xxxxxx|1", OR

"groupID": "xxxxxx|2", OR

"groupID": "xxxxxx|3", OR

"groupID": "xxxxxx|4"
24
We are able to control the notification type like sms or voice or both via xml/json import at the group level.

the number after 2nd | (pipe) is the notification type
1 = text
2 = voice
3 = both (default)
<groupID>xxxxxx||1</groupID> or

<groupID>xxxxxx||2</groupID> or

<groupID>xxxxxx||3</groupID>
"groupID": "xxxxxx||1", OR

"groupID": "xxxxxx||2", OR

"groupID": "xxxxxx||3"
25
We are able to control the email digest frequency for each group the user belongs to via xml import

the number after 3rd | (pipe) is the digest frequency setting
1 = daily
2 = weekly
3 = monthly
<groupID>xxxxxx|||1</groupID> or

<groupID>xxxxxx|||2</groupID> or

<groupID>xxxxxx|||3</groupID>
"groupID": "xxxxxx|||1", OR

"groupID": "xxxxxx|||2", OR

"groupID": "xxxxxx|||3",
26
Database ID tag - You can have only one database id tag, once entered this id becomes the unique identifier for the record in your network
<databaseID>User1Test1DB</databaseID>"databaseID": "User1Test1DB"
27
To include Address to a user profile<address> street address, city, state, zip</address>"address": "street address, city, state, zip"
28
To Include Custom Fields to a user profile
<customField>Custom Field 1|Custom Field 2|Custom Field 3|Custom Field 4|Custom Field 5</customField>
"customField": "Custom Field 1|Custom Field 2|Custom Field 3|Custom Field 4|Custom Field 5"
29
Campus name -To relate a user to a specific campus<campusName>campus-coded-name</campusName>"campusName": "campus-coded-name"
30
Set a user to see all groups in the network (including secret and groups, belonging to all campuses)
<showAllGroups>1</showAllGroups>"showAllGroups>": "1"
31
32
Group Creation and Management
33
Processing rules
34
Name - The name of the group
Group name can not contain more than 42 characters.
<name>Group Name</name>"name": "Group Name"
35
Coded Name (FETCH API)
Coded name is generated by the system.
<codedName>group-name</codedName>"codedName": "group-name"
36
Group Email (FETCH API)
Group email is generated by the system.
<email>networkname-group-name@regroup.com</email>"email": "networkname-group-name@regroup.com"
37
Category - One of the18 available categories in the Regroup system.
Enter the number for the desired Category.

1 - General
2 - Classifieds
3 - Class Year
4 - School Status
5 - Field of Study
6 - Residence
7 - Greek Association
8 - Club
9 - Course
10 - Sport
11 - Careers
12 - Emergency Alerts
13 - Schools/Colleges
14 - Branch Campuses
15 - Institutes & centers
16 - Offices & services
17 - Notification
18 - Publications
<category>12</category>"category": "12"
38
Type - One of the available Group Types.
Enter the number for the desired Group Type.

1 - Open Discussion
2 - Announcement-Only
3 - Moderated
<type>2</type>"type": "2"
39
Privacy - One of the 3 available Group Privacy Types.
Enter the number for the desired Group Privacy Type.

1 - Public
2 - Private
3 - Secret
<privacy>3</privacy>"privacy": "1"
40
Description - User defined description of what the group is for.
The description can be 50 characters or less.
<description>Enter Group Description Here</description>"description": "Enter Group Description Here"
41
Un-Restrict emails
0 - allow only members of the group to send emails into the group
1 - allow public to send emails into the group
2 - restrict emails into the group
<unrestrictEmails>1</unrestrictEmails>"unrestrictEmails": "1"
42
Action - One of the 3 available actions to manage groups.
Enter the action you wish to perform.

Purge
Delete
Modify
<action>delete</action>

<action>purge</action>

<action>modify</action>
"action": "delete",

"action": "purge",

"action": "modify"
43
Default group Setting - New users are added automatically to the group.
0 - Default group - FALSE
1 - Default group - TRUE
<defaultGroup>1</defaultGroup>"defaultGroup": "1"
44
Set a group to sent a daily/weekly/monthly digest
0 - default
1 - daily
2 - weekly
3 - monthly
<digestEmails>1</digestEmails>"digestEmails": "0"
45
Set an import processing style
1 - normal processing ( Group members will not be replaced via csv and group is set as static )
2 - active roster processing ( Replace the users in our group with only what we send you in the .csv. )
3 - purge processing ( Replace the users and user's information in the group with only what we send you in the .csv. )
<csvProcessing>1</csvProcessing>"csvProcessing": "1"
46
Campus Name - Campus, group is related to.<campusName>Campus 1</campusName>"campusName": "campus-1"
47
48
Setting All Topics of a Group to Display on RSS

to show all topics - 1
to hide all topics - 0
<showTopicsRss>1</showTopicsRss>"showTopicsRss": "1"
49
Messaging API
50
Processing rules
51
Messaging API Request URLhttps://regroup.com/api/v2/topics?api_key=NetworkAPIKEYhttps://regroup.com/api/v2/topics.json?api_key=NetworkAPIKEY
52
53
The XML/JSON Request must contain the subject, body, recipient ID tags and message endpoint tag to successfully post a notification.
54
The desired recipients must already exist in the Regroup database to receive a notification.
55
56
<subject> tag is required for all notifications including text and text to speech.<subject>Enter your Subject line here</subject>"subject": "Enter your Subject line here"
57
Enter the desired subject line within this tag.
58
59
<body> tag is required, this will be the body of all notifications.<body><![CDATA[Enter the body of the message here, including HTML.]]></body>"body": "![CDATA[Enter the body of the message here, including HTML.]]"
60
You can also include HTML code within the body tag (HTML code will not play during a TTS transmission only the plain text wording.
61
62
Messaging EndpointsYou can send to one or more endpoints by including or omitting these tags.
63
The following examples will show sending to ALL endpoints.
64
You can have any combination of endpoints when submitting your request.
65
If there is a value other than 1 in any Messaging Endpoints (mail,sms,tts,fb,pn) tags, that type of notification will not go out.
66
<mail> tag is for sending out email notifications.<mail>1</mail>"mail": "1"
67
68
<sms> tag is for sending out text/sms notifications.<sms>1</sms>"sms": "1"
69
70
<tts> tag is for sending out Text to speech voice notifications.<tts>1</tts>"tts": "1"
71
72
<fb> tag is for sending out Facebook notifications.<fb>1</fb>"fb": "1"
73
74
<pn> tag is for sending out push notifications for mobile applications.<pn>1</pn>"pn": "1"
75
76
Recipient IdentifierIn addition to the above tags you will need to include a Recipient Identifier to designate who will receive this notification.
77
You can send to multiple Recipients by separating the Recipient Identifier's with a comma (,)
78
Group ID - Enter the group id of an existing group on your Regroup network.<groupID>xxxxxx,yyyyyy</groupID>"groupID": "xxxxxx,yyyyyy"
79
80
Database ID - Enter the database id of an existing user in your Regroup network.<databaseID>xxxxxx,yyyyyy</databaseID>"databaseID": "xxxxxx,yyyyyy"
81
82
Email - Enter the email address of an existing user in your Regroup network.<email>xxxxxx,yyyyyy</email>"email": "xxxxxx,yyyyyy"
83
84
userID - Enter the userID of an existing user in your Regroup network.<userID>xxxxxx,yyyyyy</userID>"userID": "xxxxxx,yyyyyy"
85
86
fromName - Enter the Name, emails to be sent from.<fromName>NAME</fromName>"fromName": "NAME"
87
88
fromEmail - Enter the Email, emails to be sent from.<fromEmail>email@domain.com</fromEmail>"fromEmail": "email@domain.com"
89
90
toName - Enter the Name, emails to be sent to.<toName>NAME</toName>"toName": "NAME"
91
92
toEmail - Enter the Email, emails to be sent to.<toEmail>email@domain.com</toEmail>"toEmail": "email@domain.com"
93
94
replyText - Enter the reply to email, replies to be sent to.<replyText>email@domain.com</replyText>"replyText": "email@domain.com"
95
96
subjectPrefixText - Enter the Subject Prefix emails are sent.<subjectPrefixText>Subject Prefix Text</subjectPrefixText>"subjectPrefixText": "Subject Prefix Text"
97
98
footerText - Enter the footer Text, emails to be sent with.<footerText>Footer Text</footerText>"footerText": "Footer Text"
99
100
Group IDs - Set a Single Topic to Display on RSS
to Display theTopic - 1
to Hide the Topic - 0
<showOnRss>1</showOnRss>"showOnRss": "1"