Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Endpoint: /v2/docusign/ipro/source_settings/<source_id>/accounts/<account_id>/auth_token

  • Methods: POST

  • Body for POST method:

    Code Block
    {
        "go_live_date": datetime(UTC formate),
        "connection_name": "Docusign",
        "config": {
       
            "user_id": "af90af54-368d-47c7-aacd-d209a9303ee3",
            "docusign_account_id": "3d58d115-8a00-43e1-a93a-1636b51f053a",
            "look_back": 0,
            "point_of_contact": []
        }
    }
  • Response code: 200

    Code Block
    {
        "account_id": 2,
        "accountmapping": [],
        "config": {
            "docusign_account_id": "3d58d115-8a00-43e1-a93a-1636b51f053a",
            "look_back": 0,
            "point_of_contact": [
                "venkatadri@socialsurvey.com"
            ],
            "user_id": "af90af54-368d-47c7-aacd-d209a9303ee3"
        },
        "connection_name": "Docusign",
        "connection_stage": "default",
        "connection_status": {}
    

    Response code: 200

    Code Block
    TODO
    ,
        "go_live_date": "Mon, 21 Jun 2021 00:00:00 GMT",
        "id": 965,
        "ipro_ingestion_source_id": 5,
        "organization_id": 2,
        "sample_transaction": null,
        "sftp_user": null,
        "status": 0
    }
  • Possible Errors:

    • If the account_id not provided.

      • status_code: 400

      • Response:

      • Code Block
        {"message": "Could't prosees your request without account_id"}
    • If the source_id not provided.

      • status_code: 400

      • Response:

      • Code Block
        {"message": "Could't prosees your request without source_id"}
    • For the post request if the request body is invalid or empty.

      • status_code: 400

      • Response:

      • Code Block
        {"message": "Cannot process request without request body}
    • If the credentials is not provided .

      • status_code: 422

      • Response:

      • Code Block
        {"message": Cannot process request without credentials}
    • If the credentials already mapped to the same account.

      • status_code: 409

      • Response: {"message": "Credentials already exist for this account"}

    • if Given credentials are invalid.

      • status_code: 401

      • Response: error_response

...

  • Endpoint: /v2/docusign/ipro/source_settings/<source_id>/accounts/<account_id>/auth_token

  • Methods: PUT

  • Body for PUT method:

    Code Block
    {
        "source_setting_id": 173965,
        "go_live_date": datetime(UTC formate),
        "connection_name": "Docusign",
        "config": {
       
            "user_id": "af90af54-368d-47c7-aacd-d209a9303ee3",
            "docusign_account_id": "3d58d115-8a00-43e1-a93a-1636b51f053a",
            "look_back": 0,
            "point_of_contact": ["venkat@123.com"]
        }
    }
  • Response code: 200

  • Code Block
    {
        "account_id": 2,
        "accountmapping": [],
        "config": {
            "docusign_account_id": "3d58d115-8a00-43e1-a93a-1636b51f053a",
            "look_back": 0,
            "point_of_contact": [
                "venkatadri@socialsurvey.com"
            ],
            "user_id": "af90af54-368d-47c7-aacd-d209a9303ee3"
        },
        "connection_name": "Docusign",
        "connection_stage": "default",
        "connection_status": {}
    
  • Response code: 200

  • Code Block
    TODO
    ,
        "go_live_date": "Mon, 21 Jun 2021 00:00:00 GMT",
        "id": 965,
        "ipro_ingestion_source_id": 5,
        "organization_id": 2,
        "sample_transaction": null,
        "sftp_user": null,
        "status": 0
    }
  • Possible Errors:

    • If the body not provided in the request.

      • status_code: 400

      • Response:

      • Code Block
        {"message": "Could't prosees your request without body"}
    • If the source_setting_id not provided in the request body.

      • status_code: 400

      • Response:

      • Code Block
        {"message": "Could't prosees your request without source_setting_id"}
    • If the config is not provided in the request body.

      • status_code: 422

      • Response:

      • Code Block
        {"message": "Cannot process request without request config"}
    • If the credentials is not provided .

      • status_code: 422

      • Response:

      • Code Block
        {"message": Cannot process request without credentials}
    • If the credentials already mapped to the same account.

      • status_code: 409

      • Response:

        Code Block
        {"message": "Credentials already exist for this account"}
    • if Given credentials are invalid.

      • status_code: 401

      • Response: error_response

    • If the account configuration not exist in IPRO source settings table with given source_setting_id.

      • status_code:

      • Response: {"message": "Configuration not available for this account"}

...