Aurora API: Site Text

Site Text

Using this controller you can add, edit, delete, and retrieve all Site Text language values.

Add

Deferred: No

Example Request:

<?xml version="1.0" encoding="utf-8"?>
<AuroraRequestEnvelope>
  <Header>
    <AuthToken>...</AuthToken>
  </Header>
  <Requests>
    <Request>
      <SiteText>
        <Add>
          <Page>Checkout</Page>
          <Part>Test</Part>
          <Content language="en-gb">English version</Content>
          <Content language="de">German version</Content>
          <Content language="fr">French version</Content>
        </Add>
      </SiteText>
    </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>
        <SiteTextID>7</SiteTextID>
      </Data>
    </Response>
  </Responses>
</AuroraResponseEnvelope>

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>
      <SiteText>
        <Update>
          <SiteTextID>7</SiteTextID>
          <Content language="de">German version updated</Content>
        </Update>
      </SiteText>
    </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>
        <SiteTextID>7</SiteTextID>
      </Data>
    </Response>
  </Responses>
</AuroraResponseEnvelope>

Delete

Deferred: No

Example Request:

<?xml version="1.0" encoding="utf-8"?>
<AuroraRequestEnvelope>
  <Header>
    <AuthToken>...</AuthToken>
  </Header>
  <Requests>
    <Request>
      <SiteText>
        <Delete>
          <SiteTextIDs>
            <SiteTextID>7</SiteTextID>
          </SiteTextIDs>
        </Delete>
      </SiteText>
    </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

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 effect 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>
      <SiteText>
        <Get>
          <Paging>
            <Limit>5</Limit>
            <Page>1</Page>
          </Paging>
        </Get>
      </SiteText>
    </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>d8d56932eab84011582617d31b3f4b5a716</Token>
      </Paging>
      <Data>
        <SiteText>
          <SiteTextID>1</SiteTextID>
          <Page>content</Page>
          <Part> Copyright Information</Part>
          <Content language="en-gb">Copyright Information</Content>
          <Content language="fr"/>
          <Content language="de"/>
        </SiteText>
        <SiteText>
          <SiteTextID>2</SiteTextID>
          <Page>home</Page>
          <Part>Navigate Home</Part>
          <Content language="en-gb">Go home</Content>
          <Content language="fr"/>
          <Content language="de"/>
        </SiteText>
        <SiteText>
          <SiteTextID>7</SiteTextID>
          <Page>Checkout</Page>
          <Part>Test part</Part>
          <Content language="en-gb">English version</Content>
          <Content language="fr">French version</Content>
          <Content language="de">German version</Content>
        </SiteText>
      </Data>
    </Response>
  </Responses>
</AuroraResponseEnvelope>

Request Fields