Seminar Management Methods

The methods available for Seminar Management are exposed under their respective URIs, as described below.

 

Seminars_Fetch

Method Type: GET

returns a list of seminars associated with the database

'/seminars?active={active}&page={page}'

*active - 'True' = active | 'False' = prior | 'All' or unstated = all

*page defaults to 1 if unstated. results are returned 50 records per page.

 

Seminar By ID Fetch

Method Type: GET

returns a seminar associated with the SeminarID

'/seminars/seminarid?page={page}'

*page defaults to 1 if unstated. results are returned 50 records per page.

 

Seminar_Put

Method Type: PUT

Updates or creates a Seminar Record.

'/seminar/{seminarid}'

 

Seminar_MarkDeleted

Method Type: POST

Marks a Seminar Record as deleted.

'/seminar/{seminarid}'

 

SeminarAttendees_Fetch

Method Type: GET

returns a list of seminar attendees associated with the SeminarID

'/seminars/{seminarid}/attendees?page={page}'

*page defaults to 1 if unstated. results are returned 50 records per page.

 

SeminarAttendee_Put

Method Type: PUT

Updates or creates a Seminar Attendee Record.

'/seminars/{seminarid}/attendees/{attendeeid}'

 

SeminarAttendee_MarkDeleted

Method Type: POST

Marks a Seminar Attendee Record as deleted.

'/seminars/{seminarid}/attendees/{attendeeid}'

 

SeminarAttendeeGuests_Put

Method Type: PUT

Updates a Seminar Attendee's guest list.

'/seminars/{seminarid}/attendees/{attendeeid}'

* 4 Guests per Attendee limit

 

Seminars Fetch

 The URI '/seminars?active={active}&page={page}', when paired with the Method Type 'GET',  returns a list of Seminars for the User's Database.

https://api2.redtailtechnology.com/crm/v1/rest/seminars?active={active}&page={page}

https://api2.redtailtechnology.com/crm/v1/rest//seminars?active=true&page=1

 

Below is a sample request in C# using our URI, sample credentials, and the method type. The content type "text/json" work equally well.

HttpWebRequest req = (HttpWebRequest)HttpWebRequest.Create("https://api2.redtailtechnology.com/crm/v1/rest/seminars?active=true&page=1");
req.Headers[System.Net.HttpRequestHeader.Authorization] = "Basic " + Convert.ToBase64String(System.Text.Encoding.Default.GetBytes("6C135EDF-C37C-4039-AEF3-5DFC079F9E6A:Statementone:sonedemo"));
req.Method = "GET";
req.ContentType = "text/xml";

//and here's the response stream.
HttpWebResponse resp = (HttpWebResponse)req.GetResponse();
System.IO.StreamReader sr = new System.IO.StreamReader(resp.GetResponseStream());

 

The corresponding response(xml) will be similar to the following.

 

 

Seminar By ID Fetch

 The URI '/seminars/{SeminarID}', when paired with the Method Type 'GET',  returns the seminar information for the specified SeminarID.

https://api2.redtailtechnology.com/crm/v1/rest/seminars/{seminarid}

https://api2.redtailtechnology.com/crm/v1/rest//seminars/697

 

Below is a sample request in C# using our URI, sample credentials, and the method type. The content type "text/json" work equally well.

HttpWebRequest req = (HttpWebRequest)HttpWebRequest.Create("https://api2.redtailtechnology.com/crm/v1/rest/seminars/697");
req.Headers[System.Net.HttpRequestHeader.Authorization] = "Basic " + Convert.ToBase64String(System.Text.Encoding.Default.GetBytes("6C135EDF-C37C-4039-AEF3-5DFC079F9E6A:Statementone:sonedemo"));
req.Method = "GET";
req.ContentType = "text/xml";

//and here's the response stream.
HttpWebResponse resp = (HttpWebResponse)req.GetResponse();
System.IO.StreamReader sr = new System.IO.StreamReader(resp.GetResponseStream());

 

 The corresponding response(xml) will be similar to the following.

 

Seminar Put

The URI '/seminars/{SeminarID}', when coupled with Method Type 'PUT',  Creates a new Seminar record or Updates an existing record by the specified SeminarID. To create a new Seminar, the SeminarID supplied in the URI should be 0. To Update an existing Seminar, you will need to provide the SeminarID for the record.

https://api2.redtailtechnology.com/crm/v1/rest/seminars/{SeminarID}

example: https://api2.redtailtechnology.com/crm/v1/rest/seminars/0

 

Request Header example (C#)

HttpWebRequest req = (HttpWebRequest)HttpWebRequest.Create("https://api2.redtailtechnology.com/crm/v1/rest/seminars/0");
req.Headers[System.Net.HttpRequestHeader.Authorization] = "Basic " + Convert.ToBase64String(System.Text.Encoding.Default.GetBytes("6C135EDF-C37C-4039-AEF3-5DFC079F9E6A:statementone:sonedemo"));
req.Method = "PUT";
req.ContentType = "text/json";

 

Request Body example (C#)

string reqJSON = "{""Deleted"":false,""Description"":""Rest API Seminar"",""EndDate"":""\/Date(1244185200000-0700)\/"",""Name"":""REST API"",""RecAdd"":""\/Date(1243522507327-0700)\/"",""RecID"":0,""StartDate"":""\/Date(1244185200000-0700)\/"",""StatusID"":1}";
byte[] reqBody = System.Text.Encoding.ASCII.GetBytes(reqJSON);

//Request Stream
req.GetRequestStream().Write(reqBody, 0, reqBody.Length);

//and here's the response stream.
HttpWebResponse resp = (HttpWebResponse)req.GetResponse();
System.IO.StreamReader sr = new System.IO.StreamReader(resp.GetResponseStream());

 

Seminar MarkDeleted

The URI '/seminars/{SeminarID}', when supplied with the Method Type 'POST',  marks a record as deleted.

https://api2.redtailtechnology.com/crm/v1/rest/seminars/{seminarid}

example: https://api2.redtailtechnology.com/crm/v1/rest/seminars/696

 

Request Header example (C#)

HttpWebRequest req = (HttpWebRequest)HttpWebRequest.Create("https://api2.redtailtechnology.com/crm/v1/rest/seminars/696");
req.Headers[System.Net.HttpRequestHeader.Authorization] = "Basic " + Convert.ToBase64String(System.Text.Encoding.Default.GetBytes("6C135EDF-C37C-4039-AEF3-5DFC079F9E6A:statementone:sonedemo"));
req.Method = "POST";
req.ContentType = "text/json"; 
req.ContentLength = 0;

//and here's the response stream.
HttpWebResponse resp = (HttpWebResponse)req.GetResponse(); 
System.IO.StreamReader sr = new System.IO.StreamReader(resp.GetResponseStream());

 

Request Body example (C#)


//and here's the response stream.
HttpWebResponse resp = (HttpWebResponse)req.GetResponse();
System.IO.StreamReader sr = new System.IO.StreamReader(resp.GetResponseStream());

 

 

SeminarAttendees Fetch

The URI '/seminars/{SeminarID}/attendees?page={page}', when paired with the Method Type 'GET',  returns a paged list of Seminar Attendees that correspond to the specified SeminarID.

Note: results are paged at 50 records per page

https://api2.redtailtechnology.com/crm/v1/rest/seminars/{SeminarID}/attendees?page={page}

https://api2.redtailtechnology.com/crm/v1/rest/seminars/697/attendees?page=1

 

Below is a sample request in C# using our URI, sample credentials, and the method type. The content type "text/json" work equally well.

HttpWebRequest req = (HttpWebRequest)HttpWebRequest.Create("https://api2.redtailtechnology.com/crm/v1/rest/seminars/697/attendees?page=1");
req.Headers[System.Net.HttpRequestHeader.Authorization] = "Basic " + Convert.ToBase64String(System.Text.Encoding.Default.GetBytes("6C135EDF-C37C-4039-AEF3-5DFC079F9E6A:Statementone:sonedemo"));
req.Method = "GET";
req.ContentType = "text/xml";

//and here's the response stream.
HttpWebResponse resp = (HttpWebResponse)req.GetResponse();
System.IO.StreamReader sr = new System.IO.StreamReader(resp.GetResponseStream());

 

The corresponding response(xml) will be similar to the following.

 

SeminarAttendeeGuest_Put

The URI '/seminar/{SeminarID}/attendees/{AttendeeID}/guests', when coupled with Method Type 'PUT',  Updates an existing atteendee's guest list associated with the AttendeeID.

Note: There's a 4 Guests per Attendee limit.

https://api2.redtailtechnology.com/crm/v1/rest//seminars/{SeminarID}/attendees/{AttendeeID}/guests

example: https://api2.redtailtechnology.com/crm/v1/rest//seminars/697/attendees/14448/guests

 

Request Header example (C#)

HttpWebRequest req = (HttpWebRequest)HttpWebRequest.Create("https://api2.redtailtechnology.com/crm/v1/rest/seminars/697/attendees/14448/guests");
req.Headers[System.Net.HttpRequestHeader.Authorization] = "Basic " + Convert.ToBase64String(System.Text.Encoding.Default.GetBytes("6C135EDF-C37C-4039-AEF3-5DFC079F9E6A:statementone:sonedemo"));
req.Method = "PUT";
req.ContentType = "text/json";

 

Request Body example (C#)

string reqJSON = "[{""GuestID"":1, ""GuestName"":""Avril Lavigne""},{""GuestID"":2, ""GuestName"":""Taylor Swift""}]";
byte[] reqBody = System.Text.Encoding.ASCII.GetBytes(reqJSON);

//Request Stream
req.GetRequestStream().Write(reqBody, 0, reqBody.Length);

//and here's the response stream.
HttpWebResponse resp = (HttpWebResponse)req.GetResponse();
System.IO.StreamReader sr = new System.IO.StreamReader(resp.GetResponseStream());

 

 

Was this article helpful?
1 out of 1 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk