POST Api/Message/GetUserProfile

Request Information

URI Parameters

None.

Body Parameters

GetUserProfileRequest
NameDescriptionTypeAdditional information
MeterNumber

string

None.

Username

string

None.

Password

string

None.

DeviceManufacturer

string

None.

DeviceModel

string

None.

DeviceSDKInt

string

None.

DeviceSDKVersion

string

None.

Request Formats

application/json, text/json

Sample:
{
  "MeterNumber": "sample string 1",
  "Username": "sample string 2",
  "Password": "sample string 3",
  "DeviceManufacturer": "sample string 4",
  "DeviceModel": "sample string 5",
  "DeviceSDKInt": "sample string 6",
  "DeviceSDKVersion": "sample string 7"
}

application/xml, text/xml

Sample:
<GetUserProfileRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPWAssistMobileAPI.Models">
  <DeviceManufacturer>sample string 4</DeviceManufacturer>
  <DeviceModel>sample string 5</DeviceModel>
  <DeviceSDKInt>sample string 6</DeviceSDKInt>
  <DeviceSDKVersion>sample string 7</DeviceSDKVersion>
  <Password>sample string 3</Password>
  <Username>sample string 2</Username>
  <MeterNumber>sample string 1</MeterNumber>
</GetUserProfileRequest>

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 'GetUserProfileRequest'.

Response Information

Resource Description

GetUserProfileResponse
NameDescriptionTypeAdditional information
UserProfiles

Collection of UserProfile

None.

Success

boolean

None.

ErrorMessage

string

None.

ServerDateTime

string

None.

ErrorType

Errors

None.

Response Formats

application/json, text/json

Sample:
{
  "UserProfiles": [
    {
      "UserID": "4c8be2ea-8e2c-4ecb-9810-3b68970b7c48",
      "Firstname": "sample string 2",
      "Lastname": "sample string 3",
      "EmailAddress": "sample string 4",
      "CellphoneNumber": "sample string 5",
      "FirebaseToken": "sample string 6",
      "DeviceManufacturer": "sample string 7",
      "DeviceModel": "sample string 8"
    },
    {
      "UserID": "4c8be2ea-8e2c-4ecb-9810-3b68970b7c48",
      "Firstname": "sample string 2",
      "Lastname": "sample string 3",
      "EmailAddress": "sample string 4",
      "CellphoneNumber": "sample string 5",
      "FirebaseToken": "sample string 6",
      "DeviceManufacturer": "sample string 7",
      "DeviceModel": "sample string 8"
    }
  ],
  "Success": true,
  "ErrorMessage": "sample string 2",
  "ServerDateTime": "sample string 3",
  "ErrorType": 0
}

application/xml, text/xml

Sample:
<GetUserProfileResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPWAssistMobileAPI.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <ErrorType>SystemError</ErrorType>
  <ServerDateTime>sample string 3</ServerDateTime>
  <Success>true</Success>
  <UserProfiles>
    <UserProfile>
      <CellphoneNumber>sample string 5</CellphoneNumber>
      <DeviceManufacturer>sample string 7</DeviceManufacturer>
      <DeviceModel>sample string 8</DeviceModel>
      <EmailAddress>sample string 4</EmailAddress>
      <FirebaseToken>sample string 6</FirebaseToken>
      <Firstname>sample string 2</Firstname>
      <Lastname>sample string 3</Lastname>
      <UserID>4c8be2ea-8e2c-4ecb-9810-3b68970b7c48</UserID>
    </UserProfile>
    <UserProfile>
      <CellphoneNumber>sample string 5</CellphoneNumber>
      <DeviceManufacturer>sample string 7</DeviceManufacturer>
      <DeviceModel>sample string 8</DeviceModel>
      <EmailAddress>sample string 4</EmailAddress>
      <FirebaseToken>sample string 6</FirebaseToken>
      <Firstname>sample string 2</Firstname>
      <Lastname>sample string 3</Lastname>
      <UserID>4c8be2ea-8e2c-4ecb-9810-3b68970b7c48</UserID>
    </UserProfile>
  </UserProfiles>
</GetUserProfileResponse>