ZfApi


Click here for a complete list of operations.

LoadAccessRealm

Loads the specified access realm. More...

Test

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

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

<?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>
    <LoadAccessRealm xmlns="http://www.zenfolio.com/api/1.6">
      <realmId>int</realmId>
    </LoadAccessRealm>
  </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>
    <LoadAccessRealmResponse xmlns="http://www.zenfolio.com/api/1.6">
      <LoadAccessRealmResult>
        <RealmId>int</RealmId>
        <AccessType>Private or UserList or Password or Public</AccessType>
        <IsDerived>boolean</IsDerived>
        <AccessMask>ProtectAll or NoCollections or None or NoPrivateSearch or NoPublicSearch or NoRecentList or HideDateCreated or HideDateModified or HideDateTaken or ProtectExif or ProtectExtraLarge or ProtectLarge or ProtectMedium or HideMetaData or ProtectOriginals or HideUserStats or HideVisits or NoPublicGuestbookPosts or NoPrivateGuestbookPosts or NoAnonymousGuestbookPosts or NoPublicComments or NoPrivateComments or NoAnonymousComments or ProtectGuestbook or ProtectComments or PasswordProtectOriginals or ProtectXXLarge or UnprotectCover</AccessMask>
        <Viewers>
          <Viewer>string</Viewer>
          <Viewer>string</Viewer>
        </Viewers>
        <PasswordHint>string</PasswordHint>
        <SrcPasswordHint>string</SrcPasswordHint>
      </LoadAccessRealmResult>
    </LoadAccessRealmResponse>
  </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/LoadAccessRealm?realmId=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"?>
<AccessDescriptor xmlns="http://www.zenfolio.com/api/1.6">
  <RealmId>int</RealmId>
  <AccessType>Private or UserList or Password or Public</AccessType>
  <IsDerived>boolean</IsDerived>
  <AccessMask>ProtectAll or NoCollections or None or NoPrivateSearch or NoPublicSearch or NoRecentList or HideDateCreated or HideDateModified or HideDateTaken or ProtectExif or ProtectExtraLarge or ProtectLarge or ProtectMedium or HideMetaData or ProtectOriginals or HideUserStats or HideVisits or NoPublicGuestbookPosts or NoPrivateGuestbookPosts or NoAnonymousGuestbookPosts or NoPublicComments or NoPrivateComments or NoAnonymousComments or ProtectGuestbook or ProtectComments or PasswordProtectOriginals or ProtectXXLarge or UnprotectCover</AccessMask>
  <Viewers>
    <Viewer>string</Viewer>
    <Viewer>string</Viewer>
  </Viewers>
  <PasswordHint>string</PasswordHint>
  <SrcPasswordHint>string</SrcPasswordHint>
</AccessDescriptor>

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

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

<?xml version="1.0" encoding="utf-8"?>
<AccessDescriptor xmlns="http://www.zenfolio.com/api/1.6">
  <RealmId>int</RealmId>
  <AccessType>Private or UserList or Password or Public</AccessType>
  <IsDerived>boolean</IsDerived>
  <AccessMask>ProtectAll or NoCollections or None or NoPrivateSearch or NoPublicSearch or NoRecentList or HideDateCreated or HideDateModified or HideDateTaken or ProtectExif or ProtectExtraLarge or ProtectLarge or ProtectMedium or HideMetaData or ProtectOriginals or HideUserStats or HideVisits or NoPublicGuestbookPosts or NoPrivateGuestbookPosts or NoAnonymousGuestbookPosts or NoPublicComments or NoPrivateComments or NoAnonymousComments or ProtectGuestbook or ProtectComments or PasswordProtectOriginals or ProtectXXLarge or UnprotectCover</AccessMask>
  <Viewers>
    <Viewer>string</Viewer>
    <Viewer>string</Viewer>
  </Viewers>
  <PasswordHint>string</PasswordHint>
  <SrcPasswordHint>string</SrcPasswordHint>
</AccessDescriptor>


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