REST API: Lists

This lookup endpoint is used to return the permissible values for List Codes. Only the GET on the set is supported. Api key required.

Resource URI

Only the set is used

Resource Properties

Parameter

Format

Description

Allows Null

code string unique identifier  no
description  string  description   no
       
       
       
       
       
       

Error Responses


REST API: Lists Set

Set of List codes and their descriptions/

Resource URI

/V1/Lists/?api_key=xxxxxx

Set Filters

ParameterFormatDescriptionAllows Null
none      

HTTP GET

Return a list of Listcodes.

JSON Request:

Request body empty.

JSON Response:

[{
"code": "C",
"description": "No Appeals"
}, {
"code": "C1",
"description": "Send only one appeal per year"
}, {
"code": "EAPP",
"description": "email append - Oct 2010"
}, {
"code": "MINQ",
"description": "Inquiry for membership materials"
}, {
"code": "N1",
"description": "Send only one renewal notice"
}, {
"code": "NG",
"description": "No \"thank you\" gifts"
}, {
"code": "NOANSW",
"description": "Has not responded to opt-in or opt-out"
}, {
"code": "NOCALL",
"description": "No Call"
}, {
"code": "NOEMA",
"description": "No Email"
}, {
"code": "NOMAIL",
"description": "No Mail"
}, {
"code": "NOTRAD",
"description": "No Trade"
}, {
"code": "NOVEN",
"description": "No vendor mailings (do not give to affinity programs)"
}, {
"code": "NR",
"description": "No direct mail renewals"
}, {
"code": "OPTGEN",
"description": "Yes, please send me trail updates and news from RTC."
}, {
"code": "SEED",
"description": "Seed names to track mailings"
}, {
"code": "SPAM",
"description": "Reported as SPAM"
}]

XML Request:

Request body empty.

XML Response: