ZfApi


Click here for a complete list of operations.

LoadSharedFavoritesSets

Loads favorites sets shared with with the current user. More...

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

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/LoadSharedFavoritesSets"

<?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>
    <LoadSharedFavoritesSets xmlns="http://www.zenfolio.com/api/1.6" />
  </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>
    <LoadSharedFavoritesSetsResponse xmlns="http://www.zenfolio.com/api/1.6">
      <LoadSharedFavoritesSetsResult>
        <FavoritesSet>
          <Id>int</Id>
          <ChangeNumber>int</ChangeNumber>
          <Name>string</Name>
          <IsShared>boolean</IsShared>
          <SharedOn>dateTime</SharedOn>
          <SharerName>string</SharerName>
          <SharerEmail>string</SharerEmail>
          <SharerMessage>string</SharerMessage>
        </FavoritesSet>
        <FavoritesSet>
          <Id>int</Id>
          <ChangeNumber>int</ChangeNumber>
          <Name>string</Name>
          <IsShared>boolean</IsShared>
          <SharedOn>dateTime</SharedOn>
          <SharerName>string</SharerName>
          <SharerEmail>string</SharerEmail>
          <SharerMessage>string</SharerMessage>
        </FavoritesSet>
      </LoadSharedFavoritesSetsResult>
    </LoadSharedFavoritesSetsResponse>
  </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/LoadSharedFavoritesSets? 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"?>
<ArrayOfFavoritesSet xmlns="http://www.zenfolio.com/api/1.6">
  <FavoritesSet>
    <Id>int</Id>
    <ChangeNumber>int</ChangeNumber>
    <Name>string</Name>
    <IsShared>boolean</IsShared>
    <SharedOn>dateTime</SharedOn>
    <SharerName>string</SharerName>
    <SharerEmail>string</SharerEmail>
    <SharerMessage>string</SharerMessage>
  </FavoritesSet>
  <FavoritesSet>
    <Id>int</Id>
    <ChangeNumber>int</ChangeNumber>
    <Name>string</Name>
    <IsShared>boolean</IsShared>
    <SharedOn>dateTime</SharedOn>
    <SharerName>string</SharerName>
    <SharerEmail>string</SharerEmail>
    <SharerMessage>string</SharerMessage>
  </FavoritesSet>
</ArrayOfFavoritesSet>

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/LoadSharedFavoritesSets HTTP/1.1
Host: www.zenfolio.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length


HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfFavoritesSet xmlns="http://www.zenfolio.com/api/1.6">
  <FavoritesSet>
    <Id>int</Id>
    <ChangeNumber>int</ChangeNumber>
    <Name>string</Name>
    <IsShared>boolean</IsShared>
    <SharedOn>dateTime</SharedOn>
    <SharerName>string</SharerName>
    <SharerEmail>string</SharerEmail>
    <SharerMessage>string</SharerMessage>
  </FavoritesSet>
  <FavoritesSet>
    <Id>int</Id>
    <ChangeNumber>int</ChangeNumber>
    <Name>string</Name>
    <IsShared>boolean</IsShared>
    <SharedOn>dateTime</SharedOn>
    <SharerName>string</SharerName>
    <SharerEmail>string</SharerEmail>
    <SharerMessage>string</SharerMessage>
  </FavoritesSet>
</ArrayOfFavoritesSet>
 

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": "LoadSharedFavoritesSets",
    "params": [],
    "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