/cancelAndReviseAdministrativeSession

1 min

POST

Calling this request is used to get back to editing a pending administrative session.

Request Example:

           .. code-block::

               cancelAndReviseAdministrativeSession(
                   new_session_id="3478593863424051983840947"
                   request_extra_data={
                       "Machine": MPC,
                       "SessionId": "3478593863424051983840947"
                     }
               )

           ----

           **Response Example:**

           .. code-block::

               {
                   "FunctionData": {
                       {
                           "StatusCode": 0,
                           "StatusCodeDescription": "Session is editable"
                       },
                   "Meta": {
                       "AccessToken": "6276...79fe",
                       "Destination": "0453...9d56",
                       "Source": "fc581...42f3",
                       "Time": "2025-02-10 13:05:23.729"
                   }
               }

    **Error Responses**

    | Error Type       | Http Code | GK8 error code | Reason / Description                    | Example Response |
    |------------------|-----------|----------------|-----------------------------------------|------------------|
    | Backend Response | 400       | 1              | No session exists                       | "StatusCode": 1  |
    | Backend Response | 400       | 2              | Another session is already running      | "StatusCode": 2  |
    | Backend Response | 400       | 3              | Session is not in pending mode          | "StatusCode": 3  |
    | Backend Response | 400       | 4              | Session id already exists               | "StatusCode": 4  |

new_session_idstringa unique id for the session that will be submitted

request_extra_dataobjectadditional data for the administrative request

acceptstringGenerated from available response content types

bodyobject

200success

curl --request POST \
     --url '/cancelAndReviseAdministrativeSession?new_session_id=123&request_extra_data=%22None%22' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "FunctionData": {
     "NewSessionId": 123,
     "RequestExtraData": {
     "MessageNumber": 5,
     "SessionId": "3478593863424051983840947"
     }
     },
     "Meta": {
     "FunctionName": "cancelAndReviseAdministrativeSession",
     "RandomData": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229",
     "Destination": "b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea",
     "Time": "2021-02-07T18:37:46.948Z",
     "Source": "048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99",
     "AccessToken": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087"
     }
     }'