GET Client/DPT/BlockDataFromProvider/{TextBlockId}

Direct Provider Translate (DPT): Get block data from provider

Request Information

URI Parameters

Name	Description	Type	Additional information
TextBlockId	TextBlockId	integer	Required

Body Parameters

None.

Response Information

Resource Description

DPTTextBlockDataFromProvider

Name	Type	Additional information
Done	boolean	None.
TypedContent	ParaTextContent	None.
DeviceTextSendId	integer	None.
ImageList	Collection of ParaTextImage	None.
AudioList	Collection of ParaTextAudio	None.
TextInOriginalLanguage	string	None.
DPTFailed	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Done": true,
  "TypedContent": {
    "DeviceTextSendId": 1,
    "Content": "sample string 2",
    "Mode": "sample string 3"
  },
  "DeviceTextSendId": 1,
  "ImageList": [
    {
      "DeviceImageSendId": 1,
      "TextImageId": 2,
      "ImageObject": {
        "FileName": "sample string 1",
        "MimeType": "sample string 2",
        "ImageData": "sample string 3",
        "ServerImageId": 1
      },
      "Killed": true
    },
    {
      "DeviceImageSendId": 1,
      "TextImageId": 2,
      "ImageObject": {
        "FileName": "sample string 1",
        "MimeType": "sample string 2",
        "ImageData": "sample string 3",
        "ServerImageId": 1
      },
      "Killed": true
    }
  ],
  "AudioList": [
    {
      "DeviceAudioSendId": 1,
      "TextAudioId": 2,
      "AudioObject": {
        "FileName": "sample string 1",
        "MimeType": "sample string 2",
        "Length": 3,
        "AudioData": "sample string 4"
      },
      "Killed": true,
      "NotReady": true
    },
    {
      "DeviceAudioSendId": 1,
      "TextAudioId": 2,
      "AudioObject": {
        "FileName": "sample string 1",
        "MimeType": "sample string 2",
        "Length": 3,
        "AudioData": "sample string 4"
      },
      "Killed": true,
      "NotReady": true
    }
  ],
  "TextInOriginalLanguage": "sample string 1",
  "DPTFailed": "sample string 2"
}

application/xml, text/xml

Sample:

<DPTTextBlockDataFromProvider xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models">
  <AudioList>
    <ParaTextAudio>
      <AudioObject>
        <AudioData>sample string 4</AudioData>
        <FileName>sample string 1</FileName>
        <Length>3</Length>
        <MimeType>sample string 2</MimeType>
      </AudioObject>
      <DeviceAudioSendId>1</DeviceAudioSendId>
      <Killed>true</Killed>
      <NotReady>true</NotReady>
      <TextAudioId>2</TextAudioId>
    </ParaTextAudio>
    <ParaTextAudio>
      <AudioObject>
        <AudioData>sample string 4</AudioData>
        <FileName>sample string 1</FileName>
        <Length>3</Length>
        <MimeType>sample string 2</MimeType>
      </AudioObject>
      <DeviceAudioSendId>1</DeviceAudioSendId>
      <Killed>true</Killed>
      <NotReady>true</NotReady>
      <TextAudioId>2</TextAudioId>
    </ParaTextAudio>
  </AudioList>
  <DPTFailed>sample string 2</DPTFailed>
  <DeviceTextSendId>1</DeviceTextSendId>
  <Done>true</Done>
  <ImageList>
    <ParaTextImage>
      <DeviceImageSendId>1</DeviceImageSendId>
      <ImageObject>
        <FileName>sample string 1</FileName>
        <ImageData>sample string 3</ImageData>
        <MimeType>sample string 2</MimeType>
        <ServerImageId>1</ServerImageId>
      </ImageObject>
      <Killed>true</Killed>
      <TextImageId>2</TextImageId>
    </ParaTextImage>
    <ParaTextImage>
      <DeviceImageSendId>1</DeviceImageSendId>
      <ImageObject>
        <FileName>sample string 1</FileName>
        <ImageData>sample string 3</ImageData>
        <MimeType>sample string 2</MimeType>
        <ServerImageId>1</ServerImageId>
      </ImageObject>
      <Killed>true</Killed>
      <TextImageId>2</TextImageId>
    </ParaTextImage>
  </ImageList>
  <TextInOriginalLanguage>sample string 1</TextInOriginalLanguage>
  <TypedContent>
    <Content>sample string 2</Content>
    <DeviceTextSendId>1</DeviceTextSendId>
    <Mode>sample string 3</Mode>
  </TypedContent>
</DPTTextBlockDataFromProvider>