POST Client/DPT/StartSession

Direct Provider Translation: Start a DPT session

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

ResultDPTTextSessionStart

Name	Type	Additional information
TextSessionId	integer	None.
Languages	ResultDPTLanguageList	None.
ExistingBlocks	ResultRecoveryTextSession	None.

Response Formats

application/json, text/json

Sample:

{
  "TextSessionId": 1,
  "Languages": {
    "From": [
      {
        "LanguageId": 1,
        "LanguageName": "sample string 2"
      },
      {
        "LanguageId": 1,
        "LanguageName": "sample string 2"
      }
    ],
    "To": [
      {
        "LanguageId": 1,
        "LanguageName": "sample string 2"
      },
      {
        "LanguageId": 1,
        "LanguageName": "sample string 2"
      }
    ],
    "FromSelected": {
      "LanguageId": 1,
      "LanguageName": "sample string 2"
    },
    "ToSelected": {
      "LanguageId": 1,
      "LanguageName": "sample string 2"
    }
  },
  "ExistingBlocks": {
    "TextSessionId": 1,
    "TextBlockRecvdId": 2,
    "ActiveTextBlockIdSelf": 3,
    "ActiveTextBlockIdOther": 4,
    "Data": [
      {
        "Self": {
          "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
            }
          ],
          "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
            }
          ]
        },
        "Other": {
          "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
            }
          ],
          "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
            }
          ]
        },
        "TextBlockId": 1,
        "MTFailed": "sample string 2",
        "DPTStatus": "sample string 3"
      },
      {
        "Self": {
          "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
            }
          ],
          "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
            }
          ]
        },
        "Other": {
          "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
            }
          ],
          "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
            }
          ]
        },
        "TextBlockId": 1,
        "MTFailed": "sample string 2",
        "DPTStatus": "sample string 3"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<ResultDPTTextSessionStart xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models">
  <ExistingBlocks>
    <ActiveTextBlockIdOther>4</ActiveTextBlockIdOther>
    <ActiveTextBlockIdSelf>3</ActiveTextBlockIdSelf>
    <Data>
      <ResultRecoveryTextBlock>
        <DPTStatus>sample string 3</DPTStatus>
        <MTFailed>sample string 2</MTFailed>
        <Other>
          <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>
          <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>
          <TypedContent>
            <Content>sample string 2</Content>
            <DeviceTextSendId>1</DeviceTextSendId>
            <Mode>sample string 3</Mode>
          </TypedContent>
        </Other>
        <Self>
          <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>
          <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>
          <TypedContent>
            <Content>sample string 2</Content>
            <DeviceTextSendId>1</DeviceTextSendId>
            <Mode>sample string 3</Mode>
          </TypedContent>
        </Self>
        <TextBlockId>1</TextBlockId>
      </ResultRecoveryTextBlock>
      <ResultRecoveryTextBlock>
        <DPTStatus>sample string 3</DPTStatus>
        <MTFailed>sample string 2</MTFailed>
        <Other>
          <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>
          <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>
          <TypedContent>
            <Content>sample string 2</Content>
            <DeviceTextSendId>1</DeviceTextSendId>
            <Mode>sample string 3</Mode>
          </TypedContent>
        </Other>
        <Self>
          <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>
          <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>
          <TypedContent>
            <Content>sample string 2</Content>
            <DeviceTextSendId>1</DeviceTextSendId>
            <Mode>sample string 3</Mode>
          </TypedContent>
        </Self>
        <TextBlockId>1</TextBlockId>
      </ResultRecoveryTextBlock>
    </Data>
    <TextBlockRecvdId>2</TextBlockRecvdId>
    <TextSessionId>1</TextSessionId>
  </ExistingBlocks>
  <Languages>
    <From>
      <DPTLanguage>
        <LanguageId>1</LanguageId>
        <LanguageName>sample string 2</LanguageName>
      </DPTLanguage>
      <DPTLanguage>
        <LanguageId>1</LanguageId>
        <LanguageName>sample string 2</LanguageName>
      </DPTLanguage>
    </From>
    <FromSelected>
      <LanguageId>1</LanguageId>
      <LanguageName>sample string 2</LanguageName>
    </FromSelected>
    <To>
      <DPTLanguage>
        <LanguageId>1</LanguageId>
        <LanguageName>sample string 2</LanguageName>
      </DPTLanguage>
      <DPTLanguage>
        <LanguageId>1</LanguageId>
        <LanguageName>sample string 2</LanguageName>
      </DPTLanguage>
    </To>
    <ToSelected>
      <LanguageId>1</LanguageId>
      <LanguageName>sample string 2</LanguageName>
    </ToSelected>
  </Languages>
  <TextSessionId>1</TextSessionId>
</ResultDPTTextSessionStart>