Reference for http://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{ID_LIST}
Retrieve list details by list id.
Url: http://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{ID_LIST}
HTTP Method: GET
This operation supports JSONP responses. The callback function can be specified using the "callback" Url query parameter.
Message direction | Format | Body |
---|---|---|
Request | N/A | The Request body is empty. |
Response | Xml | Example,Schema |
Response | Json | Example |
The following is an example response Xml body:
<ConsoleListDetailFields xmlns="http://MailupSoa.Ws.Schema.API.Console"> <BouncedEmail>String content</BouncedEmail> <Charset>String content</Charset> <ConversionlabTrackCode>String content</ConversionlabTrackCode> <DefaultPrefix>String content</DefaultPrefix> <Description>String content</Description> <Disclaimer>String content</Disclaimer> <Format>String content</Format> <FrontendForm>true</FrontendForm> <HeaderListUnsubscriber>String content</HeaderListUnsubscriber> <HeaderXAbuse>String content</HeaderXAbuse> <KBMax>2147483647</KBMax> <LinkTrackingParameters>String content</LinkTrackingParameters> <MultiOptoutList>String content</MultiOptoutList> <MultipartText>true</MultipartText> <NotifyEmail>String content</NotifyEmail> <OptoutType>2147483647</OptoutType> <Public>true</Public> <ScopeCode>2147483647</ScopeCode> <SendConfirmSms>true</SendConfirmSms> <SendEmailOptout>true</SendEmailOptout> <SmsSenderName>String content</SmsSenderName> <SubscribedEmail>true</SubscribedEmail> <TimeZoneCode>String content</TimeZoneCode> <TrackOnOpened>true</TrackOnOpened> <Address>String content</Address> <Business>true</Business> <City>String content</City> <CompanyName>String content</CompanyName> <ContactName>String content</ContactName> <CountryCode>String content</CountryCode> <Customer>true</Customer> <DisplayAs>String content</DisplayAs> <IdList>2147483647</IdList> <ListGuid>String content</ListGuid> <NLSenderName>String content</NLSenderName> <Name>String content</Name> <OwnerEmail>String content</OwnerEmail> <PermissionReminder>String content</PermissionReminder> <Phone>String content</Phone> <PostalCode>String content</PostalCode> <ReplyTo>String content</ReplyTo> <StateOrProvince>String content</StateOrProvince> <WebSiteUrl>String content</WebSiteUrl> </ConsoleListDetailFields>
The following is an example response Json body:
{ "BouncedEmail":"String content", "Charset":"String content", "ConversionlabTrackCode":"String content", "DefaultPrefix":"String content", "Description":"String content", "Disclaimer":"String content", "Format":"String content", "FrontendForm":true, "HeaderListUnsubscriber":"String content", "HeaderXAbuse":"String content", "KBMax":2147483647, "LinkTrackingParameters":"String content", "MultiOptoutList":"String content", "MultipartText":true, "NotifyEmail":"String content", "OptoutType":2147483647, "Public":true, "ScopeCode":2147483647, "SendConfirmSms":true, "SendEmailOptout":true, "SmsSenderName":"String content", "SubscribedEmail":true, "TimeZoneCode":"String content", "TrackOnOpened":true, "Address":"String content", "Business":true, "City":"String content", "CompanyName":"String content", "ContactName":"String content", "CountryCode":"String content", "Customer":true, "DisplayAs":"String content", "IdList":2147483647, "ListGuid":"String content", "NLSenderName":"String content", "Name":"String content", "OwnerEmail":"String content", "PermissionReminder":"String content", "Phone":"String content", "PostalCode":"String content", "ReplyTo":"String content", "StateOrProvince":"String content", "WebSiteUrl":"String content" }
The following is the response Xml Schema:
<xs:schema xmlns:tns="http://MailupSoa.Ws.Schema.API.Console" elementFormDefault="qualified" targetNamespace="http://MailupSoa.Ws.Schema.API.Console" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="http://MailupSoa.Ws.API.Schema" /> <xs:complexType name="ConsoleListDetailFields"> <xs:complexContent mixed="false"> <xs:extension base="tns:ConsoleListFields"> <xs:sequence> <xs:element minOccurs="0" name="Address" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Business" nillable="true" type="xs:boolean" /> <xs:element minOccurs="0" name="City" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="CompanyName" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="ContactName" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="CountryCode" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Customer" nillable="true" type="xs:boolean" /> <xs:element minOccurs="0" name="DisplayAs" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="IdList" type="xs:int" /> <xs:element minOccurs="0" name="ListGuid" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="NLSenderName" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="OwnerEmail" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="PermissionReminder" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Phone" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="PostalCode" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="ReplyTo" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="StateOrProvince" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="WebSiteUrl" nillable="true" type="xs:string" /> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:element name="ConsoleListDetailFields" nillable="true" type="tns:ConsoleListDetailFields" /> <xs:complexType name="ConsoleListFields"> <xs:complexContent mixed="false"> <xs:extension xmlns:q1="http://MailupSoa.Ws.API.Schema" base="q1:BaseDataContract"> <xs:sequence> <xs:element minOccurs="0" name="BouncedEmail" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Charset" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="ConversionlabTrackCode" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="DefaultPrefix" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Description" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Disclaimer" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Format" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="FrontendForm" nillable="true" type="xs:boolean" /> <xs:element minOccurs="0" name="HeaderListUnsubscriber" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="HeaderXAbuse" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="KBMax" nillable="true" type="xs:int" /> <xs:element minOccurs="0" name="LinkTrackingParameters" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="MultiOptoutList" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="MultipartText" nillable="true" type="xs:boolean" /> <xs:element minOccurs="0" name="NotifyEmail" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="OptoutType" nillable="true" type="xs:int" /> <xs:element minOccurs="0" name="Public" nillable="true" type="xs:boolean" /> <xs:element minOccurs="0" name="ScopeCode" nillable="true" type="xs:int" /> <xs:element minOccurs="0" name="SendConfirmSms" nillable="true" type="xs:boolean" /> <xs:element minOccurs="0" name="SendEmailOptout" nillable="true" type="xs:boolean" /> <xs:element minOccurs="0" name="SmsSenderName" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="SubscribedEmail" nillable="true" type="xs:boolean" /> <xs:element minOccurs="0" name="TimeZoneCode" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="TrackOnOpened" nillable="true" type="xs:boolean" /> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:element name="ConsoleListFields" nillable="true" type="tns:ConsoleListFields" /> <xs:complexType name="ConsoleListCreateFields"> <xs:complexContent mixed="false"> <xs:extension base="tns:ConsoleListFields"> <xs:sequence> <xs:element name="Address" nillable="true" type="xs:string" /> <xs:element name="Business" nillable="true" type="xs:boolean" /> <xs:element name="City" nillable="true" type="xs:string" /> <xs:element name="CompanyName" nillable="true" type="xs:string" /> <xs:element name="ContactName" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="CopyFromWebhooks" type="xs:boolean" /> <xs:element name="CountryCode" nillable="true" type="xs:string" /> <xs:element name="Customer" nillable="true" type="xs:boolean" /> <xs:element minOccurs="0" name="DisplayAs" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="IdSettings" type="xs:int" /> <xs:element name="NLSenderName" nillable="true" type="xs:string" /> <xs:element name="Name" nillable="true" type="xs:string" /> <xs:element name="OwnerEmail" nillable="true" type="xs:string" /> <xs:element name="PermissionReminder" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Phone" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="PostalCode" nillable="true" type="xs:string" /> <xs:element name="ReplyTo" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="StateOrProvince" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="UseDefaultSettings" type="xs:boolean" /> <xs:element name="WebSiteUrl" nillable="true" type="xs:string" /> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:element name="ConsoleListCreateFields" nillable="true" type="tns:ConsoleListCreateFields" /> <xs:complexType name="ConsoleListUpdateFields"> <xs:complexContent mixed="false"> <xs:extension base="tns:ConsoleListFields"> <xs:sequence> <xs:element minOccurs="0" name="Address" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Business" nillable="true" type="xs:boolean" /> <xs:element minOccurs="0" name="City" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="CompanyName" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="ContactName" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="CountryCode" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Customer" nillable="true" type="xs:boolean" /> <xs:element minOccurs="0" name="DisplayAs" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="NLSenderName" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="OwnerEmail" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="PermissionReminder" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Phone" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="PostalCode" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="ReplyTo" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="StateOrProvince" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="WebSiteUrl" nillable="true" type="xs:string" /> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:element name="ConsoleListUpdateFields" nillable="true" type="tns:ConsoleListUpdateFields" /> </xs:schema>
Additional response Xml Schemas:
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:element name="anyType" nillable="true" type="xs:anyType" /> <xs:element name="anyURI" nillable="true" type="xs:anyURI" /> <xs:element name="base64Binary" nillable="true" type="xs:base64Binary" /> <xs:element name="boolean" nillable="true" type="xs:boolean" /> <xs:element name="byte" nillable="true" type="xs:byte" /> <xs:element name="dateTime" nillable="true" type="xs:dateTime" /> <xs:element name="decimal" nillable="true" type="xs:decimal" /> <xs:element name="double" nillable="true" type="xs:double" /> <xs:element name="float" nillable="true" type="xs:float" /> <xs:element name="int" nillable="true" type="xs:int" /> <xs:element name="long" nillable="true" type="xs:long" /> <xs:element name="QName" nillable="true" type="xs:QName" /> <xs:element name="short" nillable="true" type="xs:short" /> <xs:element name="string" nillable="true" type="xs:string" /> <xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" /> <xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" /> <xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" /> <xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" /> <xs:element name="char" nillable="true" type="tns:char" /> <xs:simpleType name="char"> <xs:restriction base="xs:int" /> </xs:simpleType> <xs:element name="duration" nillable="true" type="tns:duration" /> <xs:simpleType name="duration"> <xs:restriction base="xs:duration"> <xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" /> <xs:minInclusive value="-P10675199DT2H48M5.4775808S" /> <xs:maxInclusive value="P10675199DT2H48M5.4775807S" /> </xs:restriction> </xs:simpleType> <xs:element name="guid" nillable="true" type="tns:guid" /> <xs:simpleType name="guid"> <xs:restriction base="xs:string"> <xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" /> </xs:restriction> </xs:simpleType> <xs:attribute name="FactoryType" type="xs:QName" /> <xs:attribute name="Id" type="xs:ID" /> <xs:attribute name="Ref" type="xs:IDREF" /> </xs:schema>
<xs:schema xmlns:tns="http://MailupSoa.Ws.API.Schema" elementFormDefault="qualified" targetNamespace="http://MailupSoa.Ws.API.Schema" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:complexType name="BaseDataContract"> <xs:sequence /> </xs:complexType> <xs:element name="BaseDataContract" nillable="true" type="tns:BaseDataContract" /> </xs:schema>
<xs:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:element name="schema"> <xs:complexType /> </xs:element> </xs:schema>