CloudFire API


People

List All

GET /people.xml

Returns all the people.

 

Response

Status: 200 OK

<people>
  <person>
    <id>1</id>
    <name>John Doe</name>
    <email>john.doe@example.com</email>
  </person>
  <person>
    <id>2</id>
    <name>Jane</name>
    <email>mary.jane@example.com</email>
  </person>
    ...
</people>

Create

POST /people.xml

Adds a person.

 

Request

<person>
  <name>John Smith</name>
  <email>john.smith@example.com</email>
</person>

 

Set

PUT /people/#{person_id}.xml

Updates a person.

 

Request

<person>
  <id>1</id>
  <email>john.dow@alternate_email.com</email>
</person>

 

Response

Status: 200 OK

 

Remove

DELETE /people/#{person_id}.xml

Deletes a person.

 

Response

Status: 200 OK

 

Gallery Memberships

List People in Gallery

GET /galleries/#{id}/people.xml

Returns all members of a gallery.

 

Response

Status: 200 OK

<people>
  <person>
    <first_name>John</first_name>
    <last_name>Doe</last_name>
    <email>john.doe@example.com</email>
  </person>
    ...
</people>

 

Invite People to Gallery

POST /galleries/#{id}/people/invite.xml

Invites people to the gallery.

 

Request

<invitation>
  <gallery>
    <id>1</id>
  </gallery>  
  <people>
    <person>
      <name>John Doe</name>
      <email>john.doe@example.com</email>
    </person>
    <person>
      <name>Mary Jane</name>
      <email>mary.jane@example.com</email>
    </person>
  </people>
  <message>
    Hi - I'd like to share my photos and videos through a cool service 
    called CloudFire
  </message>
</invitation>

 

Response

Status: 200 OK

 

Remove a person from the gallery

DELETE /galleries/#{id}/people/#{person_id}.xml

Deletes a person from a gallery.

 

Response

Status: 200 OK