POST Provider/Text/BlockData

Send the block data to the server

Request Information

URI Parameters

None.

Body Parameters

Data to be sent to the server and therefore the other party

Name	Type	Additional information
TextBlockRecvdId	integer	None.
RetrieveTextBlockRecvd	boolean	None.
TextSessionId	integer	None.
TextBlockId	integer	None.
Done	boolean	None.
TypedContent	ParaTextContent	None.
ImageList	Collection of ParaTextImage	None.
ImageMTAsync	string	None.
AudioList	Collection of ParaTextAudio	None.
AudioMTAsync	string	None.
MTFromLanguageId	integer	None.
MTToLanguageId	integer	None.
ASRText	string	None.
MTFailed	string	None.
DPTStatus	string	None.

Request Formats

application/json, text/json

Sample:

{
  "TextBlockRecvdId": 1,
  "RetrieveTextBlockRecvd": true,
  "TextSessionId": 3,
  "TextBlockId": 4,
  "Done": true,
  "TypedContent": {
    "DeviceTextSendId": 1,
    "Content": "sample string 2",
    "Mode": "sample string 3"
  },
  "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
    }
  ],
  "ImageMTAsync": "sample string 6",
  "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
    }
  ],
  "AudioMTAsync": "sample string 7",
  "MTFromLanguageId": 1,
  "MTToLanguageId": 1,
  "ASRText": "sample string 8",
  "MTFailed": "sample string 9",
  "DPTStatus": "sample string 10"
}

application/xml, text/xml

Sample:

<ParaTextBlockData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models">
  <ASRText>sample string 8</ASRText>
  <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>
  <AudioMTAsync>sample string 7</AudioMTAsync>
  <DPTStatus>sample string 10</DPTStatus>
  <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>
  <ImageMTAsync>sample string 6</ImageMTAsync>
  <MTFailed>sample string 9</MTFailed>
  <MTFromLanguageId>1</MTFromLanguageId>
  <MTToLanguageId>1</MTToLanguageId>
  <RetrieveTextBlockRecvd>true</RetrieveTextBlockRecvd>
  <TextBlockId>4</TextBlockId>
  <TextBlockRecvdId>1</TextBlockRecvdId>
  <TextSessionId>3</TextSessionId>
  <TypedContent>
    <Content>sample string 2</Content>
    <DeviceTextSendId>1</DeviceTextSendId>
    <Mode>sample string 3</Mode>
  </TypedContent>
</ParaTextBlockData>

Response Information

Resource Description

ResultTextBlockSend

Name	Description	Type	Additional information
RecvdInfo		ReceivedTextBlockData	None.
TextBlockId		integer	None.

Response Formats

application/json, text/json

Sample:

{
  "RecvdInfo": {
    "RecvdData": {
      "TextBlockRecvdId": 1,
      "RetrieveTextBlockRecvd": true,
      "TextSessionId": 3,
      "TextBlockId": 4,
      "Done": true,
      "TypedContent": {
        "DeviceTextSendId": 1,
        "Content": "sample string 2",
        "Mode": "sample string 3"
      },
      "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
        }
      ],
      "ImageMTAsync": "sample string 6",
      "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
        }
      ],
      "AudioMTAsync": "sample string 7",
      "MTFromLanguageId": 1,
      "MTToLanguageId": 1,
      "ASRText": "sample string 8",
      "MTFailed": "sample string 9",
      "DPTStatus": "sample string 10"
    },
    "NewerBlockCount": 1
  },
  "TextBlockId": 1
}

application/xml, text/xml

Sample:

<ResultTextBlockSend xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models">
  <RecvdInfo>
    <NewerBlockCount>1</NewerBlockCount>
    <RecvdData>
      <ASRText>sample string 8</ASRText>
      <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>
      <AudioMTAsync>sample string 7</AudioMTAsync>
      <DPTStatus>sample string 10</DPTStatus>
      <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>
      <ImageMTAsync>sample string 6</ImageMTAsync>
      <MTFailed>sample string 9</MTFailed>
      <MTFromLanguageId>1</MTFromLanguageId>
      <MTToLanguageId>1</MTToLanguageId>
      <RetrieveTextBlockRecvd>true</RetrieveTextBlockRecvd>
      <TextBlockId>4</TextBlockId>
      <TextBlockRecvdId>1</TextBlockRecvdId>
      <TextSessionId>3</TextSessionId>
      <TypedContent>
        <Content>sample string 2</Content>
        <DeviceTextSendId>1</DeviceTextSendId>
        <Mode>sample string 3</Mode>
      </TypedContent>
    </RecvdData>
  </RecvdInfo>
  <TextBlockId>1</TextBlockId>
</ResultTextBlockSend>