Arlo

REST Auth API: ArchivedMessages

ArchiveMessage resources represent messages that have finished processing and are being tracked by Arlo. Each ArchivedMessage contains metadata, a link to a MailMessage resource and links to any associated Contact, Event, Order, Registration and Venue resources. You can use this resource to push messages sent through an external system so they can be tracked through Arlo.

ArchivedMessage instance resource

Resource URI

/api/2012-02-01/auth/resources/archivedmessages/{MessageID}/

General structure

<ArchivedMessage>
  <MessageID>1234</MessageID>
  <CreatedDateTime></CreatedDateTime>
  <SentDateTime></SentDateTime>
  <Status>Sent|Error</Status>
  <Description>Registration confirmation</Description>
  <ExternalMessageID>&lt;572aa9de3f1f2_3201c9b3286743d@jobs-11.mail&gt;</ExternalMessageID>
  <Link rel="self" type="application/xml" href="https://acme.example.org/api/2012-02-01/auth/resources/contacts/1234/" />
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/MailMessage" type="application/xml" title="MailMessage" href="https://acme.example.org/api/2012-02-01/auth/resources/mailmessages/1234/" />
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Contact" type="application/xml" title="AssociatedContact" href="https://acme.example.org/api/2012-02-01/auth/resources/contacts/1234/" />
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Event" type="application/xml" title="AssociatedEvent" href="https://acme.example.org/api/2012-02-01/auth/resources/events/1234/" />
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Order" type="application/xml" title="AssociatedOrder" href="https://acme.example.org/api/2012-02-01/auth/resources/orders/1234/" />
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Registration" type="application/xml" title="AssociatedRegistration" href="https://acme.example.org/api/2012-02-01/auth/resources/registrations/1234/" />
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Venue" type="application/xml" title="AssociatedVenue" href="https://acme.example.org/api/2012-02-01/auth/resources/venues/1234/" />
</ArchivedMessage>

Resource properties

Property Description
MessageID An integer value that uniquely identifies this resource within the platform. This value is read-only.
CreatedDateTime A UTC DateTime value indicating when this resource was created.
SentDateTime A UTC DateTime value indicating when this resource was sent.
Status The status of the message, one of either Sent or Error.
Description A string describing the message, usually the subject of the message, up to 512 characters long.
ExternalMessageID If the message was sent via an external system, this is the unqiue ID of the message with respect to that system.
Link (title) Description
MailMessage The MailMessage resource that is tracked by this resource.
AssociatedContact Any associated Contact resources.
AssociatedEvent Any associated Event resources.
AssociatedOrder Any associated Order resources.
AssociatedRegistration Any associated Registration resources.
AssociatedVenues Any associated Venue resources.

HTTP GET

Returns a representation of an ArchivedMessage, including the properties and links above. Expansion of the MailMessage link is not supported.

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.

ArchivedMessage collection resource

The ArchivedMessage collection resource represents the set of ArchivedMessage resources on the platform.

Resource URI

/api/2012-02-01/auth/resources/archivedmessages/

HTTP GET

Not supported.

HTTP POST

Creates a new ArchivedMessage in the collection.

The submitted ArchivedMessage representation must be complete with inline representations of MailMessages and Attachments, but must not include system-managed properties:

  • MailMessageID
Response

See HTTP response status codes for a general overview of all possible API status codes. Common response codes for POST operations are listed below.

Status Description
201 Created Resource was successfully created. The body of the response will contain the new resource.
400 Bad Request HTTP request body contains malformed or invalid parameters.
409 Conflict Resource could not be created because it contains values that conflict with those on the server. A 409 Conflict will be returned if an ExternalMessageID is provided that already exists in the system.
Example

Create a new ArchivedMessage, including an inline MailMessage with an Attachment.

The API response will include a representation of the ArchivedMessage, including newly-generated values for MessageID.

POST https://demo.arlo.co/api/2012-02-01/auth/resources/archivedmessages/ HTTP/1.1
Accept: application/xml
Accept-Encoding: gzip, deflate
Content-Type: application/xml

<ArchivedMessage>
  <CreatedDateTime>2011-10-17T03:51:29.577Z</CreatedDateTime>
  <SentDateTime>2011-10-17T03:51:29.577Z</SentDateTime>
  <Description>Registration confirmation</Description>
  <ExternalMessageID>&lt;572aa9de3f1f2_3201c9b3286743d@jobs-11.mail&gt;</ExternalMessageID>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/MailMessage" type="application/xml" title="MailMessage">
    <MailMessage>
      <To>
        <Address>Jordan Mechner &lt;jordan.mechner@example.org&gt;</Address>
        <Address>Sally Mechner &lt;sally.mechner@example.org&gt;</Address>
      </To>
      <CC>
        <Address>Bob Hoskins &lt;bob.hoskins@example.org&gt;</Address>
        <Address>Mike Hoskins &lt;mike.hoskins@example.org&gt;</Address>
      </CC>
      <Bcc>
        <Address>Jordan Mechner &lt;jordan.mechner@example.org&gt;</Address>
      </Bcc>
      <Subject>My test message</Subject>
      <ReplyTo>
        <Address>Jordan Mechner &lt;jordan.mechner@example.org&gt;</Address>
      </ReplyTo>
      <From>Jordan Mechner &lt;jordan.mechner@example.org&gt;</From>      
      <Body>
        <View>
          <ContentType>text/html</ContentType>
          <Content>
            &lt;p&gt;Please find attached your invoice.&lt;/p&gt;
          </Content>
        </View>
        <View>
          <ContentType>text/plain</ContentType>
          <Content>
            Please find attached your invoice.
          </Content>
        </View>
      </Body>
      <Attachments>
        <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Attachments" type="application/xml" title="Attachments">
          <Attachment>
            <Name>Invoice-C07123.pdf</Name>
            <ContentType>application/x-pdf</ContentType>
            <ContentEncoding>Base64</ContentEncoding>
            <Content>
              hX6VYoTG6n+suzKhPl35rI+Bsef8FwVKDYlzEJ2i5HLKa38SLLrE9bW9jViSR1PJGsDmNOEgWu+6
              HdYm9SsRDcvDlZAdMXAiHBmq6BZXnj0w87YbdMnB0e2fyUY6ZkiHw+A0oNWCnJLME9/6vJUGsnPL
              TEw4YI0fX5ZUvItt0skSSmI5EhaZn09gWEBKRjXVoGCOWVlXbOURkOcbemhsF1pGsRE2WKiOSvsr
              Xj/5swkAA5csea1TW5mQ1qe7GBls6QBYapkxEMmJxXvatxFWjHVT3lKV0YVR3SI2CxOBePUgWxiL
              ZkQccl+PGBWmkD7vW62bu1Lkp8edf7R/E653pi+e4WjLkN2wKl1uBbRroFsT71NzNBalvR/ZkFaa
              2I04koI49ijYuqNojN5PoutNAVijyJDA9xMn1Z5UTdUB7LNerWiU64fUl+cgCC1g+nU2IOH7MEbv
              gT0Mr5V+XAeLJUJSkFmxqg75U+mnUkpFF2dJiWivjvnuFO+khdjbVYNMD11n4fCQvN9AywzH23uo
              03iOY1uv27ENeBfieFxiRwFfEkPDgTyIL3W6zgL0MEvxetk5kc0EJTlhvin7PwD/BtosN2dlfPvw
              cjTKbdf43fru+WnFknH4cQq1LzN/foZqp+4FmoLjCvda21+Ckediz5mOhl0Gzuof8AuDFvReF5OU
            </Content>
          </Attachment>
        </Link>
      </Attachments>
    </MailMessage>
  </Link>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Contact" type="application/xml" title="AssociatedContact" href="https://acme.example.org/api/2012-02-01/auth/resources/contacts/1234/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Event" type="application/xml" title="AssociatedEvent" href="https://acme.example.org/api/2012-02-01/auth/resources/events/1234/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Order" type="application/xml" title="AssociatedOrder" href="https://acme.example.org/api/2012-02-01/auth/resources/orderes/1234/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Registration" type="application/xml" title="AssociatedRegistration" href="https://acme.example.org/api/2012-02-01/auth/resources/registrations/1234/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Venue" type="application/xml" title="AssociatedVenue" href="https://acme.example.org/api/2012-02-01/auth/resources/venues/1234/"/>
</ArchivedMessage>

HTTP/1.1 201 Created
Content-Length: 2042
Content-Type: application/xml; charset=utf-8

<ArchivedMessage>
  <MessageID>1234</MessageID>
  <CreatedDateTime>2011-10-17T03:51:29.577Z</CreatedDateTime>
  <SentDateTime>2011-10-17T03:51:29.577Z</SentDateTime>
  <Status>Sent</Status>
  <Description>Registration confirmation</Description>
  <ExternalMessageID>&lt;572aa9de3f1f2_3201c9b3286743d@jobs-11.mail&gt;</ExternalMessageID>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/MailMessage" type="application/xml" title="MailMessage" href="https://acme.example.org/api/2012-02-01/auth/resources/mailmessages/1234/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Contact" type="application/xml" title="AssociatedContact" href="https://acme.example.org/api/2012-02-01/auth/resources/contacts/1234/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Event" type="application/xml" title="AssociatedEvent" href="https://acme.example.org/api/2012-02-01/auth/resources/events/1234/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Order" type="application/xml" title="AssociatedOrder" href="https://acme.example.org/api/2012-02-01/auth/resources/orderes/1234/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Registration" type="application/xml" title="AssociatedRegistration"  href="https://acme.example.org/api/2012-02-01/auth/resources/registrations/1234/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Venue" type="application/xml" title="AssociatedVenue" href="https://acme.example.org/api/2012-02-01/auth/resources/venues/1234/"/>
</ArchivedMessage>

HTTP PUT

Not supported.

HTTP DELETE

Not supported.