GET api/Users?externalId={externalId}

Gets information about an user.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
externalId

Unique ID of the user on integrating system.

 string

Required

Body Parameters

None.

Response Information

Resource Description

UserModel
NameDescriptionTypeAdditional information
Username

User's username (Required).

 string

None.
Password

User's password (Required).

 string

None.
PasswordConfirmation

User's password (Required).

 string

None.
Active

Indicates whether the user is active or not.

 boolean

None.
Notes

User's notes.

 string

None.
UpDoxId

User's up dox ID.

 string

None.
Contact

User's contact information (Required).

 ContactModel

None.
Locations

Locations to which the user has access.

 Collection of string

None.
Id

Unique ID of the model in the portal (Read only).

 globally unique identifier

None.
ExternalId

Unique ID of the model on integrating system (Required).

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "username": "sample string 1",
  "password": "sample string 2",
  "passwordConfirmation": "sample string 3",
  "active": true,
  "notes": "sample string 5",
  "upDoxId": "sample string 6",
  "contact": {
    "id": "67213dac-fd42-4a2d-ae03-abc9ad4183b9",
    "firstName": "sample string 2",
    "middleName": "sample string 3",
    "lastName": "sample string 4",
    "suffix": "sample string 5",
    "prefix": "sample string 6",
    "fullName": "sample string 7",
    "companyName": "sample string 8",
    "jobTitle": "sample string 9",
    "emailAddresses": [
      {
        "id": "26c0f17d-9c9d-4801-872a-b912ea3d0347",
        "alias": "sample string 2",
        "address": "sample string 3",
        "default": true,
        "sortOrder": 5
      },
      {
        "id": "26c0f17d-9c9d-4801-872a-b912ea3d0347",
        "alias": "sample string 2",
        "address": "sample string 3",
        "default": true,
        "sortOrder": 5
      }
    ],
    "phoneNumbers": [
      {
        "id": "1dc4db16-db1f-4778-802d-1e09d5057408",
        "alias": "sample string 2",
        "number": "sample string 3",
        "default": true,
        "useForSms": true,
        "sortOrder": 6
      },
      {
        "id": "1dc4db16-db1f-4778-802d-1e09d5057408",
        "alias": "sample string 2",
        "number": "sample string 3",
        "default": true,
        "useForSms": true,
        "sortOrder": 6
      }
    ],
    "postalAddresses": [
      {
        "id": "7ec03d8e-0091-474c-b90a-3885fa344740",
        "alias": "sample string 2",
        "address1": "sample string 3",
        "address2": "sample string 4",
        "city": "sample string 5",
        "state": "sample string 6",
        "countryId": "2b575c69-2d2d-425f-b0cc-79d6acf6d1a7",
        "countryCode": "sample string 7",
        "countryName": "sample string 8",
        "zip": "sample string 9",
        "default": true
      },
      {
        "id": "7ec03d8e-0091-474c-b90a-3885fa344740",
        "alias": "sample string 2",
        "address1": "sample string 3",
        "address2": "sample string 4",
        "city": "sample string 5",
        "state": "sample string 6",
        "countryId": "2b575c69-2d2d-425f-b0cc-79d6acf6d1a7",
        "countryCode": "sample string 7",
        "countryName": "sample string 8",
        "zip": "sample string 9",
        "default": true
      }
    ],
    "notes": "sample string 10"
  },
  "locations": [
    "sample string 1",
    "sample string 2"
  ],
  "id": "0c4a502d-21fe-419b-88e0-04275ea2881b",
  "externalId": "sample string 8"
}

application/xml, text/xml

Sample: 
<UserModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.Users">
  <ExternalId xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">sample string 8</ExternalId>
  <Id xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">0c4a502d-21fe-419b-88e0-04275ea2881b</Id>
  <Active>true</Active>
  <Contact xmlns:d2p1="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.Contacts">
    <d2p1:CompanyName>sample string 8</d2p1:CompanyName>
    <d2p1:EmailAddresses>
      <d2p1:EmailAddressModel>
        <d2p1:Address>sample string 3</d2p1:Address>
        <d2p1:Alias>sample string 2</d2p1:Alias>
        <d2p1:Default>true</d2p1:Default>
        <d2p1:Id>26c0f17d-9c9d-4801-872a-b912ea3d0347</d2p1:Id>
        <d2p1:SortOrder>5</d2p1:SortOrder>
      </d2p1:EmailAddressModel>
      <d2p1:EmailAddressModel>
        <d2p1:Address>sample string 3</d2p1:Address>
        <d2p1:Alias>sample string 2</d2p1:Alias>
        <d2p1:Default>true</d2p1:Default>
        <d2p1:Id>26c0f17d-9c9d-4801-872a-b912ea3d0347</d2p1:Id>
        <d2p1:SortOrder>5</d2p1:SortOrder>
      </d2p1:EmailAddressModel>
    </d2p1:EmailAddresses>
    <d2p1:FirstName>sample string 2</d2p1:FirstName>
    <d2p1:FullName>sample string 7</d2p1:FullName>
    <d2p1:Id>67213dac-fd42-4a2d-ae03-abc9ad4183b9</d2p1:Id>
    <d2p1:JobTitle>sample string 9</d2p1:JobTitle>
    <d2p1:LastName>sample string 4</d2p1:LastName>
    <d2p1:MiddleName>sample string 3</d2p1:MiddleName>
    <d2p1:Notes>sample string 10</d2p1:Notes>
    <d2p1:PhoneNumbers>
      <d2p1:PhoneNumberModel>
        <d2p1:Alias>sample string 2</d2p1:Alias>
        <d2p1:Default>true</d2p1:Default>
        <d2p1:Id>1dc4db16-db1f-4778-802d-1e09d5057408</d2p1:Id>
        <d2p1:Number>sample string 3</d2p1:Number>
        <d2p1:SortOrder>6</d2p1:SortOrder>
        <d2p1:UseForSms>true</d2p1:UseForSms>
      </d2p1:PhoneNumberModel>
      <d2p1:PhoneNumberModel>
        <d2p1:Alias>sample string 2</d2p1:Alias>
        <d2p1:Default>true</d2p1:Default>
        <d2p1:Id>1dc4db16-db1f-4778-802d-1e09d5057408</d2p1:Id>
        <d2p1:Number>sample string 3</d2p1:Number>
        <d2p1:SortOrder>6</d2p1:SortOrder>
        <d2p1:UseForSms>true</d2p1:UseForSms>
      </d2p1:PhoneNumberModel>
    </d2p1:PhoneNumbers>
    <d2p1:PostalAddresses>
      <d2p1:PostalAddressModel>
        <d2p1:Address1>sample string 3</d2p1:Address1>
        <d2p1:Address2>sample string 4</d2p1:Address2>
        <d2p1:Alias>sample string 2</d2p1:Alias>
        <d2p1:City>sample string 5</d2p1:City>
        <d2p1:CountryCode>sample string 7</d2p1:CountryCode>
        <d2p1:CountryId>2b575c69-2d2d-425f-b0cc-79d6acf6d1a7</d2p1:CountryId>
        <d2p1:CountryName>sample string 8</d2p1:CountryName>
        <d2p1:Default>true</d2p1:Default>
        <d2p1:Id>7ec03d8e-0091-474c-b90a-3885fa344740</d2p1:Id>
        <d2p1:State>sample string 6</d2p1:State>
        <d2p1:Zip>sample string 9</d2p1:Zip>
      </d2p1:PostalAddressModel>
      <d2p1:PostalAddressModel>
        <d2p1:Address1>sample string 3</d2p1:Address1>
        <d2p1:Address2>sample string 4</d2p1:Address2>
        <d2p1:Alias>sample string 2</d2p1:Alias>
        <d2p1:City>sample string 5</d2p1:City>
        <d2p1:CountryCode>sample string 7</d2p1:CountryCode>
        <d2p1:CountryId>2b575c69-2d2d-425f-b0cc-79d6acf6d1a7</d2p1:CountryId>
        <d2p1:CountryName>sample string 8</d2p1:CountryName>
        <d2p1:Default>true</d2p1:Default>
        <d2p1:Id>7ec03d8e-0091-474c-b90a-3885fa344740</d2p1:Id>
        <d2p1:State>sample string 6</d2p1:State>
        <d2p1:Zip>sample string 9</d2p1:Zip>
      </d2p1:PostalAddressModel>
    </d2p1:PostalAddresses>
    <d2p1:Prefix>sample string 6</d2p1:Prefix>
    <d2p1:Suffix>sample string 5</d2p1:Suffix>
  </Contact>
  <Locations xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Locations>
  <Notes>sample string 5</Notes>
  <Password>sample string 2</Password>
  <PasswordConfirmation>sample string 3</PasswordConfirmation>
  <UpDoxId>sample string 6</UpDoxId>
  <Username>sample string 1</Username>
</UserModel>