You are here: Access Rights

Access Rights

 

 

Starting with ListManager 10.0, a user has to be a list admin of at least one list in order to use API functions (i.e., all API functions require authentication). Some administration functions may require additional information or administrative access beyond the list administrator level. An http 401 (authentication) error will be returned if the user does not have privilege to access a particular function.

 

Name of the function

Version

List Site Server Listname Required Return Value Data Type

ApiVersion

LM 8.1

  Current API version string

CheckMemberPassword

LM 8.1

True if password match member bool

CopyMember

LM 8.1

Member ID of the new copied member created int

CreateContent

LM 10.0

  Returns an ID number of a content created or raises error with a verbose message int

CreateList

LM 8.1

  New List ID int

CreateListAdmin

LM 8.1

New Member ID int

CreateManyMembers

LM 8.1

Number of members created int

CreateMemberBan

LM 8.1

New member ID int

CreateMemberColumn

LM 9.1 / 1.5.1

      Success flag – true if update successful bool

CreateSegment

LM 9.1 / 1.5.1 New segment ID int

CreateServerAdmin

LM 10.0

      Returns an ID number of a server admin created or raises error with a vergose message int

CreateSingleMember

LM 8.1

New Member ID int

CreateSite

LM 10.0

      ID of the site created int

CreateSiteAdmin

LM 10.0

    Returns an Id number of a server admin created or raises error with a verbose message int

CreateTopic

LM 10.0

    Returns true if succeeds, raises error with a vergose message otherwise bool

CurrentUserEmailAddress

LM 8.1

  User's e-mail address string

DeleteContent

LM 10.0

  Returns true if succeeds, raises error with a verbose message  otherwise bool

DeleteList

LM 8.1

  Success flag--true if update successful bool

DeleteMemberColumn

LM 9.1 / 1.5.1       Success flag – true if update successful bool

DeleteMembers

LM 8.1

Number of members successfully deleted int

DeleteSegment

LM 9.1 / 1.5.1 Success flag – true if update successful bool

DeleteServerAdmin

LM 10.0

      Returns true if succeeds, raises error with a verbose message  otherwise bool

DeleteSite

LM 10.0

    Returns true if succeeds, raises error with a verbose message otherwise bool

DeleteSiteAdmin

LM 10.0

    Returns true if succeeds, raises error with a verbose message  otherwise bool

DeleteTopic

LM 10.0

    Returns true if succeeds, raises error with a verbose message  otherwise bool

EmailOnWhatLists

LM 8.1

  A list of lists which contain given e-mail address ArrayOfString

EmailPasswordOnWhatLists

LM 8.1

  A list of lists which contain given e-mail address ArrayOfString

GetEmailFromMemberID

LM 8.1

  E-mail corresponding to the ID string

GetListID

LM 8.1

List ID int

GetListnameFromMemberID

LM 8.1

  ListName a member ID belongs to string

GetMemberID             

LM 8.1

  Member ID int

GetPreviewMailing

LM 10.0

  Returns a merged text as string or raises error with verbose message string

ImportContent

LM 8.1

  Content corresponding to the ID given SimpleMailingStruct

MailingStatus

LM 8.1

  Transact log for the given mailing ID string

ModerateMailing

LM 8.1

Mailing ID of the scheduled mailing int

ScheduleMailing

LM 8.1

Mailing ID of the scheduled mailing int

SelectContent

LM 8.1

  An array of content matching criteria ArrayOfContentStruct

SelectLists

LM 8.1

  An array of list struct matching criteria ArrayOfListStruct

SelectListsEx

LM 10.0

  Result set from the query selecting lists or NULL if no records returned. First row contains column names which should be mapped to a more readable form. ArrayOfArrayOfString

SelectMembers

LM 8.1

An array of members matching criteria ArrayOfMemberStruct

SelectSegments

LM 8.1

Array of segment struct matching criteria ArrayOfSegmentStruct

SelectSimpleMembers

LM 8.1

An array of members matching criteria ArrayOfSimpleMemberStruct

SendMailing

LM 8.1

Mailing ID of the sent mailing int

SendMailingDirect

LM 8.1 Mailing ID of the scheduled mailing int

SendMemberDoc

LM 8.1   Mailing ID of the sent document to member int

SendMessage

LM 9.1 / 1.5.1

ID of the Message sent int

SqlDelete

LM 8.1

      Success flag--true if update successful bool

SqlInsert

LM 8.1

      Identity of the row created int

SqlSelect

LM 8.1

      Result set from the query or NULL if no records returned. First row contains column names.

ArrayOfArrrayOfString

SqlUpdate

LM 8.1       Success flag--true if update successful bool

TrackingSummary

LM 8.1   Tracking summary requested for given outmailID TrackingSummaryStruct

UnSubscribe

LM 8.1 Number of members unsubscribed int

UpdateContent

LM 10.0

  Returns true if succeeds, raises error with a verbose message  otherwise bool

UpdateList

LM 8.1   Success flag – true if update successful bool

UpdateListAdmin

LM 8.1 Success flag – true if update successful bool

UpdateMemberDemographics

LM 8.1 Success flag – true if update successful bool

UpdateMemberEmail

LM 8.1 Success flag--true if update successful bool

UpdateMemberKind

LM 8.1 Success flag – true if update successful bool

UpdateMemberPassword

LM 8.1 Success flag--true if update successful bool

UpdateMemberStatus

LM 8.1 Success flag – true if update successful bool

UpdateSegment

LM 9.1 / 1.5.1     Success flag – true if update successful bool

UpdateServerAdmin

LM 10.0

      Returns true if succeeds, raises error with a verbose message  otherwise bool

UpdateSite

LM 10.0

    Returns true if succeeds, raises error with a verbose message otherwise bool

UpdateSiteAdmin

LM 10.0

    Returns true if succeeds, raises error with a verbose message  otherwise bool

UpdateTopic

LM 10.0

    Returns true if succeeds, raises error with a verbose message  otherwise bool