GET v1/Article/{articleKey}/Paragraph/{paragraphKey}

Get a single paragraph using the paragraphKey

Roles Allowed

admin, editor

Request Information

URI Parameters

Name	Description	Type	Additional information
articleKey		integer	Required
paragraphKey		integer	Required

Body Parameters

None.

Response Information

Resource Description

HTTP 200 with the Paragraph if it is found, HTTP 404 if the Paragraph is not found

Paragraph

Name	Description	Type	Additional information
ParagraphKey		integer	None.
ParagraphType	ParagraphType determines whether this paragraph is Text or Media	ParagraphType	None.
ParagraphOrder		integer	None.
ParagraphUrl		string	None.
Media	This is a collection of records, each of which points to an image that is part of the article. If ParagraphType is text, then this will be an empty collection.	Collection of Media	None.
ParagraphContent	This contains HTML formatted text for the paragraph. If the ParagraphType is Media, then ParagraphContent will be null.	string	None.
ParagraphText	This contains raw text for the paragraph. If the ParagraphType is Media, a media object, then ParagraphText will be null.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ParagraphKey": 1,
  "ParagraphType": {
    "ParagraphTypeId": 1,
    "ParagraphTypeValue": "sample string 2"
  },
  "ParagraphOrder": 2,
  "ParagraphUrl": "sample string 3",
  "Media": [
    {
      "CustomFields": [
        [
          {
            "CustomFieldId": 1,
            "CustomFieldName": "sample string 2",
            "Values": [
              {
                "CustomFieldLookupID": 1,
                "CustomFieldValue": "sample string 1"
              },
              {
                "CustomFieldLookupID": 1,
                "CustomFieldValue": "sample string 1"
              }
            ]
          },
          {
            "CustomFieldId": 1,
            "CustomFieldName": "sample string 2",
            "Values": [
              {
                "CustomFieldLookupID": 1,
                "CustomFieldValue": "sample string 1"
              },
              {
                "CustomFieldLookupID": 1,
                "CustomFieldValue": "sample string 1"
              }
            ]
          }
        ],
        [
          {
            "CustomFieldId": 1,
            "CustomFieldName": "sample string 2",
            "Values": [
              {
                "CustomFieldLookupID": 1,
                "CustomFieldValue": "sample string 1"
              },
              {
                "CustomFieldLookupID": 1,
                "CustomFieldValue": "sample string 1"
              }
            ]
          },
          {
            "CustomFieldId": 1,
            "CustomFieldName": "sample string 2",
            "Values": [
              {
                "CustomFieldLookupID": 1,
                "CustomFieldValue": "sample string 1"
              },
              {
                "CustomFieldLookupID": 1,
                "CustomFieldValue": "sample string 1"
              }
            ]
          }
        ]
      ],
      "MediaKey": 1,
      "MediaFile": "sample string 2",
      "Updated": "2024-10-31T11:25:59.1040045+00:00",
      "UpdatedBy": "sample string 4",
      "ElementType": {
        "ElementTypeId": 1,
        "ElementTypeValue": "sample string 2"
      },
      "MediaReferences": [
        {
          "MediaReferenceKey": 1.0,
          "PageLocation": {
            "PageLocationKey": 1,
            "PageKey": 2,
            "ULX": 3,
            "ULY": 4,
            "LRX": 5,
            "LRY": 6,
            "Width": 7,
            "Height": 8
          },
          "PageRef": "sample string 2",
          "RefId": "sample string 3",
          "RefOrder": 4
        },
        {
          "MediaReferenceKey": 1.0,
          "PageLocation": {
            "PageLocationKey": 1,
            "PageKey": 2,
            "ULX": 3,
            "ULY": 4,
            "LRX": 5,
            "LRY": 6,
            "Width": 7,
            "Height": 8
          },
          "PageRef": "sample string 2",
          "RefId": "sample string 3",
          "RefOrder": 4
        }
      ],
      "Credit": "sample string 5",
      "Caption": "sample string 6",
      "TextDescription": "sample string 7",
      "Notes": "sample string 8",
      "IsReviewed": true
    },
    {
      "CustomFields": [
        [
          {
            "CustomFieldId": 1,
            "CustomFieldName": "sample string 2",
            "Values": [
              {
                "CustomFieldLookupID": 1,
                "CustomFieldValue": "sample string 1"
              },
              {
                "CustomFieldLookupID": 1,
                "CustomFieldValue": "sample string 1"
              }
            ]
          },
          {
            "CustomFieldId": 1,
            "CustomFieldName": "sample string 2",
            "Values": [
              {
                "CustomFieldLookupID": 1,
                "CustomFieldValue": "sample string 1"
              },
              {
                "CustomFieldLookupID": 1,
                "CustomFieldValue": "sample string 1"
              }
            ]
          }
        ],
        [
          {
            "CustomFieldId": 1,
            "CustomFieldName": "sample string 2",
            "Values": [
              {
                "CustomFieldLookupID": 1,
                "CustomFieldValue": "sample string 1"
              },
              {
                "CustomFieldLookupID": 1,
                "CustomFieldValue": "sample string 1"
              }
            ]
          },
          {
            "CustomFieldId": 1,
            "CustomFieldName": "sample string 2",
            "Values": [
              {
                "CustomFieldLookupID": 1,
                "CustomFieldValue": "sample string 1"
              },
              {
                "CustomFieldLookupID": 1,
                "CustomFieldValue": "sample string 1"
              }
            ]
          }
        ]
      ],
      "MediaKey": 1,
      "MediaFile": "sample string 2",
      "Updated": "2024-10-31T11:25:59.1040045+00:00",
      "UpdatedBy": "sample string 4",
      "ElementType": {
        "ElementTypeId": 1,
        "ElementTypeValue": "sample string 2"
      },
      "MediaReferences": [
        {
          "MediaReferenceKey": 1.0,
          "PageLocation": {
            "PageLocationKey": 1,
            "PageKey": 2,
            "ULX": 3,
            "ULY": 4,
            "LRX": 5,
            "LRY": 6,
            "Width": 7,
            "Height": 8
          },
          "PageRef": "sample string 2",
          "RefId": "sample string 3",
          "RefOrder": 4
        },
        {
          "MediaReferenceKey": 1.0,
          "PageLocation": {
            "PageLocationKey": 1,
            "PageKey": 2,
            "ULX": 3,
            "ULY": 4,
            "LRX": 5,
            "LRY": 6,
            "Width": 7,
            "Height": 8
          },
          "PageRef": "sample string 2",
          "RefId": "sample string 3",
          "RefOrder": 4
        }
      ],
      "Credit": "sample string 5",
      "Caption": "sample string 6",
      "TextDescription": "sample string 7",
      "Notes": "sample string 8",
      "IsReviewed": true
    }
  ],
  "ParagraphContent": "sample string 4",
  "ParagraphText": "sample string 5"
}

application/xml, text/xml

Sample:

<Paragraph xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bondi.Models.V3.ApiDto">
  <ParagraphContent>sample string 4</ParagraphContent>
  <ParagraphText>sample string 5</ParagraphText>
  <Media>
    <Media>
      <Caption>sample string 6</Caption>
      <Credit>sample string 5</Credit>
      <IsReviewed>true</IsReviewed>
      <Notes>sample string 8</Notes>
      <TextDescription>sample string 7</TextDescription>
      <ElementType>
        <ElementTypeId>1</ElementTypeId>
        <ElementTypeValue>sample string 2</ElementTypeValue>
      </ElementType>
      <MediaFile>sample string 2</MediaFile>
      <MediaKey>1</MediaKey>
      <MediaReferences>
        <MediaReference>
          <MediaReferenceKey>1</MediaReferenceKey>
          <PageLocation>
            <Height>8</Height>
            <LRX>5</LRX>
            <LRY>6</LRY>
            <PageKey>2</PageKey>
            <PageLocationKey>1</PageLocationKey>
            <ULX>3</ULX>
            <ULY>4</ULY>
            <Width>7</Width>
          </PageLocation>
          <PageRef>sample string 2</PageRef>
          <RefId>sample string 3</RefId>
          <RefOrder>4</RefOrder>
        </MediaReference>
        <MediaReference>
          <MediaReferenceKey>1</MediaReferenceKey>
          <PageLocation>
            <Height>8</Height>
            <LRX>5</LRX>
            <LRY>6</LRY>
            <PageKey>2</PageKey>
            <PageLocationKey>1</PageLocationKey>
            <ULX>3</ULX>
            <ULY>4</ULY>
            <Width>7</Width>
          </PageLocation>
          <PageRef>sample string 2</PageRef>
          <RefId>sample string 3</RefId>
          <RefOrder>4</RefOrder>
        </MediaReference>
      </MediaReferences>
      <Updated>2024-10-31T11:25:59.1040045+00:00</Updated>
      <UpdatedBy>sample string 4</UpdatedBy>
      <CustomFields>
        <ArrayOfMediaCustomFieldValues>
          <MediaCustomFieldValues>
            <CustomFieldId>1</CustomFieldId>
            <CustomFieldName>sample string 2</CustomFieldName>
            <Values>
              <CustomFieldEntry>
                <CustomFieldLookupID>1</CustomFieldLookupID>
                <CustomFieldValue>sample string 1</CustomFieldValue>
              </CustomFieldEntry>
              <CustomFieldEntry>
                <CustomFieldLookupID>1</CustomFieldLookupID>
                <CustomFieldValue>sample string 1</CustomFieldValue>
              </CustomFieldEntry>
            </Values>
          </MediaCustomFieldValues>
          <MediaCustomFieldValues>
            <CustomFieldId>1</CustomFieldId>
            <CustomFieldName>sample string 2</CustomFieldName>
            <Values>
              <CustomFieldEntry>
                <CustomFieldLookupID>1</CustomFieldLookupID>
                <CustomFieldValue>sample string 1</CustomFieldValue>
              </CustomFieldEntry>
              <CustomFieldEntry>
                <CustomFieldLookupID>1</CustomFieldLookupID>
                <CustomFieldValue>sample string 1</CustomFieldValue>
              </CustomFieldEntry>
            </Values>
          </MediaCustomFieldValues>
        </ArrayOfMediaCustomFieldValues>
        <ArrayOfMediaCustomFieldValues>
          <MediaCustomFieldValues>
            <CustomFieldId>1</CustomFieldId>
            <CustomFieldName>sample string 2</CustomFieldName>
            <Values>
              <CustomFieldEntry>
                <CustomFieldLookupID>1</CustomFieldLookupID>
                <CustomFieldValue>sample string 1</CustomFieldValue>
              </CustomFieldEntry>
              <CustomFieldEntry>
                <CustomFieldLookupID>1</CustomFieldLookupID>
                <CustomFieldValue>sample string 1</CustomFieldValue>
              </CustomFieldEntry>
            </Values>
          </MediaCustomFieldValues>
          <MediaCustomFieldValues>
            <CustomFieldId>1</CustomFieldId>
            <CustomFieldName>sample string 2</CustomFieldName>
            <Values>
              <CustomFieldEntry>
                <CustomFieldLookupID>1</CustomFieldLookupID>
                <CustomFieldValue>sample string 1</CustomFieldValue>
              </CustomFieldEntry>
              <CustomFieldEntry>
                <CustomFieldLookupID>1</CustomFieldLookupID>
                <CustomFieldValue>sample string 1</CustomFieldValue>
              </CustomFieldEntry>
            </Values>
          </MediaCustomFieldValues>
        </ArrayOfMediaCustomFieldValues>
      </CustomFields>
    </Media>
    <Media>
      <Caption>sample string 6</Caption>
      <Credit>sample string 5</Credit>
      <IsReviewed>true</IsReviewed>
      <Notes>sample string 8</Notes>
      <TextDescription>sample string 7</TextDescription>
      <ElementType>
        <ElementTypeId>1</ElementTypeId>
        <ElementTypeValue>sample string 2</ElementTypeValue>
      </ElementType>
      <MediaFile>sample string 2</MediaFile>
      <MediaKey>1</MediaKey>
      <MediaReferences>
        <MediaReference>
          <MediaReferenceKey>1</MediaReferenceKey>
          <PageLocation>
            <Height>8</Height>
            <LRX>5</LRX>
            <LRY>6</LRY>
            <PageKey>2</PageKey>
            <PageLocationKey>1</PageLocationKey>
            <ULX>3</ULX>
            <ULY>4</ULY>
            <Width>7</Width>
          </PageLocation>
          <PageRef>sample string 2</PageRef>
          <RefId>sample string 3</RefId>
          <RefOrder>4</RefOrder>
        </MediaReference>
        <MediaReference>
          <MediaReferenceKey>1</MediaReferenceKey>
          <PageLocation>
            <Height>8</Height>
            <LRX>5</LRX>
            <LRY>6</LRY>
            <PageKey>2</PageKey>
            <PageLocationKey>1</PageLocationKey>
            <ULX>3</ULX>
            <ULY>4</ULY>
            <Width>7</Width>
          </PageLocation>
          <PageRef>sample string 2</PageRef>
          <RefId>sample string 3</RefId>
          <RefOrder>4</RefOrder>
        </MediaReference>
      </MediaReferences>
      <Updated>2024-10-31T11:25:59.1040045+00:00</Updated>
      <UpdatedBy>sample string 4</UpdatedBy>
      <CustomFields>
        <ArrayOfMediaCustomFieldValues>
          <MediaCustomFieldValues>
            <CustomFieldId>1</CustomFieldId>
            <CustomFieldName>sample string 2</CustomFieldName>
            <Values>
              <CustomFieldEntry>
                <CustomFieldLookupID>1</CustomFieldLookupID>
                <CustomFieldValue>sample string 1</CustomFieldValue>
              </CustomFieldEntry>
              <CustomFieldEntry>
                <CustomFieldLookupID>1</CustomFieldLookupID>
                <CustomFieldValue>sample string 1</CustomFieldValue>
              </CustomFieldEntry>
            </Values>
          </MediaCustomFieldValues>
          <MediaCustomFieldValues>
            <CustomFieldId>1</CustomFieldId>
            <CustomFieldName>sample string 2</CustomFieldName>
            <Values>
              <CustomFieldEntry>
                <CustomFieldLookupID>1</CustomFieldLookupID>
                <CustomFieldValue>sample string 1</CustomFieldValue>
              </CustomFieldEntry>
              <CustomFieldEntry>
                <CustomFieldLookupID>1</CustomFieldLookupID>
                <CustomFieldValue>sample string 1</CustomFieldValue>
              </CustomFieldEntry>
            </Values>
          </MediaCustomFieldValues>
        </ArrayOfMediaCustomFieldValues>
        <ArrayOfMediaCustomFieldValues>
          <MediaCustomFieldValues>
            <CustomFieldId>1</CustomFieldId>
            <CustomFieldName>sample string 2</CustomFieldName>
            <Values>
              <CustomFieldEntry>
                <CustomFieldLookupID>1</CustomFieldLookupID>
                <CustomFieldValue>sample string 1</CustomFieldValue>
              </CustomFieldEntry>
              <CustomFieldEntry>
                <CustomFieldLookupID>1</CustomFieldLookupID>
                <CustomFieldValue>sample string 1</CustomFieldValue>
              </CustomFieldEntry>
            </Values>
          </MediaCustomFieldValues>
          <MediaCustomFieldValues>
            <CustomFieldId>1</CustomFieldId>
            <CustomFieldName>sample string 2</CustomFieldName>
            <Values>
              <CustomFieldEntry>
                <CustomFieldLookupID>1</CustomFieldLookupID>
                <CustomFieldValue>sample string 1</CustomFieldValue>
              </CustomFieldEntry>
              <CustomFieldEntry>
                <CustomFieldLookupID>1</CustomFieldLookupID>
                <CustomFieldValue>sample string 1</CustomFieldValue>
              </CustomFieldEntry>
            </Values>
          </MediaCustomFieldValues>
        </ArrayOfMediaCustomFieldValues>
      </CustomFields>
    </Media>
  </Media>
  <ParagraphKey>1</ParagraphKey>
  <ParagraphOrder>2</ParagraphOrder>
  <ParagraphType>
    <ParagraphTypeId>1</ParagraphTypeId>
    <ParagraphTypeValue>sample string 2</ParagraphTypeValue>
  </ParagraphType>
  <ParagraphUrl>sample string 3</ParagraphUrl>
</Paragraph>