XML Audio Description File Layout for SFTP Audio Description Processing

This must be an AST ID of a successful Captioning submission.

e.g.

<Describe>
     <CapASTid>1423193085username</CapASTid>
</Describe>

These are notes to help the describer regarding background on the video.
e.g.

<Describe>
     <Notes>The artist of paintings is Claude Monet</Notes>
     <CapASTid>1423193085username</CapASTid>
</Describe>

 Be particularly mindful of making sure these notes to the describer are valid XML – speaker ID formats such as >> need to be marked up as >> for example.

This is the purchase order number for the submission for accounts set up as requiring purchase orders. If not present, the submission will inherit the default or most recently used valid purchase order for the account via the web UI.
e.g.

<Describe>
     <PO>N099044_CT</PO>
     <CapASTid>1423193085username</CapASTid>
</Describe>

 Keep in mind that the purchase order number needs to be nicely named -- no spaces, punctuation, or high ASCII characters please.

This is the flag to specify if the customer should review the description before results are generated or not (Y or N). Normally the default from the web UI is used to determine if this will be requested. This tag can be used to override that default.
e.g.

<Describe>
     <CustReview>Y</CustReview>
     <CapASTid>1423193085username</CapASTid>
</Describe>

This tag tells AST where to send results files back to via HTTP or HTTPS POST for a particular description. This tag needs to be present with an approved Source tag, otherwise this tag will be ignored.
e.g.

<Describe>
     <Source>PodcastVideo</Source>
     <CallBack>http://67.34.45.122/lectures/post_results?id=12387987983</CallBack>
     <CapASTid>1423193085username</CapASTid>
</Describe>

 AST needs to approve the value of your Source tag in conjunction with your CallBack tag for any result posting to take place.

This call back URL needs to be properly encoded e.g. %20 for SPACE.

In addition, XML encoding may be required. For example
  http://67.34.45.122/post%20results?id=%7B12387987983%7D&course=50 needs to be encoded as
  http://67.34.45.122/post%20results?id=%7B12387987983%7D&course=50 to properly escape the &.

The tag also needs to be less than 512 characters in length.

If you need more than one result type returned for the description and/or you need to differentiate between different types of result files posted back (e.g. a VTT file and MP3 file) an additional {fileType} macro also needs to be present in the callback URL so that different posts can be completed for each result file.
e.g.

<Describe>
     <Source>PodcastVideo</Source>
     <CallBack>https://67.34.4.22/bio1/{fileType}?id=1283232</CallBack>
     <CapASTid>1423193085username</CapASTid>
</Describe>

This could result in posts URLs like:

https://67.34.4.22/bio1/closedCaptioning?id=1283232
https://67.34.4.22/bio1/transcript?id=1283232

 The specific file types of the macro expansion (e.g., closedCaptioning, transcript, etc.) will need to be configured by AST.
       Alternatively, the type of results can be handled by different MIME types, which will need to be configured by AST.

This tag tells AST where to send results files back to via HTTP or HTTPS POST with a Content-Transfer-Encoding of binary for a particular submission.. This tag needs to be present with an approved Source tag, otherwise this tag will be ignored.
e.g.

<ADrequest>
     <VideoURL>https://youtube.com/watch?v=MklYYlB64D1</VideoURL>
    <ADStatusURL>https://67.34.4.22/status?id=1283232</
    ADStatusURL>
</ADrequest>

This call back URL needs to be properly encoded e.g. %20 for SPACE.

In addition, XML encoding may be required. For example
  http://67.34.45.122/post%20results?id=%7B12387987983%7D&course=50 needs to be encoded as
  http://67.34.45.122/post%20results?id=%7B12387987983%7D&course=50 to properly escape the &.

The tag also needs to be less than 512 characters in length.

The status information will be directly posted back to the specified URL as a raw POST with a MIME type of text/xml (note that there will not be any form URL encoding). The information will be presented in the following manner:
e.g.

<StatusUpdate>
     <Type>Initial</Type>
     <Result>IN_PROCESS</Result>
     <ASTid>AD1312468614joe</ASTid>
     <ASTstatus>Awaiting Description</ASTstatus>
</StatusUpdate>

The status callback will be sent as soon as a fatal error occurs, but in general as far enough into the ingest processing to know that it is on track to succeed. For example, if an error occurs when attempting to find a media file, the status callback will be sent at that point. Otherwise the system will not send the status callback until processing has been completed and an AST ID has been assigned. Note that in the case of a malformed .ad file, no callback will be made, rather an email will be sent to the account holder (provided the account holder has not deselected that email type in Contact Settings via the web UI).

Type         The will be one of Initial or Update. A status callback of the type of Update will only occur where a submission which was successfully ingested, subsequently fails or is rejected (the result will be FAILURE).

Result         It will be one of IN_PROCESS, NOT_INGESTED, or FAILURE. A status callback with a result of FAILURE will only occur where a submission which was successfully ingested, subsequently fails or is rejected (the type will be Update).
e.g. The transcriber tells us there is no audio:

<StatusUpdate>
          <Type>Update</Type>
          <Result>FAILURE</Result>
          <ASTid>AD1312468614joe</ASTid>
          <ASTstatus>Rejected Media</ASTstatus>
          <ErrDetail>No video.</ErrDetail>
</StatusUpdate>

ASTid         The tag will not be present for the Result of NOT_INGESTED, otherwise it will reference the CaptionSync AST ID of the submission.

ASTstatus         The tag will not be present for the Result of NOT_INGESTED, otherwise it will reference the current CaptionSync AST status of the submission.

ErrDetail         The tag will only be present for the Result of NOT_INGESTED and FAILURE.
e.g.

<StatusUpdate>
          <Type>Initial</Type>
          <Result>NOT_INGESTED</Result>
          <ErrDetail>Invalid .adrequest file - Purchase Order Number required, but no &lt;PO&gt; tag or valid
          default PO.</ErrDetail>
</StatusUpdate>

It is important to consider the possibility that the callback itself fails and no status information about the submission is received (e.g. 500 Internal Server Error). If no status information is received, it is important not to make assumptions about the status, rather further investigation is required.