Merge pull request #29 from cielo24/master

Add new account_id parameter to modify_job API (#28)
cielo24 · Dec 12, 2018 · ebe25d4 · ebe25d4
2 parents b65cc24 + 1ac32fe
commit ebe25d4
Showing 1 changed file with 28 additions and 22 deletions.
diff --git a/api/source/job_control/modify_job.rst b/api/source/job_control/modify_job.rst
@@ -33,27 +33,33 @@ Modify parameters of an already existing job. The job must be in *Authorization*
 
 **Query String Parameters** — Optional
 
-+------------------------+-------------------------------------------------------------------------+
-| Name                   | Details                                                                 |
-+========================+==================+======================================================+
-| transcription_fidelity | `Description`    | The desired fidelity of the transcription            |
-|                        +------------------+------------------------------------------------------+
-|                        | `Allowed Values` | :ref:`fidelity-label`                                |
-|                        +------------------+------------------------------------------------------+
-|                        | `Example`        | ``transcription_fidelity=PREMIUM``                   |
-+------------------------+------------------+------------------------------------------------------+
-| turnaround_hours       | `Description`    | The number of hours after which the job is returned  |
-|                        +------------------+------------------------------------------------------+
-|                        | `Allowed Values` | Integer                                              |
-|                        +------------------+------------------------------------------------------+
-|                        | `Example`        | ``turnaround_hours=36``                              |
-+------------------------+------------------+------------------------------------------------------+
-| priority               | `Description`    | The desired priority of the transcription            |
-|                        +------------------+------------------------------------------------------+
-|                        | `Allowed Values` | :ref:`priority-label`                                |
-|                        +------------------+------------------------------------------------------+
-|                        | `Example`        | ``priority=STANDARD``                                |
-+------------------------+------------------+------------------------------------------------------+
++------------------------+--------------------------------------------------------------------------+
+| Name                   | Details                                                                  |
++========================+==================+=======================================================+
+| transcription_fidelity | `Description`    | The desired fidelity of the transcription             |
+|                        +------------------+-------------------------------------------------------+
+|                        | `Allowed Values` | :ref:`fidelity-label`                                 |
+|                        +------------------+-------------------------------------------------------+
+|                        | `Example`        | ``transcription_fidelity=PREMIUM``                    |
++------------------------+------------------+-------------------------------------------------------+
+| turnaround_hours       | `Description`    | The number of hours after which the job is returned   |
+|                        +------------------+-------------------------------------------------------+
+|                        | `Allowed Values` | Integer                                               |
+|                        +------------------+-------------------------------------------------------+
+|                        | `Example`        | ``turnaround_hours=36``                               |
++------------------------+------------------+-------------------------------------------------------+
+| priority               | `Description`    | The desired priority of the transcription             |
+|                        +------------------+-------------------------------------------------------+
+|                        | `Allowed Values` | :ref:`priority-label`                                 |
+|                        +------------------+-------------------------------------------------------+
+|                        | `Example`        | ``priority=STANDARD``                                 |
++------------------------+------------------+-------------------------------------------------------+
+| account_id             | `Description`    | The username of the account to be assigned to the job |
+|                        +------------------+-------------------------------------------------------+
+|                        | `Allowed Values` | String                                                |
+|                        +------------------+-------------------------------------------------------+
+|                        | `Example`        | ``account_id=john_doe``                               |
++------------------------+------------------+-------------------------------------------------------+
 
 **Responses**
 
@@ -77,7 +83,7 @@ Modify parameters of an already existing job. The job must be in *Authorization*
     Host: api.cielo24.com
     Body: v=1&api_token=7ca5dc5c7cce449fb0fff719307e8f5f
           &job_id=64bea283eff6475ea6596027a6ba0929
-          &transcription_fidelity=PREMIUM&priority=STANDARD
+          &transcription_fidelity=PREMIUM&priority=STANDARD&account_id=john_doe
 
 **Example Response**