POST api/ElistContacts/CreateElistContact

Create a new Elist Contact using a Request Body of type NewElistContact.

Request Information

URI Parameters

None.

Body Parameters

A request body of type NewElistContact.

NewElistContact
NameDescriptionTypeAdditional information
ListName

The name of the List without its domain.

string

Required

String length: inclusive between 0 and 128

ListDisplayName

The name of the List without its domain.

string

Required

String length: inclusive between 0 and 255

OwnerNetID

The Cornell NetID of the Owner.

string

Required

String length: inclusive between 0 and 50

OwnerEMailAddress

The Email Address that the owner will use when managing the list.

string

Required

String length: inclusive between 0 and 128

OwnerDisplayName

The Display Name that will be used by the Owner when managing the list

string

Required

String length: inclusive between 0 and 255

ListDomainName

The domain that this list will use for routing email to the appropriate list manager instance.

string

Required

String length: inclusive between 0 and 128

Purpose

The business purpose for this list (Enumerated Value)

string

Required

String length: inclusive between 0 and 128

SponsorNetID

The Cornell NetID for the List's Sponsor

string

Required

String length: inclusive between 0 and 50

CornellEntity

The Cornell Entity

string

None.

Enabled

The Active Directory Object ID for the List Contact. This property will be populated on provisioning.

boolean

None.

MetaData

Elist MetaData

Dictionary of string [key] and Object [value]

None.

Notes

A general notes field.

string

None.

Request Formats

application/json, text/json

Sample:
{
  "ListName": "sample string 1",
  "ListDisplayName": "sample string 2",
  "OwnerNetID": "sample string 3",
  "OwnerEMailAddress": "sample string 4",
  "OwnerDisplayName": "sample string 5",
  "ListDomainName": "sample string 6",
  "Purpose": "sample string 7",
  "SponsorNetID": "sample string 8",
  "CornellEntity": "sample string 9",
  "Enabled": true,
  "MetaData": {
    "sample string 1": {},
    "sample string 3": {}
  },
  "Notes": "sample string 11"
}

application/xml, text/xml

Sample:
<NewElistContact xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ListServiceManagement.ViewModels">
  <CornellEntity>sample string 9</CornellEntity>
  <Enabled>true</Enabled>
  <ListDisplayName>sample string 2</ListDisplayName>
  <ListDomainName>sample string 6</ListDomainName>
  <ListName>sample string 1</ListName>
  <MetaData xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </MetaData>
  <Notes>sample string 11</Notes>
  <OwnerDisplayName>sample string 5</OwnerDisplayName>
  <OwnerEMailAddress>sample string 4</OwnerEMailAddress>
  <OwnerNetID>sample string 3</OwnerNetID>
  <Purpose>sample string 7</Purpose>
  <SponsorNetID>sample string 8</SponsorNetID>
</NewElistContact>

application/x-www-form-urlencoded

Sample:
ListName=sample+string+1&ListDisplayName=sample+string+1&OwnerNetID=sample+string+1&OwnerEMailAddress=sample+string+1&OwnerDisplayName=sample+string+1&ListDomainName=sample+string+1&Purpose=sample+string+1&SponsorNetID=sample+string+1&CornellEntity=sample+string+1&Enabled=True&MetaData=System.Collections.Generic.Dictionary%602%5bSystem.String%2cSystem.Object%5d&Notes=sample+string+1

Response Information

Resource Description

ElistContact
NameDescriptionTypeAdditional information
ListContact_Id

integer

None.

ListName

string

Required

String length: inclusive between 0 and 128

ListDisplayName

string

Required

String length: inclusive between 0 and 255

OwnerNetID

string

Required

String length: inclusive between 0 and 50

OwnerEMailAddress

string

Required

String length: inclusive between 0 and 128

OwnerDisplayName

string

Required

String length: inclusive between 0 and 128

ListDomainName

string

Required

String length: inclusive between 0 and 128

Purpose

string

Required

String length: inclusive between 0 and 128

SponsorNetID

string

Required

String length: inclusive between 0 and 50

CornellEntity

string

None.

ListContactDirectory_Id

globally unique identifier

None.

RequestContactDirectory_Id

globally unique identifier

None.

OwnerContactDirectory_Id

globally unique identifier

None.

Enabled

boolean

None.

MetaData

Dictionary of string [key] and Object [value]

None.

SerializedMetaData

string

None.

Notes

string

None.

WhenCreated

date

None.

WhenModified

date

None.

Response Formats

application/json, text/json

Sample:
{
  "ListContact_Id": 1,
  "ListName": "sample string 2",
  "ListDisplayName": "sample string 3",
  "OwnerNetID": "sample string 4",
  "OwnerEMailAddress": "sample string 5",
  "OwnerDisplayName": "sample string 6",
  "ListDomainName": "sample string 7",
  "Purpose": "sample string 8",
  "SponsorNetID": "sample string 9",
  "CornellEntity": "sample string 10",
  "ListContactDirectory_Id": "f540d8d9-ad56-4504-ab63-146eaf9d376f",
  "RequestContactDirectory_Id": "d2b5d4de-666b-488c-b57c-4749efe660f1",
  "OwnerContactDirectory_Id": "3a07e18d-5265-488d-a9df-ff561f124f5a",
  "Enabled": true,
  "MetaData": {},
  "SerializedMetaData": "{}",
  "Notes": "sample string 16",
  "WhenCreated": "2024-11-26T18:39:42.4738115-05:00",
  "WhenModified": "2024-11-26T18:39:42.4738115-05:00"
}

application/xml, text/xml

Sample:
<ElistContact xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ListServiceManagement.Models">
  <CornellEntity>sample string 10</CornellEntity>
  <Enabled>true</Enabled>
  <ListContactDirectory_Id>f540d8d9-ad56-4504-ab63-146eaf9d376f</ListContactDirectory_Id>
  <ListContact_Id>1</ListContact_Id>
  <ListDisplayName>sample string 3</ListDisplayName>
  <ListDomainName>sample string 7</ListDomainName>
  <ListName>sample string 2</ListName>
  <MetaData xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
  <Notes>sample string 16</Notes>
  <OwnerContactDirectory_Id>3a07e18d-5265-488d-a9df-ff561f124f5a</OwnerContactDirectory_Id>
  <OwnerDisplayName>sample string 6</OwnerDisplayName>
  <OwnerEMailAddress>sample string 5</OwnerEMailAddress>
  <OwnerNetID>sample string 4</OwnerNetID>
  <Purpose>sample string 8</Purpose>
  <RequestContactDirectory_Id>d2b5d4de-666b-488c-b57c-4749efe660f1</RequestContactDirectory_Id>
  <SerializedMetaData>{}</SerializedMetaData>
  <SponsorNetID>sample string 9</SponsorNetID>
  <WhenCreated>2024-11-26T18:39:42.4738115-05:00</WhenCreated>
  <WhenModified>2024-11-26T18:39:42.4738115-05:00</WhenModified>
</ElistContact>