Delete Publish Group REST Endpoint

Ben Tiedt — Fri, 08 Mar 2024 17:48:23 GMT

Current Revision posted to API Documentation by Ben Tiedt on 03/08/2024 17:48:23

POST (Header:DELETE) api.ashx/v2/articles/publishgroup/{id}.{json|xml}

Request Parameters

Name	Type	Location	Description	Required	Default	Options
Id	int	Request Body	Id of the publish group to delete.	Required

Example Requests

Widget Javascript

jQuery.telligent.evolution.del({
	url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/articles/publishgroup/{id}.json',
	data: { 
		'id': '6'
	}
}).then(function(response) {
	// use response
});

Example Responses

JSON

{
  "PublishGroups": {
    "Id": 6,
    "Name": "name",
    "ArticleCollection": {
      "Id": "49fec544-6df7-4a82-872b-f8be586d5e9e",
      "EnableHelpfulness": true,
      "Name": "name",
      "UrlKey": "urlkey",
      "Description": "description",
      "CreateDate": null,
      "Group": {
        "AvatarUrl": "avatarurl",
        "DateCreated": "2012-01-04T00:00:00",
        "Description": "description",
        "Key": "key",
        "Name": "name",
        "ParentGroupId": 25,
        "Url": "url",
        "TotalMembers": 8,
        "HasGroups": true,
        "GroupCount": 4,
        "GroupType": "grouptype",
        "EnableGroupMessages": true,
        "EnableContact": true,
        "SearchUniqueId": "searchuniqueid",
        "IsEnabled": true,
        "ExtendedAttributes": [
          {
            "Key": "key",
            "Value": "value"
          },
          {
            "Key": "key",
            "Value": "value"
          }
        ],
        "ContainerId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46",
        "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4",
        "Container": {
          "ContainerId": "fe65240b-044c-4292-9946-f10e0361ecff",
          "ContainerTypeId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e",
          "HtmlName": "htmlname",
          "Url": "url",
          "AvatarUrl": "avatarurl"
        },
        "Id": 7
      },
      "Url": "url",
      "CreatedBy": {
        "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": 27,
              "Group": null,
              "AttachedUrl": "attachedurl",
              "HasReplies": null,
              "ContentId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1",
              "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78",
              "Url": "url",
              "IsPublished": true,
              "Content": null,
              "Id": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1"
            },
            "Id": 32
          },
          "Body": "body",
          "CreatedDate": "2012-05-02T00:00:00",
          "ReplyCount": 52,
          "Group": {
            "AvatarUrl": "avatarurl",
            "DateCreated": "2012-06-04T00:00:00",
            "Description": "description",
            "Key": "key",
            "Name": "name",
            "ParentGroupId": 19,
            "Url": "url",
            "TotalMembers": 112,
            "HasGroups": true,
            "GroupCount": 61,
            "GroupType": "grouptype",
            "EnableGroupMessages": true,
            "EnableContact": true,
            "SearchUniqueId": "searchuniqueid",
            "IsEnabled": true,
            "ExtendedAttributes": [],
            "ContainerId": "e3715662-2528-4ba1-84a7-bfcd9d548f80",
            "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4",
            "Container": {
              "ContainerId": "6cdcf200-3bad-476d-af45-97b52545c337",
              "ContainerTypeId": "b04540ec-eb38-4fa1-b7bb-e3fde05401b4",
              "HtmlName": "htmlname",
              "Url": "url",
              "AvatarUrl": "avatarurl"
            },
            "Id": 18
          },
          "AttachedUrl": "attachedurl",
          "HasReplies": true,
          "ContentId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f",
          "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": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46",
            "ContentTypeId": "fe65240b-044c-4292-9946-f10e0361ecff",
            "CreatedDate": "2011-05-28T00:00:00",
            "HtmlName": "htmlname",
            "HtmlDescription": "htmldescription",
            "Url": "url",
            "AvatarUrl": "avatarurl",
            "Application": {
              "ApplicationId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e",
              "ApplicationTypeId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1",
              "HtmlName": "htmlname",
              "HtmlDescription": "htmldescription",
              "Url": "url",
              "AvatarUrl": "avatarurl",
              "Container": null
            }
          },
          "Id": "9ba1ec43-dc34-4e27-a579-4a0855144e2f"
        },
        "Id": 76
      },
      "Prefix": "prefix",
      "DefaultType": {
        "Id": 6,
        "Name": "name",
        "ImageUrl": "imageurl"
      },
      "DefaultArticleId": "e3715662-2528-4ba1-84a7-bfcd9d548f80",
      "ThemeId": "6cdcf200-3bad-476d-af45-97b52545c337"
    },
    "CreateDate": "2011-12-09T00:00:00",
    "PublishDate": "2012-03-29T00:00:00",
    "PublishEndDate": "2012-04-19T00:00:00",
    "IsPublished": true,
    "IsDeleted": true,
    "DeleteDate": "2012-01-16T00:00:00",
    "PublishedVersionCount": 25,
    "UnpublishedVersionCount": 8
  },
  "Errors": [
    "string",
    "string"
  ]
}

XML

<?xml version="1.0" encoding="utf-16"?>
<Response>
  <PublishGroups>
    <Id>6</Id>
    <Name>name</Name>
    <ArticleCollection>
      <Id>49fec544-6df7-4a82-872b-f8be586d5e9e</Id>
      <EnableHelpfulness>true</EnableHelpfulness>
      <Name>name</Name>
      <UrlKey>urlkey</UrlKey>
      <Description>description</Description>
      <Group>
        <Id>7</Id>
        <AvatarUrl>avatarurl</AvatarUrl>
        <DateCreated>2012-01-04T00:00:00</DateCreated>
        <Description>description</Description>
        <Key>key</Key>
        <Name>name</Name>
        <ParentGroupId>25</ParentGroupId>
        <Url>url</Url>
        <TotalMembers>8</TotalMembers>
        <HasGroups>true</HasGroups>
        <GroupCount>4</GroupCount>
        <GroupType>grouptype</GroupType>
        <EnableGroupMessages>true</EnableGroupMessages>
        <EnableContact>true</EnableContact>
        <SearchUniqueId>searchuniqueid</SearchUniqueId>
        <ExtendedAttributes>
          <key>value</key>
          <key>value</key>
        </ExtendedAttributes>
        <ContainerId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ContainerId>
        <Container>
          <ContainerId>fe65240b-044c-4292-9946-f10e0361ecff</ContainerId>
          <ContainerTypeId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</ContainerTypeId>
          <HtmlName>htmlname</HtmlName>
          <Url>url</Url>
          <AvatarUrl>avatarurl</AvatarUrl>
        </Container>
      </Group>
      <Url>url</Url>
      <CreatedBy>
        <Id>76</Id>
        <AvatarUrl>avatarurl</AvatarUrl>
        <DisplayName>displayname</DisplayName>
        <ProfileUrl>profileurl</ProfileUrl>
        <Username>username</Username>
        <CurrentStatus>
          <Id>9ba1ec43-dc34-4e27-a579-4a0855144e2f</Id>
          <Author>
            <Id>32</Id>
            <AvatarUrl>avatarurl</AvatarUrl>
            <DisplayName>displayname</DisplayName>
            <ProfileUrl>profileurl</ProfileUrl>
            <Username>username</Username>
            <CurrentStatus>
              <Id>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</Id>
              <Body>body</Body>
              <CreatedDate />
              <ReplyCount>27</ReplyCount>
              <AttachedUrl>attachedurl</AttachedUrl>
              <ContentId>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</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>52</ReplyCount>
          <Group>
            <Id>18</Id>
            <AvatarUrl>avatarurl</AvatarUrl>
            <DateCreated>2012-06-04T00:00:00</DateCreated>
            <Description>description</Description>
            <Key>key</Key>
            <Name>name</Name>
            <ParentGroupId>19</ParentGroupId>
            <Url>url</Url>
            <TotalMembers>112</TotalMembers>
            <HasGroups>true</HasGroups>
            <GroupCount>61</GroupCount>
            <GroupType>grouptype</GroupType>
            <EnableGroupMessages>true</EnableGroupMessages>
            <EnableContact>true</EnableContact>
            <SearchUniqueId>searchuniqueid</SearchUniqueId>
            <ExtendedAttributes />
            <ContainerId>e3715662-2528-4ba1-84a7-bfcd9d548f80</ContainerId>
            <Container>
              <ContainerId>6cdcf200-3bad-476d-af45-97b52545c337</ContainerId>
              <ContainerTypeId>b04540ec-eb38-4fa1-b7bb-e3fde05401b4</ContainerTypeId>
              <HtmlName>htmlname</HtmlName>
              <Url>url</Url>
              <AvatarUrl>avatarurl</AvatarUrl>
            </Container>
          </Group>
          <AttachedUrl>attachedurl</AttachedUrl>
          <ContentId>9ba1ec43-dc34-4e27-a579-4a0855144e2f</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>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ContentId>
            <ContentTypeId>fe65240b-044c-4292-9946-f10e0361ecff</ContentTypeId>
            <CreatedDate>2011-05-28T00:00:00</CreatedDate>
            <HtmlName>htmlname</HtmlName>
            <HtmlDescription>htmldescription</HtmlDescription>
            <Url>url</Url>
            <AvatarUrl>avatarurl</AvatarUrl>
            <Application>
              <ApplicationId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</ApplicationId>
              <ApplicationTypeId>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</ApplicationTypeId>
              <HtmlName>htmlname</HtmlName>
              <HtmlDescription>htmldescription</HtmlDescription>
              <Url>url</Url>
              <AvatarUrl>avatarurl</AvatarUrl>
            </Application>
          </Content>
        </CurrentStatus>
      </CreatedBy>
      <Prefix>prefix</Prefix>
      <DefaultType>
        <Id>6</Id>
        <Name>name</Name>
        <ImageUrl>imageurl</ImageUrl>
      </DefaultType>
      <DefaultArticleId>e3715662-2528-4ba1-84a7-bfcd9d548f80</DefaultArticleId>
      <ThemeId>6cdcf200-3bad-476d-af45-97b52545c337</ThemeId>
    </ArticleCollection>
    <CreateDate>2011-12-09T00:00:00</CreateDate>
    <PublishDate>2012-03-29T00:00:00</PublishDate>
    <PublishEndDate>2012-04-19T00:00:00</PublishEndDate>
    <IsPublished>true</IsPublished>
    <IsDeleted>true</IsDeleted>
    <DeleteDate>2012-01-16T00:00:00</DeleteDate>
    <PublishedVersionCount>25</PublishedVersionCount>
    <UnpublishedVersionCount>8</UnpublishedVersionCount>
  </PublishGroups>
  <Errors>
    <Message>string</Message>
    <Message>string</Message>
  </Errors>
</Response>