POST api/Login

Request Information

URI Parameters

None.

Body Parameters

Login
NameDescriptionTypeAdditional information
LoginId

integer

None.

UtilityId

integer

None.

EmailAddress

string

Max length: 200

HashedPassword

string

Max length: 60

Status

string

Max length: 20

ResetPasswordKey

string

Max length: 32

ResetPasswordKeySent

date

None.

FailedLoginAttempts

integer

None.

WhenCreated

date

None.

LastLogin

date

None.

LegacyUserId

integer

None.

AccountNum

integer

None.

ContactId

integer

None.

Contact

Contact

None.

Request Formats

application/json, text/json

Sample:
{
  "LoginId": 1,
  "UtilityId": 2,
  "EmailAddress": "sample string 3",
  "HashedPassword": "sample string 4",
  "Status": "sample string 5",
  "ResetPasswordKey": "sample string 6",
  "ResetPasswordKeySent": "2020-02-15T20:30:44.2390738+00:00",
  "FailedLoginAttempts": 1,
  "WhenCreated": "2020-02-15T20:30:44.2390738+00:00",
  "LastLogin": "2020-02-15T20:30:44.2390738+00:00",
  "LegacyUserId": 1,
  "AccountNum": 8,
  "ContactId": 9,
  "Contact": {
    "ContactId": 1,
    "LoginId": 1,
    "FirstName": "sample string 2",
    "MiddleName": "sample string 3",
    "LastName": "sample string 4",
    "CompanyName": "sample string 5",
    "EmailAddress": "sample string 6",
    "Address1": "sample string 7",
    "Address2": "sample string 8",
    "City": "sample string 9",
    "State": "sample string 10",
    "ZIP": "sample string 11",
    "Phone1": "sample string 12",
    "Phone1Type": "sample string 13",
    "Phone2": "sample string 14",
    "Phone2Type": "sample string 15",
    "Status": "sample string 16",
    "Permissions": "sample string 17",
    "ContactType": "sample string 18",
    "ParentEntityId": 1,
    "DateCreated": "2020-02-15T20:30:44.2390738+00:00",
    "DateUpdated": "2020-02-15T20:30:44.2390738+00:00",
    "CreatedBy": 1,
    "UpdatedBy": 1,
    "PropertyName": "sample string 19",
    "AccountNumber": "sample string 20",
    "UtilityId": 21,
    "AddLogin": true,
    "ContactAccounts": [
      {
        "RecordId": 1,
        "ContactId": 2,
        "AccountId": 3,
        "AccountNum": 4,
        "UtilityId": 5,
        "Status": "sample string 6",
        "UnitId": 7,
        "BeginDate": "2020-02-15T20:30:44.2390738+00:00",
        "EndDate": "2020-02-15T20:30:44.2390738+00:00",
        "FeesOnly": "sample string 8",
        "DateCreated": "2020-02-15T20:30:44.2390738+00:00",
        "DateUpdated": "2020-02-15T20:30:44.2390738+00:00",
        "CreatedBy": 1,
        "UpdatedBy": 1,
        "MoveInPropertyManager": true
      },
      {
        "RecordId": 1,
        "ContactId": 2,
        "AccountId": 3,
        "AccountNum": 4,
        "UtilityId": 5,
        "Status": "sample string 6",
        "UnitId": 7,
        "BeginDate": "2020-02-15T20:30:44.2390738+00:00",
        "EndDate": "2020-02-15T20:30:44.2390738+00:00",
        "FeesOnly": "sample string 8",
        "DateCreated": "2020-02-15T20:30:44.2390738+00:00",
        "DateUpdated": "2020-02-15T20:30:44.2390738+00:00",
        "CreatedBy": 1,
        "UpdatedBy": 1,
        "MoveInPropertyManager": true
      }
    ],
    "PropertyId": 23,
    "UnitId": 24,
    "CustomerType": 25,
    "MoveInDate": "2020-02-15T20:30:44.2390738+00:00"
  }
}

application/xml, text/xml

Sample:
<Login xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APL.Models">
  <AccountNum>8</AccountNum>
  <Contact>
    <AccountNumber>sample string 20</AccountNumber>
    <AddLogin>true</AddLogin>
    <Address1>sample string 7</Address1>
    <Address2>sample string 8</Address2>
    <City>sample string 9</City>
    <CompanyName>sample string 5</CompanyName>
    <ContactAccounts>
      <ContactAccount>
        <AccountId>3</AccountId>
        <AccountNum>4</AccountNum>
        <BeginDate>2020-02-15T20:30:44.2390738+00:00</BeginDate>
        <ContactId>2</ContactId>
        <CreatedBy>1</CreatedBy>
        <DateCreated>2020-02-15T20:30:44.2390738+00:00</DateCreated>
        <DateUpdated>2020-02-15T20:30:44.2390738+00:00</DateUpdated>
        <EndDate>2020-02-15T20:30:44.2390738+00:00</EndDate>
        <FeesOnly>sample string 8</FeesOnly>
        <MoveInPropertyManager>true</MoveInPropertyManager>
        <RecordId>1</RecordId>
        <Status>sample string 6</Status>
        <UnitId>7</UnitId>
        <UpdatedBy>1</UpdatedBy>
        <UtilityId>5</UtilityId>
      </ContactAccount>
      <ContactAccount>
        <AccountId>3</AccountId>
        <AccountNum>4</AccountNum>
        <BeginDate>2020-02-15T20:30:44.2390738+00:00</BeginDate>
        <ContactId>2</ContactId>
        <CreatedBy>1</CreatedBy>
        <DateCreated>2020-02-15T20:30:44.2390738+00:00</DateCreated>
        <DateUpdated>2020-02-15T20:30:44.2390738+00:00</DateUpdated>
        <EndDate>2020-02-15T20:30:44.2390738+00:00</EndDate>
        <FeesOnly>sample string 8</FeesOnly>
        <MoveInPropertyManager>true</MoveInPropertyManager>
        <RecordId>1</RecordId>
        <Status>sample string 6</Status>
        <UnitId>7</UnitId>
        <UpdatedBy>1</UpdatedBy>
        <UtilityId>5</UtilityId>
      </ContactAccount>
    </ContactAccounts>
    <ContactId>1</ContactId>
    <ContactType>sample string 18</ContactType>
    <CreatedBy>1</CreatedBy>
    <CustomerType>25</CustomerType>
    <DateCreated>2020-02-15T20:30:44.2390738+00:00</DateCreated>
    <DateUpdated>2020-02-15T20:30:44.2390738+00:00</DateUpdated>
    <EmailAddress>sample string 6</EmailAddress>
    <FirstName>sample string 2</FirstName>
    <LastName>sample string 4</LastName>
    <LoginId>1</LoginId>
    <MiddleName>sample string 3</MiddleName>
    <MoveInDate>2020-02-15T20:30:44.2390738+00:00</MoveInDate>
    <ParentEntityId>1</ParentEntityId>
    <Permissions>sample string 17</Permissions>
    <Phone1>sample string 12</Phone1>
    <Phone1Type>sample string 13</Phone1Type>
    <Phone2>sample string 14</Phone2>
    <Phone2Type>sample string 15</Phone2Type>
    <PropertyId>23</PropertyId>
    <PropertyName>sample string 19</PropertyName>
    <State>sample string 10</State>
    <Status>sample string 16</Status>
    <UnitId>24</UnitId>
    <UpdatedBy>1</UpdatedBy>
    <UtilityId>21</UtilityId>
    <ZIP>sample string 11</ZIP>
  </Contact>
  <ContactId>9</ContactId>
  <EmailAddress>sample string 3</EmailAddress>
  <FailedLoginAttempts>1</FailedLoginAttempts>
  <HashedPassword>sample string 4</HashedPassword>
  <LastLogin>2020-02-15T20:30:44.2390738+00:00</LastLogin>
  <LegacyUserId>1</LegacyUserId>
  <LoginId>1</LoginId>
  <ResetPasswordKey>sample string 6</ResetPasswordKey>
  <ResetPasswordKeySent>2020-02-15T20:30:44.2390738+00:00</ResetPasswordKeySent>
  <Status>sample string 5</Status>
  <UtilityId>2</UtilityId>
  <WhenCreated>2020-02-15T20:30:44.2390738+00:00</WhenCreated>
</Login>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'Login'.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.