Aurora API: Content

Content

Using this controller you can add, edit, delete and retrieve all content pages.

Add

Deferred: No

Example Request:

<?xml version="1.0" encoding="utf-8"?>
<AuroraRequestEnvelope>
  <Header>
    <AuthToken>...</AuthToken>
  </Header>
  <Requests>
    <Request>
      <Content>
        <Add>
          <PageType>news</PageType>
          <PageStatus>live</PageStatus>
          <PageTitle>The page title</PageTitle>
          <PageTitle language="de">Der Seitentitel</PageTitle>
          <PageFilename>my-page</PageFilename>
          <PageContent>The page content.</PageContent>
          <PageIntroduction></PageIntroduction>
          <PageTemplate>0</PageTemplate>
          <PagePassword>123</PagePassword>
          <PageOrder>10</PageOrder>
          <PageCanonical>/my-page</PageCanonical>
          <MetaDescription>This is my page.</MetaDescription>
          <MetaKeywords>great, excellent, awesome, page</MetaKeywords>
          <MetaRobots>noindex, nofollow</MetaRobots>
          <MembersOnly>0</MembersOnly>
          <DisplayInMenu>1</DisplayInMenu>
          <ShowInSitemap>1</ShowInSitemap>
          <UseWYSIWYG>1</UseWYSIWYG>
          <EnableSmarty>1</EnableSmarty>
          <CategoryIDs>
            <CategoryID>2</CategoryID>
            <CategoryID>5</CategoryID>
          </CategoryIDs>
          <Tags>
            <Tag>
              <TagName>Work</TagName>
              <TagURL></TagURL>
            </Tag>
            <Tag>
              <TagName>Staff</TagName>
              <TagURL></TagURL>
            </Tag>
          </Tags>
          <Fields>
            <Field>
              <FieldName>First Field</FieldName>
              <FieldValue>One value</FieldValue>
            </Field>
            <Field>
              <FieldName>Second Field</FieldName>
              <FieldValue>Two value</FieldValue>
            </Field>
          </Fields>
        </Add>
      </Content>
    </Request>
  </Requests>
</AuroraRequestEnvelope>

Example Response:

<?xml version="1.0" encoding="utf-8"?>
<AuroraResponseEnvelope>
  <Header>
    <Summary>
      <Ack>OK</Ack>
      <RequestsProcessed>1</RequestsProcessed>
      <RequestsSucceeded>1</RequestsSucceeded>
      <RequestErrors>0</RequestErrors>
    </Summary>
  </Header>
  <Responses>
    <Response>
      <RequestID>1</RequestID>
      <Ack>OK</Ack>
      <Data>
        <ContentID>416</ContentID>
      </Data>
    </Response>
  </Responses>
</AuroraResponseEnvelope>

Request Fields

Field	Values	API Version	Description	Required
UseWYSIWYG	[0\1]	1.4+	Whether or not the Snippet should use the WYSIWYG Editor	No, may only include one of UseWYSIWYG or UsePageBuilder
UsePageBuilder	[0\1]	1.4+	Whether or not the Snippet should use the Page Builder (Beta)	No, may only include one of UseWYSIWYG or UsePageBuilder

Update

Deferred: No

The 'Update' call is almost identical to the 'Add' call with the only real difference being that most of the fields are now optional. While adding a new item requires that you provide all necessary information at once, when using the 'Update' method, you can just provide the information you wish to change and leave out all of the rest (excluding the relevant ID fields of course which are used to identify the records to be updated).

Example Request:

<?xml version="1.0" encoding="utf-8"?>
<AuroraRequestEnvelope>
  <Header>
    <AuthToken>...</AuthToken>
  </Header>
  <Requests>
    <Request>
      <Content>
        <Update>
          <ContentID>416</ContentID>
          <PageContent>The alternative page content.</PageContent>
          <Tags>
          </Tags>
        </Update>
      </Content>
    </Request>
  </Requests>
</AuroraRequestEnvelope>

Example Response:

<?xml version="1.0" encoding="utf-8"?>
<AuroraResponseEnvelope>
  <Header>
    <Summary>
      <Ack>OK</Ack>
      <RequestsProcessed>1</RequestsProcessed>
      <RequestsSucceeded>1</RequestsSucceeded>
      <RequestErrors>0</RequestErrors>
    </Summary>
  </Header>
  <Responses>
    <Response>
      <RequestID>1</RequestID>
      <Ack>OK</Ack>
      <Data>
        <ContentID>416</ContentID>
      </Data>
    </Response>
  </Responses>
</AuroraResponseEnvelope>

Delete

Deferred: No

Example Request:

<?xml version="1.0" encoding="utf-8"?>
<AuroraRequestEnvelope>
  <Header>
    <AuthToken>...</AuthToken>
  </Header>
  <Requests>
    <Request>
      <Content>
        <Delete>
          <ContentIDs>
            <ContentID>416</ContentID>
          </ContentIDs>
        </Delete>
      </Content>
    </Request>
  </Requests>
</AuroraRequestEnvelope>

Example Response:

<?xml version="1.0" encoding="utf-8"?>
<AuroraResponseEnvelope>
  <Header>
    <Summary>
      <Ack>OK</Ack>
      <RequestsProcessed>1</RequestsProcessed>
      <RequestsSucceeded>1</RequestsSucceeded>
      <RequestErrors>0</RequestErrors>
    </Summary>
  </Header>
  <Responses>
    <Response>
      <RequestID>1</RequestID>
      <Ack>OK</Ack>
      <Data/>
    </Response>
  </Responses>
</AuroraResponseEnvelope>

Request Fields

Field	Values	API Version	Description	Required
ContentIDs	Container	1.4+		No
ContentIDs.ContentID	Integer	1.4+	The ID of the content to delete.	Only if 'ContentIDs' is provided

Get

Deferred: No

Records returned by this call are currently always ordered by the date they were created. This may change, so you should consider specifying the sort order of your results if this is going to affect your systems performance in the future.

The 'tracking' attribute can be used to denote whether or not tracking should be enabled, please see Request Tracking for more details.

Example Request:

 <?xml version="1.0" encoding="utf-8"?>
<AuroraRequestEnvelope>
  <Header>
    <AuthToken>...</AuthToken>
  </Header>
  <Requests>
    <Request>
      <Content>
        <Get>
          <Language>all</Language>
          <Limit>10</Limit>
          <Paging>
            <Limit>1</Limit>
            <Page>1</Page>
          </Paging>
        </Get>
      </Content>
    </Request>
  </Requests>
</AuroraRequestEnvelope>

Example Response:

 <?xml version="1.0" encoding="utf-8"?>
<AuroraResponseEnvelope>
  <Header>
    <Summary>
      <Ack>OK</Ack>
      <RequestsProcessed>1</RequestsProcessed>
      <RequestsSucceeded>1</RequestsSucceeded>
      <RequestErrors>0</RequestErrors>
    </Summary>
  </Header>
  <Responses>
    <Response>
      <RequestID>1</RequestID>
      <Ack>OK</Ack>
      <Paging>
        <Token>f430f31c8b20f81d7b063eb9f256d30d100</Token>
      </Paging>
      <Data>
        <Content>
          <ContentID>416</ContentID>
          <PageType>news</PageType>
          <PageStatus>live</PageStatus>
          <PageTitle language="en-gb">My page</PageTitle>
          <PageTitle language="de">Der Seitentitel</PageTitle>
          <PageFilename>test-post</PageFilename>
          <PageContent language="en-gb">The page content.</PageContent>
          <PageContent language="de">The page content.</PageContent>
          <PageIntroduction language="en-gb"/>
          <PageIntroduction language="de"/>
          <PageTemplate>0</PageTemplate>
          <PagePassword>123</PagePassword>
          <PageOrder>0</PageOrder>
          <PageCanonical/>
          <MetaDescription language="en-gb">This is my page.</MetaDescription>
          <MetaDescription language="de">This is my page.</MetaDescription>
          <MetaKeywords language="en-gb">great, excellent, awesome, page</MetaKeywords>
          <MetaKeywords language="de">great, excellent, awesome, page</MetaKeywords>
          <MetaRobots>noindex, nofollow</MetaRobots>
          <MembersOnly>0</MembersOnly>
          <DisplayInMenu>1</DisplayInMenu>
          <ShowInSitemap>1</ShowInSitemap>
          <UseWYSIWYG>1</UseWYSIWYG>
          <UsePageBuilder>0</UsePageBuilder>
          <EnableSmarty>1</EnableSmarty>
          <CategoryIDs>
            <CategoryID>2</CategoryID>
            <CategoryID>5</CategoryID>
          </CategoryIDs>
          <Tags>
            <Tag>
              <TagName language="en-gb">Work</TagName>
              <TagName language="de">Arbeiten</TagName>
              <TagURL language="en-gb"/>
              <TagURL language="de"/>
            </Tag>
            <Tag>
              <TagName language="en-gb">Staff</TagName>
              <TagName language="de">Mitarbeiter</TagName>
              <TagURL language="en-gb"/>
              <TagURL language="de"/>
            </Tag>
          <Fields>
            <Field>
              <FieldName language="en-gb">Test Field 1</FieldName>
              <FieldName language="de">Test Field 1</FieldName>
              <FieldValue language="en-gb">One value</FieldValue>
              <FieldValue language="de">One value</FieldValue>
            </Field>
            <Field>
              <FieldName language="en-gb">Test Field 2</FieldName>
              <FieldName language="de">Test Field 2</FieldName>
              <FieldValue language="en-gb">Two value</FieldValue>
              <FieldValue language="de">Two value</FieldValue>
            </Field>
          </Fields>
          </Tags>
        </Content>
      </Data>
    </Response>
  </Responses>
</AuroraResponseEnvelope>

Request Fields

Field	Values	API Version	Description	Required
ContentIDs	Container	1.4+		No
ContentIDs.ContentID	Integer	1.4+	The ID to restrict the result to.	Only if 'ContentIDs' is provided
DetailLevel	Detail Levels	1.4+	This allows the client to request varying volumes of data when receiving data back from the server.	No
Language	"all" or language ISO	1.4+	This allows the client to request specific or all languages to be returned. If not included in the request the default language will be returned.	No
Tracking	Request Tracking	1.4+	If this is set to 'unsent' then any orders previously retrieved via the current API account while 'tracking' was active will be excluded from the results. This allow for unique order exports to be set-up easily to avoid duplicate orders being downloaded.	No
Limit	Integer > 0	1.4+	The number of products to return before beginning to page	No
Paging	Container	1.4+	See Paging	No
Paging.Token	String	1.4+	This is the Token string issued from any previous OrderGet call featuring paging. Providing this will have the API collect the data from the previously generated set of data, ensuring accurate and consistent dataset results for every page. You cannot change the request properties previously provided when using a Token, so these are ignored by the API.	No
Paging.Limit	Integer > 0	1.4+	The number of results to return in the page being requested	No
Paging.Page	Integer > 0	1.4+	The page number to return the results for	Only if 'Token' is provided