GetEncodingJobStatus (interface v1.0.1)

Description

The goal of this interface is to retrieve the status of the encoding job.

Request

A snippet of the GetEncodingJobStatus schema:

CODE

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="wfm:EncoderControlAPI/v1/schemas" targetNamespace="wfm:EncoderControlAPI/v1/schemas" elementFormDefault="qualified"
      attributeFormDefault="unqualified">
      <xs:element name="GetEncodingJobStatus">
           <xs:complexType>
               <xs:sequence>
                    <xs:element name="EncodingJobId" type="xs:string"/>
               </xs:sequence>
           </xs:complexType>
      </xs:element>
 </xs:schema>

Parameters

Name

Type

Description

EncodingJobId

xs:string

ID of the encoding job returned by the CreateEncodingJob method.

The format of the EncodingJobId parameter is dependent on the encoding system.

Response

A snippet of the GetEncodingJobStatusResponse:

CODE

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="wfm:EncoderControlAPI/v1/schemas" targetNamespace="wfm:EncoderControlAPI/v1/schemas" elementFormDefault="qualified"
      attributeFormDefault="unqualified">
          <xs:element name="GetEncodingJobStatusResponse">
                <xs:complexType>
                       <xs:sequence>
                              <xs:element name="EncodingJobStatus">
                                      <xs:simpleType>
                                             <xs:restriction base="xs:string">
                                                      <xs:enumeration value="SUCCESS"/>
                                                      <xs:enumeration value="FAILED"/>
                                                      <xs:enumeration value="IN_PROGRESS"/>
                                                      <xs:enumeration value="CANCELLED"/>
                                             </xs:restriction>
                                      </xs:simpleType>
                             </xs:element>
                        <xs:element name="EncodingProgress" minOccurs="0">
                            <xs:simpleType>
                                  <xs:restriction base="xs:unsignedShort">
                                   <xs:minInclusive value="0"/>
                                   <xs:maxInclusive value="100"/>
                                  </xs:restriction>
                            </xs:simpleType>
                       </xs:element>
                     </xs:sequence>
                </xs:complexType>
         </xs:element>
    </xs:schema>

Parameters

Name	Type	Description
`EncodingJobStatus`	`xs:string`	SUCCESS: The specified encoding job has completed successfully and the encoded asset is fully available on the destination repository (`DestinationRepositoryUrl` used during the `CreateEncodingJob` method call). FAILED: The specified encoding job has failed. (As it’s not possible to send the reason for failure, we recommend sending a SOAP Fault instead of using the FAILED status.) IN_PROGRESS: The specified encoding job is in progress. CANCELLED: The specified encoding job has been cancelled.

Fault

A fault message is returned in the following case:

Encoding job ID does not exist

See Fault management for a fault response sample.

Sample

Sample request

CODE

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>    
          <GetEncodingJobStatus xmlns="wfm:EncoderControlAPI/v1/schemas">
                 <EncodingJobId>110E8400-E29B-11D4-A716-446655440000</EncodingJobId>
          </GetEncodingJobStatus>  
    </soap:Body>
</soap:Envelope>

Sample response

The NAGRA Workflow Manager (WFM) expects the success response to be in the following format with 200 OK HTTP status code:

CODE

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
     <soap:Body>    
            <GetEncodingJobStatusResponse xmlns="wfm:EncoderControlAPI/v1/schemas">
                   <EncodingJobStatus>IN_PROGRESS</EncodingJobStatus>
                   <EncodingProgress>50</EncodingProgress>
            </GetEncodingJobStatusResponse>
     </soap:Body>
</soap:Envelope>