POST api/user/login

User Login

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Description	Additional information
UserName	string
Password	string

Request Formats

application/json, text/json

Sample:

{
  "UserName": "sample string 1",
  "Password": "sample string 2"
}

application/xml, text/xml

Sample:

<LoginRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <UserName>sample string 1</UserName>
  <Password>sample string 2</Password>
</LoginRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LoginResponse

Name	Type	Description	Additional information
user	User
clients	Collection of ViprsClient
parentClient	string
clientName	string
securityToken	string
timeInMs	integer
resultCode	Resultcode
resultMessage	string

Response Formats

application/json, text/json

Sample:

{
  "user": {
    "userId": 1,
    "name": "sample string 2",
    "userFullName": "sample string 3",
    "active": true,
    "startDate": "2025-12-21T00:11:02.1138416+00:00",
    "endDate": "2025-12-21T00:11:02.1138416+00:00",
    "department": "sample string 7",
    "password": "sample string 8",
    "emailAddress": "sample string 9",
    "createdSession": 10,
    "modifiedSession": 11,
    "modifiedTimeStamp": "2025-12-21T00:11:02.1138416+00:00",
    "rowVersion": "sample string 13",
    "dbStatus": 14,
    "clientName": "sample string 15",
    "executionTime": 16,
    "resultMessage": "sample string 17",
    "resultCode": 18
  },
  "clients": [
    {
      "id": 1,
      "name": "sample string 2",
      "code": "sample string 3",
      "clientType": "sample string 4",
      "clientStatus": "sample string 5",
      "parentClientName": "sample string 6",
      "active": true,
      "startDate": "2025-12-21T00:11:02.1138416+00:00",
      "apiKey": "sample string 9",
      "businessName": "sample string 10",
      "businessAddress1": "sample string 11",
      "businessAddress2": "sample string 12",
      "businessCity": "sample string 13",
      "businessState": "sample string 14",
      "businessZip": "sample string 15",
      "businessCountry": "sample string 16",
      "businessPhone": "sample string 17",
      "externalCode": "sample string 18",
      "externalName": "sample string 19",
      "contactName": "sample string 20",
      "businessRules": [
        {},
        {}
      ],
      "clientConfigurationShippingRules": [
        {},
        {}
      ],
      "shipClientCarriers": [
        {
          "id": 1,
          "shipCarrierId": 2,
          "countryCode": "sample string 3",
          "active": true,
          "shipCarrier": {
            "id": 1,
            "carrierName": "sample string 2",
            "alias": "sample string 3",
            "externalName": "sample string 4"
          },
          "dbStatus": 5,
          "clientName": "sample string 6",
          "modifiedTimeStamp": "2025-12-21T00:11:02.1138416+00:00",
          "executionTime": 8,
          "resultMessage": "sample string 9",
          "resultCode": 10,
          "createdSession": 11,
          "modifiedSession": 12
        },
        {
          "id": 1,
          "shipCarrierId": 2,
          "countryCode": "sample string 3",
          "active": true,
          "shipCarrier": {
            "id": 1,
            "carrierName": "sample string 2",
            "alias": "sample string 3",
            "externalName": "sample string 4"
          },
          "dbStatus": 5,
          "clientName": "sample string 6",
          "modifiedTimeStamp": "2025-12-21T00:11:02.1138416+00:00",
          "executionTime": 8,
          "resultMessage": "sample string 9",
          "resultCode": 10,
          "createdSession": 11,
          "modifiedSession": 12
        }
      ],
      "shipLocations": [
        {},
        {}
      ],
      "dbStatus": 21,
      "clientName": "sample string 22",
      "modifiedTimeStamp": "2025-12-21T00:11:02.1138416+00:00",
      "executionTime": 24,
      "resultMessage": "sample string 25",
      "resultCode": 26,
      "createdSession": 27,
      "modifiedSession": 28,
      "rowVersion": "sample string 29"
    },
    {
      "id": 1,
      "name": "sample string 2",
      "code": "sample string 3",
      "clientType": "sample string 4",
      "clientStatus": "sample string 5",
      "parentClientName": "sample string 6",
      "active": true,
      "startDate": "2025-12-21T00:11:02.1138416+00:00",
      "apiKey": "sample string 9",
      "businessName": "sample string 10",
      "businessAddress1": "sample string 11",
      "businessAddress2": "sample string 12",
      "businessCity": "sample string 13",
      "businessState": "sample string 14",
      "businessZip": "sample string 15",
      "businessCountry": "sample string 16",
      "businessPhone": "sample string 17",
      "externalCode": "sample string 18",
      "externalName": "sample string 19",
      "contactName": "sample string 20",
      "businessRules": [
        {},
        {}
      ],
      "clientConfigurationShippingRules": [
        {},
        {}
      ],
      "shipClientCarriers": [
        {
          "id": 1,
          "shipCarrierId": 2,
          "countryCode": "sample string 3",
          "active": true,
          "shipCarrier": {
            "id": 1,
            "carrierName": "sample string 2",
            "alias": "sample string 3",
            "externalName": "sample string 4"
          },
          "dbStatus": 5,
          "clientName": "sample string 6",
          "modifiedTimeStamp": "2025-12-21T00:11:02.1138416+00:00",
          "executionTime": 8,
          "resultMessage": "sample string 9",
          "resultCode": 10,
          "createdSession": 11,
          "modifiedSession": 12
        },
        {
          "id": 1,
          "shipCarrierId": 2,
          "countryCode": "sample string 3",
          "active": true,
          "shipCarrier": {
            "id": 1,
            "carrierName": "sample string 2",
            "alias": "sample string 3",
            "externalName": "sample string 4"
          },
          "dbStatus": 5,
          "clientName": "sample string 6",
          "modifiedTimeStamp": "2025-12-21T00:11:02.1138416+00:00",
          "executionTime": 8,
          "resultMessage": "sample string 9",
          "resultCode": 10,
          "createdSession": 11,
          "modifiedSession": 12
        }
      ],
      "shipLocations": [
        {},
        {}
      ],
      "dbStatus": 21,
      "clientName": "sample string 22",
      "modifiedTimeStamp": "2025-12-21T00:11:02.1138416+00:00",
      "executionTime": 24,
      "resultMessage": "sample string 25",
      "resultCode": 26,
      "createdSession": 27,
      "modifiedSession": 28,
      "rowVersion": "sample string 29"
    }
  ],
  "parentClient": "sample string 1",
  "clientName": "sample string 2",
  "securityToken": "sample string 3",
  "timeInMs": 4,
  "resultCode": {},
  "resultMessage": "sample string 5"
}

application/xml, text/xml

Sample:

<LoginResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <user>
    <userId>1</userId>
    <name>sample string 2</name>
    <userFullName>sample string 3</userFullName>
    <active>true</active>
    <startDate>2025-12-21T00:11:02.1138416+00:00</startDate>
    <endDate>2025-12-21T00:11:02.1138416+00:00</endDate>
    <department>sample string 7</department>
    <password>sample string 8</password>
    <emailAddress>sample string 9</emailAddress>
    <createdSession>10</createdSession>
    <modifiedSession>11</modifiedSession>
    <modifiedTimeStamp>2025-12-21T00:11:02.1138416+00:00</modifiedTimeStamp>
    <rowVersion>sample string 13</rowVersion>
    <dbStatus>14</dbStatus>
    <clientName>sample string 15</clientName>
    <executionTime>16</executionTime>
    <resultMessage>sample string 17</resultMessage>
    <resultCode>18</resultCode>
  </user>
  <clients>
    <ViprsClient>
      <id>1</id>
      <name>sample string 2</name>
      <code>sample string 3</code>
      <clientType>sample string 4</clientType>
      <clientStatus>sample string 5</clientStatus>
      <parentClientName>sample string 6</parentClientName>
      <active>true</active>
      <startDate>2025-12-21T00:11:02.1138416+00:00</startDate>
      <apiKey>sample string 9</apiKey>
      <businessName>sample string 10</businessName>
      <businessAddress1>sample string 11</businessAddress1>
      <businessAddress2>sample string 12</businessAddress2>
      <businessCity>sample string 13</businessCity>
      <businessState>sample string 14</businessState>
      <businessZip>sample string 15</businessZip>
      <businessCountry>sample string 16</businessCountry>
      <businessPhone>sample string 17</businessPhone>
      <externalCode>sample string 18</externalCode>
      <externalName>sample string 19</externalName>
      <contactName>sample string 20</contactName>
      <businessRules>
        <anyType />
        <anyType />
      </businessRules>
      <clientConfigurationShippingRules>
        <anyType />
        <anyType />
      </clientConfigurationShippingRules>
      <shipClientCarriers>
        <Shipclientcarrier>
          <id>1</id>
          <shipCarrierId>2</shipCarrierId>
          <countryCode>sample string 3</countryCode>
          <active>true</active>
          <shipCarrier>
            <id>1</id>
            <carrierName>sample string 2</carrierName>
            <alias>sample string 3</alias>
            <externalName>sample string 4</externalName>
          </shipCarrier>
          <dbStatus>5</dbStatus>
          <clientName>sample string 6</clientName>
          <modifiedTimeStamp>2025-12-21T00:11:02.1138416+00:00</modifiedTimeStamp>
          <executionTime>8</executionTime>
          <resultMessage>sample string 9</resultMessage>
          <resultCode>10</resultCode>
          <createdSession>11</createdSession>
          <modifiedSession>12</modifiedSession>
        </Shipclientcarrier>
        <Shipclientcarrier>
          <id>1</id>
          <shipCarrierId>2</shipCarrierId>
          <countryCode>sample string 3</countryCode>
          <active>true</active>
          <shipCarrier>
            <id>1</id>
            <carrierName>sample string 2</carrierName>
            <alias>sample string 3</alias>
            <externalName>sample string 4</externalName>
          </shipCarrier>
          <dbStatus>5</dbStatus>
          <clientName>sample string 6</clientName>
          <modifiedTimeStamp>2025-12-21T00:11:02.1138416+00:00</modifiedTimeStamp>
          <executionTime>8</executionTime>
          <resultMessage>sample string 9</resultMessage>
          <resultCode>10</resultCode>
          <createdSession>11</createdSession>
          <modifiedSession>12</modifiedSession>
        </Shipclientcarrier>
      </shipClientCarriers>
      <shipLocations>
        <anyType />
        <anyType />
      </shipLocations>
      <dbStatus>21</dbStatus>
      <clientName>sample string 22</clientName>
      <modifiedTimeStamp>2025-12-21T00:11:02.1138416+00:00</modifiedTimeStamp>
      <executionTime>24</executionTime>
      <resultMessage>sample string 25</resultMessage>
      <resultCode>26</resultCode>
      <createdSession>27</createdSession>
      <modifiedSession>28</modifiedSession>
      <rowVersion>sample string 29</rowVersion>
    </ViprsClient>
    <ViprsClient>
      <id>1</id>
      <name>sample string 2</name>
      <code>sample string 3</code>
      <clientType>sample string 4</clientType>
      <clientStatus>sample string 5</clientStatus>
      <parentClientName>sample string 6</parentClientName>
      <active>true</active>
      <startDate>2025-12-21T00:11:02.1138416+00:00</startDate>
      <apiKey>sample string 9</apiKey>
      <businessName>sample string 10</businessName>
      <businessAddress1>sample string 11</businessAddress1>
      <businessAddress2>sample string 12</businessAddress2>
      <businessCity>sample string 13</businessCity>
      <businessState>sample string 14</businessState>
      <businessZip>sample string 15</businessZip>
      <businessCountry>sample string 16</businessCountry>
      <businessPhone>sample string 17</businessPhone>
      <externalCode>sample string 18</externalCode>
      <externalName>sample string 19</externalName>
      <contactName>sample string 20</contactName>
      <businessRules>
        <anyType />
        <anyType />
      </businessRules>
      <clientConfigurationShippingRules>
        <anyType />
        <anyType />
      </clientConfigurationShippingRules>
      <shipClientCarriers>
        <Shipclientcarrier>
          <id>1</id>
          <shipCarrierId>2</shipCarrierId>
          <countryCode>sample string 3</countryCode>
          <active>true</active>
          <shipCarrier>
            <id>1</id>
            <carrierName>sample string 2</carrierName>
            <alias>sample string 3</alias>
            <externalName>sample string 4</externalName>
          </shipCarrier>
          <dbStatus>5</dbStatus>
          <clientName>sample string 6</clientName>
          <modifiedTimeStamp>2025-12-21T00:11:02.1138416+00:00</modifiedTimeStamp>
          <executionTime>8</executionTime>
          <resultMessage>sample string 9</resultMessage>
          <resultCode>10</resultCode>
          <createdSession>11</createdSession>
          <modifiedSession>12</modifiedSession>
        </Shipclientcarrier>
        <Shipclientcarrier>
          <id>1</id>
          <shipCarrierId>2</shipCarrierId>
          <countryCode>sample string 3</countryCode>
          <active>true</active>
          <shipCarrier>
            <id>1</id>
            <carrierName>sample string 2</carrierName>
            <alias>sample string 3</alias>
            <externalName>sample string 4</externalName>
          </shipCarrier>
          <dbStatus>5</dbStatus>
          <clientName>sample string 6</clientName>
          <modifiedTimeStamp>2025-12-21T00:11:02.1138416+00:00</modifiedTimeStamp>
          <executionTime>8</executionTime>
          <resultMessage>sample string 9</resultMessage>
          <resultCode>10</resultCode>
          <createdSession>11</createdSession>
          <modifiedSession>12</modifiedSession>
        </Shipclientcarrier>
      </shipClientCarriers>
      <shipLocations>
        <anyType />
        <anyType />
      </shipLocations>
      <dbStatus>21</dbStatus>
      <clientName>sample string 22</clientName>
      <modifiedTimeStamp>2025-12-21T00:11:02.1138416+00:00</modifiedTimeStamp>
      <executionTime>24</executionTime>
      <resultMessage>sample string 25</resultMessage>
      <resultCode>26</resultCode>
      <createdSession>27</createdSession>
      <modifiedSession>28</modifiedSession>
      <rowVersion>sample string 29</rowVersion>
    </ViprsClient>
  </clients>
  <parentClient>sample string 1</parentClient>
  <clientName>sample string 2</clientName>
  <securityToken>sample string 3</securityToken>
  <timeInMs>4</timeInMs>
  <resultCode />
  <resultMessage>sample string 5</resultMessage>
</LoginResponse>