Create Session

POST /api/v1/Session/Create

Overview

Using the create session API endpoint will create the session that will be used as a primary key for all quote requests, quotations returned and any any instructions made on those quotes within this session.

Request/response samples

Please be sure to use the correct [API Domain] in your request.

Click the download icons to download example json files for development.

Request sample

Initiate Create Session Request (Initiate CreateSessionRequest object)

POST https://[API Domain]/api/v1/Session/Create

{
  "domainIdentifier": "companyname-apisource",
  "utmSource": null,
  "utmCampaign": null,
  "utmMedium": null,
  "utmContent": null,
  "utmTerm": null
}

Success response

Initiate Create Session Response (Initiate SaveSessionIdAndDomainResponse object)

Return a 200 http status code on success

{
  "StatusCode": 200,
  "Errors": [],
  "Warnings": [],
  "Data": {
    "SessionId": "9ac369cd-c3c7-41c4-9e95-ebcf6d9489e3"
  }
}

Error responses

Initiate Create Session Response (Initiate SaveSessionIdAndDomainResponse object)

Return a 400 http status code on failure to create session

{
  "StatusCode": 400,
  "Errors": [
    {
      "MessageType": "Unable to find WidgetClassificationId for domain identifier",
      "Message": "Unable to find WidgetClassificationId for domain identifier: company-wrongId"
    }
  ],
  "Warnings": [],
  "Data": null
}

Request/response Schema

Schema request overview

CreateSessionRequest - the root object for the request

Field Name	Field Type	Mandatory	Notes
DomainIdentifier	String	True	This will be the domain identifier given to you to access the API.
UtmSource	String	False
UtmCampaign	String	False
UtmMedium	String	False
UtmContent	String	False
UtmTerm	String	False

Transaction Network API Documentation