POST Agents/Quote/CreateConnectionFromConnectorName

• 5 minutes to read
 • 5 minutes to read 
POST /api/v1/Agents/Quote/CreateConnectionFromConnectorName

Create a new connection.

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/CreateConnectionFromConnectorName?$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

Property Name Type Description
ConnectorName String

Response:

OK

Response Description
200 OK

Response body: QuoteConnection

Property Name Type Description
QuoteConnectionId int32 Primary key
ERPName string Name of the ERP system (programmatic).
DisplayName string Connection name shown to user; multi-language support. The name of the connector to display in a list so that the users can choose between them. Typically the name of the client, with maybe the ERP system in parenthesis.
DisplayDescription string Tooltip/description shown to user; multi-language support. Any other info available that would make an uncertain user chose the right connector. Typically, used for tooltip.
Rank int32 Rank order
ConnectorName string Programmatic name of the Connector plugin that implements this kind of connection
ErpConnectionId int32 The ERP Connection that this Quote connection is an extension of
ExtraData string Optional extra data, in XML format, for configuring the connector. Connector-specific!
IsAvailable bool Whether or not the specified connection is available. Typically, without network access the availability is false.
InitializeResponse PluginResponse Status and Error message when the system called the connector Initialize method. Null if the connector has not been initialized yet.
PriceLists array The PriceLists that this connection offers.
AllAccess bool Is this connection accessible to everyone? If not, then the QuoteConnectionAccess table tells us who can access it.
Deleted bool If set, then this is a row that has been 'deleted'; we do not physically delete rows to avoid disaster.
UserGroupAccessIds array Array of ids containing usergroups that will have access to this connection.
AssociateAccessIds array Array of ids containing associates that will have access to this connection.
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/CreateConnectionFromConnectorName
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Content-Type: application/json; charset=utf-8

{
  "ConnectorName": "Armstrong, Moore and Nicolas"
}

Sample response

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

{
  "QuoteConnectionId": 231,
  "ERPName": "Mayert LLC",
  "DisplayName": "Ondricka-Spinka",
  "DisplayDescription": "Configurable object-oriented benchmark",
  "Rank": 808,
  "ConnectorName": "Cronin, Quitzon and Maggio",
  "ErpConnectionId": 600,
  "ExtraData": "architecto",
  "IsAvailable": false,
  "InitializeResponse": null,
  "PriceLists": [
    {
      "PriceListId": 385,
      "ERPPriceListKey": "ea",
      "QuoteConnectionId": 861,
      "Name": "Harvey LLC",
      "Description": "Pre-emptive global paradigm",
      "Currency": "iure",
      "CurrencyName": "Denesik, Considine and Lakin",
      "ValidFrom": "2019-01-28T16:32:39.7271263+01:00",
      "ValidTo": "2006-03-05T16:32:39.7271263+01:00",
      "IsActive": false,
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 3
        }
      }
    }
  ],
  "AllAccess": false,
  "Deleted": false,
  "UserGroupAccessIds": [
    678,
    43
  ],
  "AssociateAccessIds": [
    166,
    53
  ],
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 383
    }
  }
}