Skip to content

Latest commit

 

History

History
executable file
·
83 lines (72 loc) · 2.18 KB

README.md

File metadata and controls

executable file
·
83 lines (72 loc) · 2.18 KB
Raw

eloqua-csharp-rest-client

Eloqua C# Rest Client is a library for Eloqua's REST API. It supports GET, POST, PUT and DELETE operations. The library contains models and clients for Eloqua's core objects, including :

  • Accounts
  • Activities
  • Campaigns
  • Contacts
  • Contact Lists
  • Contact Segments
  • Content Sections
  • Custom Object Data
  • Custom Object Metadata
  • Emails
  • Email Headers
  • Email Groups
  • Forms
  • Form Data
  • Landing Pages
  • Microsites
  • Option Lists
  • Users

Usage

Create Client

var client = new Eloqua.Api.Rest.ClientLibrary.Client("site", "user", "pass");

GET (item)

int emailId = 1;	
Email email = client.Assets.Email.Get(emailId);

GET (list)

List<Email> emails = client.Assets.Email.Get("searchTerm", pageNumber, pageSize);

POST

Email email = new Email() {...};
email = client.Assets.Email.Post(Email);

PUT

Email email = new Email() { ... };	
email = client.Assets.Email.Put(Email);

DELETE

int emailId = 1;	
client.Assets.Email.Delete(emailId);

Endpoint URL

To determine the base url, you can use the following endpoint : login.eloqua.com/id The endpoint, when called with basic authentication, will return details about the URLs for the various APIs.

{
    "site": {
        "id": 42,
        "name": "SampleClient"
    },
    "user": {
        "id": 314,
        "username": "Fred Sakr",
        "displayName": "Fred Sakr",
        "firstName": "Fred",
        "lastName": "Sakr",
        "emailAddress": "[email protected]"
    },
    "urls": {
        "base": "https://www05.secure.eloqua.com",
        "apis"	...
	}
}

License

Copyright [2012] [Fred Sakr]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.