GetContent
Endpoint URL |
https://www.yournetosite.com.au/do/WS/NetoAPI |
Method |
POST |
XML Headers |
NETOAPI_ACTION |
GetContent |
NETOAPI_USERNAME |
Your Neto Username (generate this in your Neto control panel) |
NETOAPI_KEY |
Your Neto API Secure Key (generate this in your Neto control panel) |
|
JSON Headers |
NETOAPI_ACTION |
GetContent |
NETOAPI_USERNAME |
Your Neto Username (generate this in your Neto control panel) |
NETOAPI_KEY |
Your Neto API Secure Key (generate this in your Neto control panel) |
Accept |
application/json |
|
Description |
Use this call to get product content data. A successful call to GetContent returns the data requested. |
XSD Schema |
GetContent XSD | GetContent Response XSD
|
GetContent Post
You must specify at least one filter and one OutputSelector in your GetContent request. These will determine the results returned.
XML POST
<?xml version="1.0" encoding="utf-8"?>
<GetContent>
<Filter>
<ContentID>(Integer)</ContentID>
<ParentContentID>(Integer)</ParentContentID>
<ContentName>(String)</ContentName>
<Active>(Boolean)</Active>
<ContentType>(String)</ContentType>
<OnSiteMap>(Boolean)</OnSiteMap>
<OnMenu>(Boolean)</OnMenu>
<AllowReviews>(Boolean)</AllowReviews>
<RequireLogin>(Boolean)</RequireLogin>
<DatePostedFrom>(DateTime)</DatePostedFrom>
<DatePostedTo>(DateTime)</DatePostedTo>
<DateUpdatedFrom>(DateTime)</DateUpdatedFrom>
<DateUpdatedTo>(DateTime)</DateUpdatedTo>
<Page>(Integer)</Page>
<Limit>(Integer)</Limit>
<OutputSelector>ContentID</OutputSelector>
<OutputSelector>ID</OutputSelector>
<OutputSelector>ContentName</OutputSelector>
<OutputSelector>ContentType</OutputSelector>
<OutputSelector>ParentContentID</OutputSelector>
<OutputSelector>Active</OutputSelector>
<OutputSelector>SortOrder</OutputSelector>
<OutputSelector>OnSiteMap</OutputSelector>
<OutputSelector>OnMenu</OutputSelector>
<OutputSelector>AllowReviews</OutputSelector>
<OutputSelector>ContentReference</OutputSelector>
<OutputSelector>ShortDescription1</OutputSelector>
<OutputSelector>ShortDescription2</OutputSelector>
<OutputSelector>ShortDescription3</OutputSelector>
<OutputSelector>Description1</OutputSelector>
<OutputSelector>Description2</OutputSelector>
<OutputSelector>Description3</OutputSelector>
<OutputSelector>Author</OutputSelector>
<OutputSelector>ContentURL</OutputSelector>
<OutputSelector>Label1</OutputSelector>
<OutputSelector>Label2</OutputSelector>
<OutputSelector>Label3</OutputSelector>
<OutputSelector>SEOMetaDescription</OutputSelector>
<OutputSelector>SEOMetaKeywords</OutputSelector>
<OutputSelector>SEOPageHeading</OutputSelector>
<OutputSelector>SEOPageTitle</OutputSelector>
<OutputSelector>SEOCanonicalURL</OutputSelector>
<OutputSelector>SearchKeywords</OutputSelector>
<OutputSelector>HeaderTemplate</OutputSelector>
<OutputSelector>BodyTemplate</OutputSelector>
<OutputSelector>FooterTemplate</OutputSelector>
<OutputSelector>SearchResultsTemplate</OutputSelector>
<OutputSelector>RelatedContents</OutputSelector>
<OutputSelector>ExternalSource</OutputSelector>
<OutputSelector>ExternalReference1</OutputSelector>
<OutputSelector>ExternalReference2</OutputSelector>
<OutputSelector>ExternalReference3</OutputSelector>
<OutputSelector>DatePosted</OutputSelector>
<OutputSelector>DatePostedLocal</OutputSelector>
<OutputSelector>DatePostedUTC</OutputSelector>
<OutputSelector>DateUpdated</OutputSelector>
<OutputSelector>DateUpdatedLocal</OutputSelector>
<OutputSelector>DateUpdatedUTC</OutputSelector>
</Filter>
</GetContent>
JSON POST
{
"Filter": {
"ContentID":["Integer"/*, ...*/],
"ParentContentID":["Integer"/*, ...*/],
"ContentName":["String"/*, ...*/],
"Active":"Boolean",
"ContentType":"String",
"OnSiteMap":"Boolean",
"OnMenu":"Boolean",
"AllowReviews":"Boolean",
"RequireLogin":"Boolean",
"DatePostedFrom":"DateTime",
"DatePostedTo":"DateTime",
"DateUpdatedFrom":"DateTime",
"DateUpdatedTo":"DateTime",
"Page":"Integer",
"Limit":"Integer",
"OutputSelector":["Enumeration"/*, ...*/]
}
}
<Filter>
Element Name |
Required |
Field Type / Options |
ContentID |
Optional Supports Multiple Elements |
Integer |
ParentContentID |
Optional Supports Multiple Elements |
Integer |
ContentName |
Optional Supports Multiple Elements |
String(100) |
Active |
Optional |
Boolean(True, False) |
ContentType |
Optional |
String(50) |
OnSiteMap |
Optional |
Boolean(True, False) |
OnMenu |
Optional |
Boolean(True, False) |
AllowReviews |
Optional |
Boolean(True, False) |
RequireLogin |
Optional |
Boolean(True, False) |
DatePostedFrom |
Optional |
DateTime |
DatePostedTo |
Optional |
DateTime |
DateUpdatedFrom |
Optional |
DateTime |
DateUpdatedTo |
Optional |
DateTime |
Page |
Optional |
Integer |
Limit |
Optional |
Integer |
<OutputSelector>
Determines what is returned by the POST. Refer to the example response below this table or the related XSD schema for details and restrictions of each output element.
Note: Each OutputSelector should be a separate element in your post.
OutputSelector |
Enumeration (ContentID, ID, ContentName, ContentType, ParentContentID, Active, SortOrder, OnSiteMap, OnMenu, AllowReviews, ContentReference, ShortDescription1, ShortDescription2, ShortDescription3, Description1, Description2, Description3, Author, ContentURL, Label1, Label2, Label3, SEOMetaDescription, SEOMetaKeywords, SEOPageHeading, SEOPageTitle, SEOCanonicalURL, SearchKeywords, HeaderTemplate, BodyTemplate, FooterTemplate, SearchResultsTemplate, RelatedContents, ExternalSource, ExternalReference1, ExternalReference2, ExternalReference3, DatePosted, DatePostedLocal, DatePostedUTC, DateUpdated, DateUpdatedLocal, DateUpdatedUTC) |
GetContent Responses
XML Response
<?xml version="1.0" encoding="utf-8"?>
<GetContent>
<Content>
<ID>(Integer)</ID>
<ContentID>(Integer)</ContentID>
<ContentName>(String)</ContentName>
<ParentContentID>(Integer)</ParentContentID>
<Active>(Boolean)</Active>
<SortOrder>(Integer)</SortOrder>
<OnSiteMap>(Boolean)</OnSiteMap>
<OnMenu>(Boolean)</OnMenu>
<AllowReviews>(Boolean)</AllowReviews>
<RequireLogin>(String)</RequireLogin>
<ContentReference>(String)</ContentReference>
<ShortDescription1>(String)</ShortDescription1>
<ShortDescription2>(String)</ShortDescription2>
<ShortDescription3>(String)</ShortDescription3>
<Description1>(String)</Description1>
<Description2>(String)</Description2>
<Description3>(String)</Description3>
<Author>(String)</Author>
<ContentURL>(String)</ContentURL>
<Label1>(String)</Label1>
<Label2>(String)</Label2>
<Label3>(String)</Label3>
<SEOMetaDescription>(String)</SEOMetaDescription>
<SEOMetaKeywords>(String)</SEOMetaKeywords>
<SEOPageHeading>(String)</SEOPageHeading>
<SEOPageTitle>(String)</SEOPageTitle>
<SEOCanonicalURL>(String)</SEOCanonicalURL>
<SearchKeywords>(String)</SearchKeywords>
<HeaderTemplate>(String)</HeaderTemplate>
<BodyTemplate>(String)</BodyTemplate>
<FooterTemplate>(String)</FooterTemplate>
<SearchResultsTemplate>(String)</SearchResultsTemplate>
<RelatedContents>
<RelatedContent>
<ContentID>(Integer)</ContentID>
</RelatedContent>
</RelatedContents> <ExternalSource>(String)</ExternalSource>
<ExternalReference1>(String)</ExternalReference1>
<ExternalReference2>(String)</ExternalReference2>
<ExternalReference3>(String)</ExternalReference3>
<DatePosted>(DateTime)</DatePosted>
<DatePostedLocal>(DateTime)</DatePostedLocal>
<DatePostedUTC>(DateTime)</DatePostedUTC>
<DateUpdated>(DateTime)</DateUpdated>
<DateUpdatedLocal>(DateTime)</DateUpdatedLocal>
<DateUpdatedUTC>(DateTime)</DateUpdatedUTC>
</Content>
<Messages>
<Error>
<Message>(String)</Message>
<SeverityCode>(String)</SeverityCode>
<Description>(String)</Description>
</Error>
<Warning>
<Message>(String)</Message>
<SeverityCode>(String)</SeverityCode>
</Warning>
</Messages>
</GetContent>
JSON Response
{
"Content": [ {
"ID":"Integer",
"ContentID":"Integer",
"ContentName":"String",
"ParentContentID":"Integer",
"Active":"Boolean",
"SortOrder":"Integer",
"OnSiteMap":"Boolean",
"OnMenu":"Boolean",
"AllowReviews":"Boolean",
"RequireLogin":"String",
"ContentReference":"String",
"ShortDescription1":"String",
"ShortDescription2":"String",
"ShortDescription3":"String",
"Description1":"String",
"Description2":"String",
"Description3":"String",
"Author":"String",
"ContentURL":"String",
"Label1":"String",
"Label2":"String",
"Label3":"String",
"SEOMetaDescription":"String",
"SEOMetaKeywords":"String",
"SEOPageHeading":"String",
"SEOPageTitle":"String",
"SEOCanonicalURL":"String",
"SearchKeywords":"String",
"HeaderTemplate":"String",
"BodyTemplate":"String",
"FooterTemplate":"String",
"SearchResultsTemplate":"String",
"RelatedContents": {
"RelatedContent": [ {
"ContentID":"Integer"
} ]
} , "ExternalSource":"String",
"ExternalReference1":"String",
"ExternalReference2":"String",
"ExternalReference3":"String",
"DatePosted":"DateTime",
"DatePostedLocal":"DateTime",
"DatePostedUTC":"DateTime",
"DateUpdated":"DateTime",
"DateUpdatedLocal":"DateTime",
"DateUpdatedUTC":"DateTime"
} ] , "Messages": {
"Error": [ {
"Message":"String",
"SeverityCode":"String",
"Description":"String"
} ] , "Warning": [ {
"Message":"String",
"SeverityCode":"String"
} ]
}
}
<Content>
<RelatedContents>
<RelatedContent>
Element Name |
Field Type |
ContentID |
Integer |
<Messages>
<Error>
<Warning>
If you are a vendor creating an integration with Neto by Maropost, we would like to hear from you!
Contact Us