POST api/Security

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
UserName		string	None.
Password		string	None.

Request Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

<LoginRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VSCM.ParcelPartners.Portal.Contract.Models">
  <Password>sample string 2</Password>
  <UserName>sample string 1</UserName>
</LoginRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LoginResponse

Name	Type	Additional information
ClientName	string	None.
SubClientName	string	None.
ResultCode	integer	None.
ResultMessage	string	None.
SecurityToken	string	None.
TimeInMs	decimal number	None.
Clients	Collection of Client	None.
User	PPUser	None.

Response Formats

application/json, text/json

Sample:

{
  "ClientName": "sample string 1",
  "SubClientName": "sample string 2",
  "ResultCode": 3,
  "ResultMessage": "sample string 4",
  "SecurityToken": "sample string 5",
  "TimeInMs": 6.1,
  "Clients": [
    {
      "ClientName": "sample string 1",
      "Id": 2,
      "Code": "sample string 3",
      "ClientType": "sample string 4",
      "ClientStatus": "sample string 5",
      "Active": true,
      "StartDate": "2025-12-06T03:41:42.8425231+00:00",
      "ApiKey": "sample string 8",
      "BusinessName": "sample string 9",
      "BusinessAddress1": "sample string 10",
      "BusinessAddress2": "sample string 11",
      "BusinessCity": "sample string 12",
      "BusinessState": "sample string 13",
      "BusinessZip": "sample string 14",
      "BusinessCountry": "sample string 15",
      "BusinessPhone": "sample string 16",
      "ContactName": "sample string 17",
      "ParentClientName": "sample string 18",
      "ExternalName": "sample string 19",
      "ExternalCode": "sample string 20"
    },
    {
      "ClientName": "sample string 1",
      "Id": 2,
      "Code": "sample string 3",
      "ClientType": "sample string 4",
      "ClientStatus": "sample string 5",
      "Active": true,
      "StartDate": "2025-12-06T03:41:42.8425231+00:00",
      "ApiKey": "sample string 8",
      "BusinessName": "sample string 9",
      "BusinessAddress1": "sample string 10",
      "BusinessAddress2": "sample string 11",
      "BusinessCity": "sample string 12",
      "BusinessState": "sample string 13",
      "BusinessZip": "sample string 14",
      "BusinessCountry": "sample string 15",
      "BusinessPhone": "sample string 16",
      "ContactName": "sample string 17",
      "ParentClientName": "sample string 18",
      "ExternalName": "sample string 19",
      "ExternalCode": "sample string 20"
    }
  ],
  "User": {
    "ClientName": "sample string 1",
    "UserId": 2,
    "Name": "sample string 3",
    "Active": true,
    "StartDate": "2025-12-06T03:41:42.8425231+00:00",
    "EndDate": "2025-12-06T03:41:42.8425231+00:00",
    "Department": "sample string 7",
    "SecurityFeatures": [
      {
        "ClientName": "sample string 1",
        "Id": 2,
        "FeatureName": "sample string 3"
      },
      {
        "ClientName": "sample string 1",
        "Id": 2,
        "FeatureName": "sample string 3"
      }
    ],
    "SessionId": "sample string 8",
    "EmailAddress": "sample string 9",
    "UserFullName": "sample string 10"
  }
}

application/xml, text/xml

Sample:

<LoginResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VSCM.ParcelPartners.Portal.Contract.Responses">
  <ClientName>sample string 1</ClientName>
  <Clients xmlns:d2p1="http://schemas.datacontract.org/2004/07/VSCM.ParcelPartners.Portal.Contract.Models">
    <d2p1:Client>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:ApiKey>sample string 8</d2p1:ApiKey>
      <d2p1:BusinessAddress1>sample string 10</d2p1:BusinessAddress1>
      <d2p1:BusinessAddress2>sample string 11</d2p1:BusinessAddress2>
      <d2p1:BusinessCity>sample string 12</d2p1:BusinessCity>
      <d2p1:BusinessCountry>sample string 15</d2p1:BusinessCountry>
      <d2p1:BusinessName>sample string 9</d2p1:BusinessName>
      <d2p1:BusinessPhone>sample string 16</d2p1:BusinessPhone>
      <d2p1:BusinessState>sample string 13</d2p1:BusinessState>
      <d2p1:BusinessZip>sample string 14</d2p1:BusinessZip>
      <d2p1:ClientName>sample string 1</d2p1:ClientName>
      <d2p1:ClientStatus>sample string 5</d2p1:ClientStatus>
      <d2p1:ClientType>sample string 4</d2p1:ClientType>
      <d2p1:Code>sample string 3</d2p1:Code>
      <d2p1:ContactName>sample string 17</d2p1:ContactName>
      <d2p1:ExternalCode>sample string 20</d2p1:ExternalCode>
      <d2p1:ExternalName>sample string 19</d2p1:ExternalName>
      <d2p1:Id>2</d2p1:Id>
      <d2p1:ParentClientName>sample string 18</d2p1:ParentClientName>
      <d2p1:StartDate>2025-12-06T03:41:42.8425231+00:00</d2p1:StartDate>
    </d2p1:Client>
    <d2p1:Client>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:ApiKey>sample string 8</d2p1:ApiKey>
      <d2p1:BusinessAddress1>sample string 10</d2p1:BusinessAddress1>
      <d2p1:BusinessAddress2>sample string 11</d2p1:BusinessAddress2>
      <d2p1:BusinessCity>sample string 12</d2p1:BusinessCity>
      <d2p1:BusinessCountry>sample string 15</d2p1:BusinessCountry>
      <d2p1:BusinessName>sample string 9</d2p1:BusinessName>
      <d2p1:BusinessPhone>sample string 16</d2p1:BusinessPhone>
      <d2p1:BusinessState>sample string 13</d2p1:BusinessState>
      <d2p1:BusinessZip>sample string 14</d2p1:BusinessZip>
      <d2p1:ClientName>sample string 1</d2p1:ClientName>
      <d2p1:ClientStatus>sample string 5</d2p1:ClientStatus>
      <d2p1:ClientType>sample string 4</d2p1:ClientType>
      <d2p1:Code>sample string 3</d2p1:Code>
      <d2p1:ContactName>sample string 17</d2p1:ContactName>
      <d2p1:ExternalCode>sample string 20</d2p1:ExternalCode>
      <d2p1:ExternalName>sample string 19</d2p1:ExternalName>
      <d2p1:Id>2</d2p1:Id>
      <d2p1:ParentClientName>sample string 18</d2p1:ParentClientName>
      <d2p1:StartDate>2025-12-06T03:41:42.8425231+00:00</d2p1:StartDate>
    </d2p1:Client>
  </Clients>
  <ResultCode>3</ResultCode>
  <ResultMessage>sample string 4</ResultMessage>
  <SecurityToken>sample string 5</SecurityToken>
  <SubClientName>sample string 2</SubClientName>
  <TimeInMs>6.1</TimeInMs>
  <User xmlns:d2p1="http://schemas.datacontract.org/2004/07/VSCM.ParcelPartners.Portal.Contract.Models">
    <d2p1:Active>true</d2p1:Active>
    <d2p1:ClientName>sample string 1</d2p1:ClientName>
    <d2p1:Department>sample string 7</d2p1:Department>
    <d2p1:EmailAddress>sample string 9</d2p1:EmailAddress>
    <d2p1:EndDate>2025-12-06T03:41:42.8425231+00:00</d2p1:EndDate>
    <d2p1:Name>sample string 3</d2p1:Name>
    <d2p1:SecurityFeatures>
      <d2p1:PPSecurityFeature>
        <d2p1:ClientName>sample string 1</d2p1:ClientName>
        <d2p1:FeatureName>sample string 3</d2p1:FeatureName>
        <d2p1:Id>2</d2p1:Id>
      </d2p1:PPSecurityFeature>
      <d2p1:PPSecurityFeature>
        <d2p1:ClientName>sample string 1</d2p1:ClientName>
        <d2p1:FeatureName>sample string 3</d2p1:FeatureName>
        <d2p1:Id>2</d2p1:Id>
      </d2p1:PPSecurityFeature>
    </d2p1:SecurityFeatures>
    <d2p1:SessionId>sample string 8</d2p1:SessionId>
    <d2p1:StartDate>2025-12-06T03:41:42.8425231+00:00</d2p1:StartDate>
    <d2p1:UserFullName>sample string 10</d2p1:UserFullName>
    <d2p1:UserId>2</d2p1:UserId>
  </User>
</LoginResponse>