GET api/User/ReadUserProfile

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

R_Read_Profile
NameDescriptionTypeAdditional information
Address

W_CustomerAddress

None.

AddressID

integer

Required

Matching regular expression pattern: ^[0-9]{1,11}$

FirstName

string

Required

String length: inclusive between 2 and 45

LastName

string

Required

String length: inclusive between 2 and 60

DateOfBirth

date

Required

Data type: Date

Gender

Gender

Required

PrimaryPhone

string

Required

PrimaryScreen

CustomerRole

Required

Response Formats

application/json, text/json

Sample:
{
  "address": {
    "addressNickName": "sample string 1",
    "addressStreetAddress1": "sample string 2",
    "addressStreetAddress2": "sample string 3",
    "addressCity": "sample string 4",
    "addressState": "sample string 5",
    "addressZipCode": "sample string 6",
    "addressCountry": "sample string 7"
  },
  "addressID": 1,
  "firstName": "sample string 2",
  "lastName": "sample string 3",
  "dateOfBirth": "2019-09-14T23:26:48.1138342-07:00",
  "gender": "MALE",
  "primaryPhone": "sample string 5",
  "primaryScreen": "USER"
}

application/xml, text/xml

Sample:
<R_Read_Profile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PGDataStructures">
  <AddressID>1</AddressID>
  <DateOfBirth>2019-09-14T23:26:48.1138342-07:00</DateOfBirth>
  <FirstName>sample string 2</FirstName>
  <Gender>MALE</Gender>
  <LastName>sample string 3</LastName>
  <PrimaryPhone>sample string 5</PrimaryPhone>
  <PrimaryScreen>USER</PrimaryScreen>
  <Address>
    <AddressCity>sample string 4</AddressCity>
    <AddressCountry>sample string 7</AddressCountry>
    <AddressState>sample string 5</AddressState>
    <AddressStreetAddress1>sample string 2</AddressStreetAddress1>
    <AddressStreetAddress2>sample string 3</AddressStreetAddress2>
    <AddressZipCode>sample string 6</AddressZipCode>
    <AddressNickName>sample string 1</AddressNickName>
  </Address>
</R_Read_Profile>

multipart/form-data

Sample:
<R_Read_Profile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PGDataStructures"><AddressID>1</AddressID><DateOfBirth>2019-09-14T23:26:48.1138342-07:00</DateOfBirth><FirstName>sample string 2</FirstName><Gender>MALE</Gender><LastName>sample string 3</LastName><PrimaryPhone>sample string 5</PrimaryPhone><PrimaryScreen>USER</PrimaryScreen><Address><AddressCity>sample string 4</AddressCity><AddressCountry>sample string 7</AddressCountry><AddressState>sample string 5</AddressState><AddressStreetAddress1>sample string 2</AddressStreetAddress1><AddressStreetAddress2>sample string 3</AddressStreetAddress2><AddressZipCode>sample string 6</AddressZipCode><AddressNickName>sample string 1</AddressNickName></Address></R_Read_Profile>