Integrations and APIs


CivicReady
®

API Processing Rules

The processing rules below apply to child tags located within each user tag

Membership Import

 Rule  XML Format
First name tag - There can only be one first name <firstName>User1</firstName>
Last name tag - There can only be one last name <lastName>Test1</lastName>
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>
User id tag - There can only be one user id <userID>user1test1</userID>
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 tag - To designate the carrier or service provider (optional): <phone>5551234567|att</phone>
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 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 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 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 tag To delete a telephone number (if you are not including a database id) <phone>1|5551234567</phone>
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>
Group id tag - To delete a member from the network/system Group id = 00000

<groupID>00000</groupID>
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 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 tag - To remove a user from a specific group while adding them to other groups Group id = xxxxxx|00002

<groupID>xxxxxx|00002;xxxxxx;yyyyyy</groupID>
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>
We are able to control the notification type like sms or voice or both via xml 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>
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>
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>
To include Address to a user profile <address>123 Main St., New York, NY, 10036</address>
To Include Custom Fields to a user profile <customFields>Custom Field 1|Custom Field 2|Custom Field 3|Custom Field 4|Custom Field 5</customFields>
Campus name -To relate a user to a specific campus <campusName>Campus X</campusName>
Group Creation and Management  
Processing rules  
Name - The name of the group
Group name can not contain more than 42 characters.
<name>Group Name</name>
Coded Name (FETCH API)
Coded name is generated by the system.
<codedName>group-name</codedName>
Group Email (FETCH API)
Group email is generated by the system.
<email>networkname-group-name@regroup.com</email>
Category - One of the18 available categories in the CivicReady 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>
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>
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>
Description - User defined description of what the group is for.
The description can be 50 characters or less.
<description>Enter Group Description Here</description>
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>
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>
Default group Setting - New users are added automatically to the group.
0 - Default group - FALSE
1 - Default group - TRUE
<defaultGroup>1</defaultGroup>
Set a group to sent a daily/weekly/monthly digest
0 - default
1 - daily
2 - weekly
3 - monthly
<digestEmails>1</digestEmails>
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>
Campus Name - Campus, group is related to. <campusName>Campus 1</campusName>
   

 

 

?



I'd Like to Request an Enhancement

0 out of 0 found this helpful

Updated:
Follow