POST api/v1/workstation/session/start

Record the fact the customer started a session

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Authentication		AuthenticationModel	Required
Request		SessionRequestModel	Required

Request Formats

application/json, text/json

Sample:

{
  "Authentication": {
    "Id": "170200123 - sample only, user your ID",
    "Key": "467512342123 - sample only, user your Key"
  },
  "Request": {
    "Email": "larry@newmedia.com",
    "CurrentDate": "2025-12-04 06:57:36 (YYYY-MM-DD HH:MM:SS - UTC format)",
    "Index": "283",
    "ServerName": "yvr-server-01 (free formatted text)",
    "SlotName": "vwuser0001 (free format text)",
    "GeoData": {
      "IpAddress": "192.168.4.321",
      "CountryCode": "US",
      "RegionCode": "WA",
      "City": "Seattle",
      "ZipCode": "98122",
      "TimeZone": "America/Los_Angeles",
      "Latitude": "47.6319",
      "Longitude": "-122.2968",
      "MetroCode": "819"
    },
    "PlatformData": {
      "Platform": "Windows",
      "PlatformVersion": "10"
    },
    "OperatingMode": "Purchased/Test/Trial"
  }
}

application/xml, text/xml

Sample:

<SessionContactBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ApiModels">
  <Authentication xmlns:d2p1="http://schemas.datacontract.org/2004/07/Api.Models">
    <d2p1:Id>170200123 - sample only, user your ID</d2p1:Id>
    <d2p1:Key>467512342123 - sample only, user your Key</d2p1:Key>
  </Authentication>
  <Request>
    <CurrentDate>2025-12-04 06:57:36 (YYYY-MM-DD HH:MM:SS - UTC format)</CurrentDate>
    <Email>larry@newmedia.com</Email>
    <GeoData>
      <City>Seattle</City>
      <CountryCode>US</CountryCode>
      <IpAddress>192.168.4.321</IpAddress>
      <Latitude>47.6319</Latitude>
      <Longitude>-122.2968</Longitude>
      <MetroCode>819</MetroCode>
      <RegionCode>WA</RegionCode>
      <TimeZone>America/Los_Angeles</TimeZone>
      <ZipCode>98122</ZipCode>
    </GeoData>
    <Index>283</Index>
    <OperatingMode>Purchased/Test/Trial</OperatingMode>
    <PlatformData>
      <Platform>Windows</Platform>
      <PlatformVersion>10</PlatformVersion>
    </PlatformData>
    <ServerName>yvr-server-01 (free formatted text)</ServerName>
    <SlotName>vwuser0001 (free format text)</SlotName>
  </Request>
</SessionContactBindingModel>

Response Information

Resource Description

ContactsOutgoingModel

Name	Description	Type	Additional information
Message		MessageModel	None.

Response Formats

application/json, text/json

Sample:

{
  "Message": {
    "Code": "(2 digit code reflecting result of request - 00 is good)",
    "Description": "(Message response in text depending upon request/result of request)"
  }
}

application/xml, text/xml

Sample:

<ContactsOutgoingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ApiModels">
  <Message xmlns:d2p1="http://schemas.datacontract.org/2004/07/Api.Models">
    <d2p1:Code>(2 digit code reflecting result of request - 00 is good)</d2p1:Code>
    <d2p1:Description>(Message response in text depending upon request/result of request)</d2p1:Description>
  </Message>
</ContactsOutgoingModel>