Update Gallery REST Endpoint

URLs

POST (Header: PUT) api.ashx/v2/galleries/{id}.xml (or .json)

UPDATE a media gallery.

Request Parameters

Name	Type	Description	Required
Id	`int?`	Id	Required
GroupId	`int?`	Group Id	Optional
Name	`string`	Name	Optional
Key	`string`	If not specified, the key will be generated.	Optional
Description	`string`	Default is an empty string.	Optional
Enabled	`bool?`	Default is true.	Optional
Owners	`string`	Comman separated list of owner usernames	Optional
ExtendedAttributes	`RestExtendedAttributes`	Extended Attributes	Optional

Example Requests

C# REST SDK

This example uses the REST SDK to access the Community REST API within a .Net C# application. In the example, USER_NAME is the user name of the effective user for the request and OAUTH_CLIENT_ID and OAUTH_SECRET are the OAuth client ID and secret, respectively, associated to this application as configured in Administration > Integration > OAuth Clients with the "Client Credentials" grant type enabled. See the documentation for the REST SDK for more details about installation, configuration, and usage options.

var host = new ClientCredentialsRestHost("USER_NAME", "https://mysite.com/", "OAUTH_CLIENT_ID", "OAUTH_SECRET");
var response = host.PutToDynamic(2, "galleries/{id}.json", false, new RestPutOptions {
	PathParameters = new System.Collections.Specialized.NameValueCollection {
		{ "id", "6" }
	}
});

Widget Javascript

This example uses the rest JavaScript API to access the Community REST API within the Community web UI. When accessing the REST API through the javascript API, the effective user is the current contextual user of the web interface.

jQuery.telligent.evolution.put({
	url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/galleries/{id}.json',
	data: { 
		'id': '6'
	},
	success: function(response) {

	}
});

cURL

This example uses the cURL command-line HTTP utility. ENCODED_TOKEN in the example is the base64-encoded concatenation of the user's API key (created from the user's profile), a colon (:), and the user's user name. Learn more about using the REST API.

curl -H "Rest-User-Token: ENCODED_TOKEN" -H "Rest-Method: PUT" -X POST https://mysite.com/api.ashx/v2/galleries/6.xml

Example Responses

XML

<?xml version="1.0" encoding="utf-16"?>
<Response>
  <Info>
    <Message>string</Message>
    <Message>string</Message>
  </Info>
  <Warnings>
    <Message>string</Message>
    <Message>string</Message>
  </Warnings>
  <Errors>
    <Message>string</Message>
    <Message>string</Message>
  </Errors>
  <Gallery>
    <Id>112</Id>
    <Name>title</Name>
    <Key>key</Key>
    <Description>description</Description>
    <Url>url</Url>
    <Group>
      <Id>4</Id>
      <AvatarUrl>avatarurl</AvatarUrl>
      <DateCreated>2012-01-04T00:00:00</DateCreated>
      <Description>description</Description>
      <Key>key</Key>
      <Name>name</Name>
      <ParentGroupId>6</ParentGroupId>
      <Url>url</Url>
      <TotalMembers>25</TotalMembers>
      <HasGroups>true</HasGroups>
      <GroupCount>8</GroupCount>
      <GroupType>grouptype</GroupType>
      <EnableGroupMessages>true</EnableGroupMessages>
      <EnableContact>true</EnableContact>
      <SearchUniqueId>searchuniqueid</SearchUniqueId>
      <ExtendedAttributes>
        <key>value</key>
        <key>value</key>
      </ExtendedAttributes>
      <ContainerId>49fec544-6df7-4a82-872b-f8be586d5e9e</ContainerId>
      <Container>
        <ContainerId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ContainerId>
        <ContainerTypeId>fe65240b-044c-4292-9946-f10e0361ecff</ContainerTypeId>
        <HtmlName>htmlname</HtmlName>
        <Url>url</Url>
        <AvatarUrl>avatarurl</AvatarUrl>
      </Container>
    </Group>
    <Owners>
      <User>
        <Id>18</Id>
        <AvatarUrl>avatarurl</AvatarUrl>
        <DisplayName>displayname</DisplayName>
        <ProfileUrl>profileurl</ProfileUrl>
        <Username>username</Username>
        <CurrentStatus>
          <Id>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</Id>
          <Author>
            <Id>27</Id>
            <AvatarUrl>avatarurl</AvatarUrl>
            <DisplayName>displayname</DisplayName>
            <ProfileUrl>profileurl</ProfileUrl>
            <Username>username</Username>
            <CurrentStatus>
              <Id>2d525bad-c4df-470d-a193-a1c6d66e5c3e</Id>
              <Body>body</Body>
              <CreatedDate />
              <ReplyCount>7</ReplyCount>
              <AttachedUrl>attachedurl</AttachedUrl>
              <ContentId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</ContentId>
              <ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType>
              <Url>url</Url>
              <IsPublished>true</IsPublished>
            </CurrentStatus>
          </Author>
          <Body>body</Body>
          <CreatedDate>2012-05-02T00:00:00</CreatedDate>
          <ReplyCount>32</ReplyCount>
          <Group>
            <Id>61</Id>
            <AvatarUrl>avatarurl</AvatarUrl>
            <DateCreated>2012-06-04T00:00:00</DateCreated>
            <Description>description</Description>
            <Key>key</Key>
            <Name>name</Name>
            <ParentGroupId>52</ParentGroupId>
            <Url>url</Url>
            <TotalMembers>19</TotalMembers>
            <HasGroups>true</HasGroups>
            <GroupCount>112</GroupCount>
            <GroupType>grouptype</GroupType>
            <EnableGroupMessages>true</EnableGroupMessages>
            <EnableContact>true</EnableContact>
            <SearchUniqueId>searchuniqueid</SearchUniqueId>
            <ExtendedAttributes />
            <ContainerId>9ba1ec43-dc34-4e27-a579-4a0855144e2f</ContainerId>
            <Container>
              <ContainerId>e3715662-2528-4ba1-84a7-bfcd9d548f80</ContainerId>
              <ContainerTypeId>6cdcf200-3bad-476d-af45-97b52545c337</ContainerTypeId>
              <HtmlName>htmlname</HtmlName>
              <Url>url</Url>
              <AvatarUrl>avatarurl</AvatarUrl>
            </Container>
          </Group>
          <AttachedUrl>attachedurl</AttachedUrl>
          <ContentId>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</ContentId>
          <ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType>
          <Url>url</Url>
          <IsPublished>true</IsPublished>
          <Content>
            <CreatedByUser>
              <Id />
              <AvatarUrl>avatarurl</AvatarUrl>
              <DisplayName>displayname</DisplayName>
              <ProfileUrl>profileurl</ProfileUrl>
              <Username>username</Username>
            </CreatedByUser>
            <ContentId>49fec544-6df7-4a82-872b-f8be586d5e9e</ContentId>
            <ContentTypeId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ContentTypeId>
            <CreatedDate>2011-05-28T00:00:00</CreatedDate>
            <HtmlName>htmlname</HtmlName>
            <HtmlDescription>htmldescription</HtmlDescription>
            <Url>url</Url>
            <AvatarUrl>avatarurl</AvatarUrl>
            <Application>
              <ApplicationId>fe65240b-044c-4292-9946-f10e0361ecff</ApplicationId>
              <ApplicationTypeId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</ApplicationTypeId>
              <HtmlName>htmlname</HtmlName>
              <HtmlDescription>htmldescription</HtmlDescription>
              <Url>url</Url>
              <AvatarUrl>avatarurl</AvatarUrl>
            </Application>
          </Content>
        </CurrentStatus>
      </User>
      <User>
        <Id>32</Id>
        <AvatarUrl>avatarurl</AvatarUrl>
        <DisplayName>displayname</DisplayName>
        <ProfileUrl>profileurl</ProfileUrl>
        <Username>username</Username>
        <CurrentStatus>
          <Id>e3715662-2528-4ba1-84a7-bfcd9d548f80</Id>
          <Author>
            <Id>6</Id>
            <AvatarUrl>avatarurl</AvatarUrl>
            <DisplayName>displayname</DisplayName>
            <ProfileUrl>profileurl</ProfileUrl>
            <Username>username</Username>
            <CurrentStatus>
              <Id>9ba1ec43-dc34-4e27-a579-4a0855144e2f</Id>
              <Body>body</Body>
              <CreatedDate />
              <ReplyCount>76</ReplyCount>
              <AttachedUrl>attachedurl</AttachedUrl>
              <ContentId>9ba1ec43-dc34-4e27-a579-4a0855144e2f</ContentId>
              <ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType>
              <Url>url</Url>
              <IsPublished>true</IsPublished>
            </CurrentStatus>
          </Author>
          <Body>body</Body>
          <CreatedDate>2011-12-09T00:00:00</CreatedDate>
          <ReplyCount>25</ReplyCount>
          <Group>
            <Id>27</Id>
            <AvatarUrl>avatarurl</AvatarUrl>
            <DateCreated>2012-03-29T00:00:00</DateCreated>
            <Description>description</Description>
            <Key>key</Key>
            <Name>name</Name>
            <ParentGroupId>8</ParentGroupId>
            <Url>url</Url>
            <TotalMembers>4</TotalMembers>
            <HasGroups>true</HasGroups>
            <GroupCount>7</GroupCount>
            <GroupType>grouptype</GroupType>
            <EnableGroupMessages>true</EnableGroupMessages>
            <EnableContact>true</EnableContact>
            <SearchUniqueId>searchuniqueid</SearchUniqueId>
            <ExtendedAttributes />
            <ContainerId>6cdcf200-3bad-476d-af45-97b52545c337</ContainerId>
            <Container>
              <ContainerId>b04540ec-eb38-4fa1-b7bb-e3fde05401b4</ContainerId>
              <ContainerTypeId>44df201a-07e6-42eb-96c7-8ce7ce35aab6</ContainerTypeId>
              <HtmlName>htmlname</HtmlName>
              <Url>url</Url>
              <AvatarUrl>avatarurl</AvatarUrl>
            </Container>
          </Group>
          <AttachedUrl>attachedurl</AttachedUrl>
          <ContentId>e3715662-2528-4ba1-84a7-bfcd9d548f80</ContentId>
          <ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType>
          <Url>url</Url>
          <IsPublished>true</IsPublished>
          <Content>
            <CreatedByUser>
              <Id />
              <AvatarUrl>avatarurl</AvatarUrl>
              <DisplayName>displayname</DisplayName>
              <ProfileUrl>profileurl</ProfileUrl>
              <Username>username</Username>
            </CreatedByUser>
            <ContentId>fe65240b-044c-4292-9946-f10e0361ecff</ContentId>
            <ContentTypeId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</ContentTypeId>
            <CreatedDate>2012-04-19T00:00:00</CreatedDate>
            <HtmlName>htmlname</HtmlName>
            <HtmlDescription>htmldescription</HtmlDescription>
            <Url>url</Url>
            <AvatarUrl>avatarurl</AvatarUrl>
            <Application>
              <ApplicationId>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</ApplicationId>
              <ApplicationTypeId>9ba1ec43-dc34-4e27-a579-4a0855144e2f</ApplicationTypeId>
              <HtmlName>htmlname</HtmlName>
              <HtmlDescription>htmldescription</HtmlDescription>
              <Url>url</Url>
              <AvatarUrl>avatarurl</AvatarUrl>
            </Application>
          </Content>
        </CurrentStatus>
      </User>
    </Owners>
    <DateCreated>2012-01-16T00:00:00</DateCreated>
    <LatestPostDate>2012-01-04T00:00:00</LatestPostDate>
    <Enabled>true</Enabled>
    <PostCount>52</PostCount>
    <CommentCount>19</CommentCount>
    <SearchUniqueId>searchuniqueid</SearchUniqueId>
    <Application>
      <ApplicationId>6cdcf200-3bad-476d-af45-97b52545c337</ApplicationId>
      <ApplicationTypeId>b04540ec-eb38-4fa1-b7bb-e3fde05401b4</ApplicationTypeId>
      <HtmlName>htmlname</HtmlName>
      <HtmlDescription>htmldescription</HtmlDescription>
      <Url>url</Url>
      <AvatarUrl>avatarurl</AvatarUrl>
      <Container>
        <ContainerId>44df201a-07e6-42eb-96c7-8ce7ce35aab6</ContainerId>
        <ContainerTypeId>49fec544-6df7-4a82-872b-f8be586d5e9e</ContainerTypeId>
        <HtmlName>htmlname</HtmlName>
        <Url>url</Url>
        <AvatarUrl>avatarurl</AvatarUrl>
      </Container>
    </Application>
    <ExtendedAttributes>
      <key>value</key>
      <key>value</key>
    </ExtendedAttributes>
  </Gallery>
</Response>

JSON

{
  "Gallery": {
    "Name": "title",
    "Title": "title",
    "Key": "key",
    "Description": "description",
    "Url": "url",
    "Group": {
      "AvatarUrl": "avatarurl",
      "DateCreated": "2012-01-04T00:00:00",
      "Description": "description",
      "Key": "key",
      "Name": "name",
      "ParentGroupId": 6,
      "Url": "url",
      "TotalMembers": 25,
      "HasGroups": true,
      "GroupCount": 8,
      "GroupType": "grouptype",
      "EnableGroupMessages": true,
      "EnableContact": true,
      "SearchUniqueId": "searchuniqueid",
      "IsEnabled": true,
      "ExtendedAttributes": [
        {
          "Key": "key",
          "Value": "value"
        },
        {
          "Key": "key",
          "Value": "value"
        }
      ],
      "ContainerId": "49fec544-6df7-4a82-872b-f8be586d5e9e",
      "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4",
      "Container": {
        "ContainerId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46",
        "ContainerTypeId": "fe65240b-044c-4292-9946-f10e0361ecff",
        "HtmlName": "htmlname",
        "Url": "url",
        "AvatarUrl": "avatarurl"
      },
      "Id": 4
    },
    "Owners": [
      {
        "AvatarUrl": "avatarurl",
        "DisplayName": "displayname",
        "ProfileUrl": "profileurl",
        "Username": "username",
        "CurrentStatus": {
          "Author": {
            "AvatarUrl": "avatarurl",
            "DisplayName": "displayname",
            "ProfileUrl": "profileurl",
            "Username": "username",
            "CurrentStatus": {
              "Author": null,
              "Body": "body",
              "CreatedDate": null,
              "ReplyCount": 7,
              "Group": null,
              "AttachedUrl": "attachedurl",
              "HasReplies": null,
              "ContentId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e",
              "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78",
              "Url": "url",
              "IsPublished": true,
              "Content": null,
              "Id": "2d525bad-c4df-470d-a193-a1c6d66e5c3e"
            },
            "Id": 27
          },
          "Body": "body",
          "CreatedDate": "2012-05-02T00:00:00",
          "ReplyCount": 32,
          "Group": {
            "AvatarUrl": "avatarurl",
            "DateCreated": "2012-06-04T00:00:00",
            "Description": "description",
            "Key": "key",
            "Name": "name",
            "ParentGroupId": 52,
            "Url": "url",
            "TotalMembers": 19,
            "HasGroups": true,
            "GroupCount": 112,
            "GroupType": "grouptype",
            "EnableGroupMessages": true,
            "EnableContact": true,
            "SearchUniqueId": "searchuniqueid",
            "IsEnabled": true,
            "ExtendedAttributes": [],
            "ContainerId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f",
            "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4",
            "Container": {
              "ContainerId": "e3715662-2528-4ba1-84a7-bfcd9d548f80",
              "ContainerTypeId": "6cdcf200-3bad-476d-af45-97b52545c337",
              "HtmlName": "htmlname",
              "Url": "url",
              "AvatarUrl": "avatarurl"
            },
            "Id": 61
          },
          "AttachedUrl": "attachedurl",
          "HasReplies": true,
          "ContentId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1",
          "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78",
          "Url": "url",
          "IsPublished": true,
          "Content": {
            "CreatedByUser": {
              "AvatarUrl": "avatarurl",
              "DisplayName": "displayname",
              "ProfileUrl": "profileurl",
              "Username": "username",
              "CurrentStatus": null,
              "Id": null
            },
            "ContentId": "49fec544-6df7-4a82-872b-f8be586d5e9e",
            "ContentTypeId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46",
            "CreatedDate": "2011-05-28T00:00:00",
            "HtmlName": "htmlname",
            "HtmlDescription": "htmldescription",
            "Url": "url",
            "AvatarUrl": "avatarurl",
            "Application": {
              "ApplicationId": "fe65240b-044c-4292-9946-f10e0361ecff",
              "ApplicationTypeId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e",
              "HtmlName": "htmlname",
              "HtmlDescription": "htmldescription",
              "Url": "url",
              "AvatarUrl": "avatarurl",
              "Container": null
            }
          },
          "Id": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1"
        },
        "Id": 18
      },
      {
        "AvatarUrl": "avatarurl",
        "DisplayName": "displayname",
        "ProfileUrl": "profileurl",
        "Username": "username",
        "CurrentStatus": {
          "Author": {
            "AvatarUrl": "avatarurl",
            "DisplayName": "displayname",
            "ProfileUrl": "profileurl",
            "Username": "username",
            "CurrentStatus": {
              "Author": null,
              "Body": "body",
              "CreatedDate": null,
              "ReplyCount": 76,
              "Group": null,
              "AttachedUrl": "attachedurl",
              "HasReplies": null,
              "ContentId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f",
              "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78",
              "Url": "url",
              "IsPublished": true,
              "Content": null,
              "Id": "9ba1ec43-dc34-4e27-a579-4a0855144e2f"
            },
            "Id": 6
          },
          "Body": "body",
          "CreatedDate": "2011-12-09T00:00:00",
          "ReplyCount": 25,
          "Group": {
            "AvatarUrl": "avatarurl",
            "DateCreated": "2012-03-29T00:00:00",
            "Description": "description",
            "Key": "key",
            "Name": "name",
            "ParentGroupId": 8,
            "Url": "url",
            "TotalMembers": 4,
            "HasGroups": true,
            "GroupCount": 7,
            "GroupType": "grouptype",
            "EnableGroupMessages": true,
            "EnableContact": true,
            "SearchUniqueId": "searchuniqueid",
            "IsEnabled": true,
            "ExtendedAttributes": [],
            "ContainerId": "6cdcf200-3bad-476d-af45-97b52545c337",
            "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4",
            "Container": {
              "ContainerId": "b04540ec-eb38-4fa1-b7bb-e3fde05401b4",
              "ContainerTypeId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6",
              "HtmlName": "htmlname",
              "Url": "url",
              "AvatarUrl": "avatarurl"
            },
            "Id": 27
          },
          "AttachedUrl": "attachedurl",
          "HasReplies": true,
          "ContentId": "e3715662-2528-4ba1-84a7-bfcd9d548f80",
          "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78",
          "Url": "url",
          "IsPublished": true,
          "Content": {
            "CreatedByUser": {
              "AvatarUrl": "avatarurl",
              "DisplayName": "displayname",
              "ProfileUrl": "profileurl",
              "Username": "username",
              "CurrentStatus": null,
              "Id": null
            },
            "ContentId": "fe65240b-044c-4292-9946-f10e0361ecff",
            "ContentTypeId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e",
            "CreatedDate": "2012-04-19T00:00:00",
            "HtmlName": "htmlname",
            "HtmlDescription": "htmldescription",
            "Url": "url",
            "AvatarUrl": "avatarurl",
            "Application": {
              "ApplicationId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1",
              "ApplicationTypeId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f",
              "HtmlName": "htmlname",
              "HtmlDescription": "htmldescription",
              "Url": "url",
              "AvatarUrl": "avatarurl",
              "Container": null
            }
          },
          "Id": "e3715662-2528-4ba1-84a7-bfcd9d548f80"
        },
        "Id": 32
      }
    ],
    "DateCreated": "2012-01-16T00:00:00",
    "LatestPostDate": "2012-01-04T00:00:00",
    "Enabled": true,
    "PostCount": 52,
    "CommentCount": 19,
    "SearchUniqueId": "searchuniqueid",
    "Application": {
      "ApplicationId": "6cdcf200-3bad-476d-af45-97b52545c337",
      "ApplicationTypeId": "b04540ec-eb38-4fa1-b7bb-e3fde05401b4",
      "HtmlName": "htmlname",
      "HtmlDescription": "htmldescription",
      "Url": "url",
      "AvatarUrl": "avatarurl",
      "Container": {
        "ContainerId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6",
        "ContainerTypeId": "49fec544-6df7-4a82-872b-f8be586d5e9e",
        "HtmlName": "htmlname",
        "Url": "url",
        "AvatarUrl": "avatarurl"
      }
    },
    "ExtendedAttributes": [
      {
        "Key": "key",
        "Value": "value"
      },
      {
        "Key": "key",
        "Value": "value"
      }
    ],
    "Id": 112
  },
  "Info": [
    "string",
    "string"
  ],
  "Warnings": [
    "string",
    "string"
  ],
  "Errors": [
    "string",
    "string"
  ]
}

Recommended