GET api/v3/Profile/GetProfile

Gets the Resgrid user profile for the user

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

ProfileResult object with the users profile data

ProfileResult
NameDescriptionTypeAdditional information
Uid

User Id the profile is for

string

None.

Adm

Is the user a Department Admin

boolean

None.

Hid

Is this user Hidden

boolean

None.

Dis

Is this user Disabled

boolean

None.

Lkd

Is the user locked out

boolean

None.

Fnm

First Name

string

None.

Lnm

Last Name

string

None.

Eml

Email Address

string

None.

Tz

Time Zone

string

None.

Mob

Mobile Number

string

None.

Moc

Mobile Carrier

integer

None.

Hmn

Home Number

string

None.

Sce

Send Call Emails

boolean

None.

Scp

Send Call Push Notifications

boolean

None.

Scs

Send Call SMS/Text Messages

boolean

None.

Sme

Send Message Email

boolean

None.

Smp

Send Message Push Notifications

boolean

None.

Sms

Send Message SMS/Text Messages

boolean

None.

Sne

Send Notification Email

boolean

None.

Snp

Send Notification Push Notifications

boolean

None.

Sns

Send Notification SMS/Text Messages

boolean

None.

Id

Department Issued Identification Number

string

None.

Val

Is the user allowed to set voice call data (based on the departments plan)

boolean

None.

Voc

Enable Voice/Telephone Dispatch/Notifications

boolean

None.

Vcm

Voice Call your Mobile Phone

boolean

None.

Vch

Voice Call your Home Phone

boolean

None.

Lup

Last Updated

date

None.

Hme

Home Address

AddressResult

None.

Mal

Mailing Address

AddressResult

None.

Response Formats

application/json

Sample:
{
  "Uid": "sample string 1",
  "Adm": true,
  "Hid": true,
  "Dis": true,
  "Lkd": true,
  "Fnm": "sample string 6",
  "Lnm": "sample string 7",
  "Eml": "sample string 8",
  "Tz": "sample string 9",
  "Mob": "sample string 10",
  "Moc": 11,
  "Hmn": "sample string 12",
  "Sce": true,
  "Scp": true,
  "Scs": true,
  "Sme": true,
  "Smp": true,
  "Sms": true,
  "Sne": true,
  "Snp": true,
  "Sns": true,
  "Id": "sample string 22",
  "Val": true,
  "Voc": true,
  "Vcm": true,
  "Vch": true,
  "Lup": "2017-12-14T00:20:24.4537338+00:00",
  "Hme": {
    "Aid": 1,
    "Str": "sample string 2",
    "Cty": "sample string 3",
    "Ste": "sample string 4",
    "Zip": "sample string 5",
    "Cnt": "sample string 6"
  },
  "Mal": {
    "Aid": 1,
    "Str": "sample string 2",
    "Cty": "sample string 3",
    "Ste": "sample string 4",
    "Zip": "sample string 5",
    "Cnt": "sample string 6"
  }
}

application/xml, text/xml

Sample:
<ProfileResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Resgrid.Web.Services.Controllers.Version3.Models.Profile">
  <Adm>true</Adm>
  <Dis>true</Dis>
  <Eml>sample string 8</Eml>
  <Fnm>sample string 6</Fnm>
  <Hid>true</Hid>
  <Hme>
    <Aid>1</Aid>
    <Cnt>sample string 6</Cnt>
    <Cty>sample string 3</Cty>
    <Ste>sample string 4</Ste>
    <Str>sample string 2</Str>
    <Zip>sample string 5</Zip>
  </Hme>
  <Hmn>sample string 12</Hmn>
  <Id>sample string 22</Id>
  <Lkd>true</Lkd>
  <Lnm>sample string 7</Lnm>
  <Lup>2017-12-14T00:20:24.4537338+00:00</Lup>
  <Mal>
    <Aid>1</Aid>
    <Cnt>sample string 6</Cnt>
    <Cty>sample string 3</Cty>
    <Ste>sample string 4</Ste>
    <Str>sample string 2</Str>
    <Zip>sample string 5</Zip>
  </Mal>
  <Mob>sample string 10</Mob>
  <Moc>11</Moc>
  <Sce>true</Sce>
  <Scp>true</Scp>
  <Scs>true</Scs>
  <Sme>true</Sme>
  <Smp>true</Smp>
  <Sms>true</Sms>
  <Sne>true</Sne>
  <Snp>true</Snp>
  <Sns>true</Sns>
  <Tz>sample string 9</Tz>
  <Uid>sample string 1</Uid>
  <Val>true</Val>
  <Vch>true</Vch>
  <Vcm>true</Vcm>
  <Voc>true</Voc>
</ProfileResult>