POST Agents/Quote/TestConnection

• 3 minutes to read
 • 3 minutes to read 
POST /api/v1/Agents/Quote/TestConnection

Used by the Admin clients.

Testing if the connection data is sufficient to get a connection with the ERP system. The Connector should try to do some operations to check if the connection has sufficient rights to run. The connection has not been created yet. TestConnection is called without InitializeConnector being called first.

Query String Parameters

Parameter Name Type Description
$select string Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields. 
POST /api/v1/Agents/Quote/TestConnection?$select=name,department,category/id

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Content-Type Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json
Accept Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Request Body: request

ConnectorName, ConnectionData

Property Name Type Description
ConnectorName String
ConnectionData PersonEntity

Response:

OK

Response Description
200 OK

Response body: PluginResponse

Property Name Type Description
IsOk bool Answer to the question / An indication if the operation went well. Equivalent to Status != Error
UserExplanation string A localized explanation to the answer. Text here is displayed to the user.
TechExplanation string Always in English
ErrorCode string An error code, if available.
Changes ChangedData Tablename/recordid of data changed by this method, that the client may need to reload
Status string QuoteStatus = Ok / OkWithInfo / Warn / Error. Error implies IsOk = false.
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.

Sample request

POST /api/v1/Agents/Quote/TestConnection
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: fr,de,ru,zh
Content-Type: application/json; charset=utf-8

{
  "ConnectorName": "Hand LLC",
  "ConnectionData": {
    "ConnectionData1": "ipsum",
    "ConnectionData2": "possimus"
  }
}

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "IsOk": true,
  "UserExplanation": "velit",
  "TechExplanation": "laudantium",
  "ErrorCode": "esse",
  "Changes": null,
  "Status": "Error",
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.String",
      "FieldLength": 628
    }
  }
}