ZfApi


Click here for a complete list of operations.

LoadMessages

Loads messages from a mailbox. More...

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
mailboxId:
postedSince:
includeDeleted:

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /api/1.6/zfapi.asmx HTTP/1.1
Host: www.zenfolio.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.zenfolio.com/api/1.6/LoadMessages"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <LoadMessages xmlns="http://www.zenfolio.com/api/1.6">
      <mailboxId>string</mailboxId>
      <postedSince>dateTime</postedSince>
      <includeDeleted>boolean</includeDeleted>
    </LoadMessages>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <LoadMessagesResponse xmlns="http://www.zenfolio.com/api/1.6">
      <LoadMessagesResult>
        <Message>
          <MailboxId>string</MailboxId>
          <Index>int</Index>
          <PostedOn>dateTime</PostedOn>
          <PosterName>string</PosterName>
          <PosterLoginNane>string</PosterLoginNane>
          <PosterUrl>string</PosterUrl>
          <PosterEmail>string</PosterEmail>
          <Body>string</Body>
          <IsPrivate>boolean</IsPrivate>
        </Message>
        <Message>
          <MailboxId>string</MailboxId>
          <Index>int</Index>
          <PostedOn>dateTime</PostedOn>
          <PosterName>string</PosterName>
          <PosterLoginNane>string</PosterLoginNane>
          <PosterUrl>string</PosterUrl>
          <PosterEmail>string</PosterEmail>
          <Body>string</Body>
          <IsPrivate>boolean</IsPrivate>
        </Message>
      </LoadMessagesResult>
    </LoadMessagesResponse>
  </soap:Body>
</soap:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /api/1.6/zfapi.asmx/LoadMessages?mailboxId=string&postedSince=string&includeDeleted=string HTTP/1.1
Host: www.zenfolio.com
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfMessage xmlns="http://www.zenfolio.com/api/1.6">
  <Message>
    <MailboxId>string</MailboxId>
    <Index>int</Index>
    <PostedOn>dateTime</PostedOn>
    <PosterName>string</PosterName>
    <PosterLoginNane>string</PosterLoginNane>
    <PosterUrl>string</PosterUrl>
    <PosterEmail>string</PosterEmail>
    <Body>string</Body>
    <IsPrivate>boolean</IsPrivate>
  </Message>
  <Message>
    <MailboxId>string</MailboxId>
    <Index>int</Index>
    <PostedOn>dateTime</PostedOn>
    <PosterName>string</PosterName>
    <PosterLoginNane>string</PosterLoginNane>
    <PosterUrl>string</PosterUrl>
    <PosterEmail>string</PosterEmail>
    <Body>string</Body>
    <IsPrivate>boolean</IsPrivate>
  </Message>
</ArrayOfMessage>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /api/1.6/zfapi.asmx/LoadMessages HTTP/1.1
Host: www.zenfolio.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

mailboxId=string&postedSince=string&includeDeleted=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfMessage xmlns="http://www.zenfolio.com/api/1.6">
  <Message>
    <MailboxId>string</MailboxId>
    <Index>int</Index>
    <PostedOn>dateTime</PostedOn>
    <PosterName>string</PosterName>
    <PosterLoginNane>string</PosterLoginNane>
    <PosterUrl>string</PosterUrl>
    <PosterEmail>string</PosterEmail>
    <Body>string</Body>
    <IsPrivate>boolean</IsPrivate>
  </Message>
  <Message>
    <MailboxId>string</MailboxId>
    <Index>int</Index>
    <PostedOn>dateTime</PostedOn>
    <PosterName>string</PosterName>
    <PosterLoginNane>string</PosterLoginNane>
    <PosterUrl>string</PosterUrl>
    <PosterEmail>string</PosterEmail>
    <Body>string</Body>
    <IsPrivate>boolean</IsPrivate>
  </Message>
</ArrayOfMessage>


JSON-RPC

The following is a sample JSON-RPC request and response. The placeholders shown need to be replaced with actual values.

POST /api/1.6/zfapi.asmx HTTP/1.1
Host: www.zenfolio.com
Content-Type: application/json
Content-Length: length

{
    "method": "LoadMessages",
    "params": [mailboxId, postedSince, includeDeleted],
    "id": id
}
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length

{
    "result": value,
    "error": null,
    "id": id
}
Request
Response