POST api/v1/contact/login

Record the fact the customer logged in to their account

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Authentication		AuthenticationModel	Required
Request		LoginRequestModel	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",
    "Website": "StratusCore/Render Rocket",
    "StorageUsed": "0.47 (in Gb)",
    "EventCode": "VC-Pixar-May",
    "ListEvents": "true/false - determines whether events contact has been tracked on is returned in the response (default if false)",
    "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"
    },
    "EntityCode": null,
    "MotionCode": null
  }
}

application/xml, text/xml

Sample:

<LoginContactBindingModel 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>
    <Email>larry@newmedia.com</Email>
    <EntityCode i:nil="true" />
    <EventCode>VC-Pixar-May</EventCode>
    <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>
    <ListEvents>true/false - determines whether events contact has been tracked on is returned in the response (default if false)</ListEvents>
    <MotionCode i:nil="true" />
    <PlatformData>
      <Platform>Windows</Platform>
      <PlatformVersion>10</PlatformVersion>
    </PlatformData>
    <StorageUsed>0.47 (in Gb)</StorageUsed>
    <Website>StratusCore/Render Rocket</Website>
  </Request>
</LoginContactBindingModel>

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>