Jump to

• Request
• Response

Get a user

get

/learn.rest/v1/users/{userId}

Request

Path Parameters

• userId: number
  Unique identifier of User.

Security

• auth: basic
  Type: basic

  Description: Basic Authentication

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

user fetched

Body ()

Root Schema : User

Type: object

Show Source

• city(optional): string
  Example: Redwood Shores
• company(optional): string
  Example: oracle
• country(optional): string
  Example: USA
• createdDate(optional): string(datetime)
  Example: 2013-10-12T11:00:00-04:00
• department(optional): string
  Example: sales
• email(optional): string
  Example: [e-mail]
• email2(optional): string
  Example:
• employeeId(optional): string
  Example: H123
• fax(optional): string
  Example: n/a
• firstName(optional): string
  Example: cwal
• gender(optional): string
  Allowed Values: [ "male", "female" ]

  enum for gender are: male, female

  Example: male
• id(optional): number
  Example: 123123
• includeInSearchFlag(optional): boolean
  Example: false
• jobTitle(optional): string
  Example: sales manager
• lastAccesedDate(optional): string(datetime)
  Example: 2015-11-12T11:00:00-04:00
• lastName(optional): string
  Example: lace
• lastUpdatedByUser(optional): array lastUpdatedByUser
• lastUpdatedByUserId(optional): number
  Example: 123123
• lastUpdatedDate(optional): string(datetime)
  Example: 2017-10-12T11:00:00-04:00
• managerName(optional): string
  Example: n/a
• officeName(optional): string
  Example: n/a
• pager(optional): string
  Example: n/a
• pagerInteractive(optional): string
  Example: n/a
• passwordValidUntilDate(optional): string(datetime)
  Example: 2016-10-12T11:00:00-04:00
• phoneDaytime(optional): string
  Example: +1.800.392.2999
• phoneEvening(optional): string
  Example: n/a
• phoneMobile(optional): string
  Example: +1.800.392.2999
• postalCode(optional): string
  Example: 94065
• profession(optional): string
  Example: software engineer
• ssn(optional): string
  Example: n/a
• state(optional): string
  Example: CA
• street1(optional): string
  Example: 500 Oracle Parkway
• street2(optional): string
  Example: suite 500
• username(optional): string
  Username of the user

  Example: cwallace

{
    "type":"object",
    "properties":{
        "id":{
            "type":"number",
            "example":123123
        },
        "username":{
            "type":"string",
            "description":"Username of the user",
            "example":"cwallace"
        },
        "firstName":{
            "type":"string",
            "example":"cwal"
        },
        "lastName":{
            "type":"string",
            "example":"lace"
        },
        "street1":{
            "type":"string",
            "example":"500 Oracle Parkway"
        },
        "street2":{
            "type":"string",
            "example":"suite 500"
        },
        "city":{
            "type":"string",
            "example":"Redwood Shores"
        },
        "postalCode":{
            "type":"string",
            "example":"94065"
        },
        "state":{
            "type":"string",
            "example":"CA"
        },
        "country":{
            "type":"string",
            "example":"USA"
        },
        "phoneDaytime":{
            "type":"string",
            "example":"+1.800.392.2999"
        },
        "phoneEvening":{
            "type":"string",
            "example":"n/a"
        },
        "phoneMobile":{
            "type":"string",
            "example":"+1.800.392.2999"
        },
        "fax":{
            "type":"string",
            "example":"n/a"
        },
        "pager":{
            "type":"string",
            "example":"n/a"
        },
        "pagerInteractive":{
            "type":"string",
            "example":"n/a"
        },
        "email":{
            "type":"string",
            "example":"[e-mail]"
        },
        "email2":{
            "type":"string",
            "example":""
        },
        "gender":{
            "type":"string",
            "description":"enum for gender are: male, female",
            "enum":[
                "male",
                "female"
            ],
            "example":"male"
        },
        "ssn":{
            "type":"string",
            "example":"n/a"
        },
        "employeeId":{
            "type":"string",
            "example":"H123"
        },
        "company":{
            "type":"string",
            "example":"oracle"
        },
        "officeName":{
            "type":"string",
            "example":"n/a"
        },
        "department":{
            "type":"string",
            "example":"sales"
        },
        "jobTitle":{
            "type":"string",
            "example":"sales manager"
        },
        "profession":{
            "type":"string",
            "example":"software engineer"
        },
        "managerName":{
            "type":"string",
            "example":"n/a"
        },
        "createdDate":{
            "type":"string",
            "format":"datetime",
            "example":"2013-10-12T11:00:00-04:00"
        },
        "lastAccesedDate":{
            "type":"string",
            "format":"datetime",
            "example":"2015-11-12T11:00:00-04:00"
        },
        "lastUpdatedDate":{
            "type":"string",
            "format":"datetime",
            "example":"2017-10-12T11:00:00-04:00"
        },
        "lastUpdatedByUserId":{
            "type":"number",
            "example":123123
        },
        "lastUpdatedByUser":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserLink"
            }
        },
        "passwordValidUntilDate":{
            "type":"string",
            "format":"datetime",
            "example":"2016-10-12T11:00:00-04:00"
        },
        "includeInSearchFlag":{
            "type":"boolean",
            "example":false
        }
    },
    "xml":{
        "name":"User"
    }
}

Nested Schema : lastUpdatedByUser

Type: array

Show Source

• Array of: object UserLink

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserLink"
    }
}

Nested Schema : UserLink

Type: object

Show Source

• href(optional): string
  Example: {url}/learn.rest/v1/users/456
• rel(optional): string
  Example: canonical

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/users/456"
        }
    }
}

401 Response

Authentication refused for provided credentials or token invalid.

Headers

• WWW_Authenticate: string

404 Response

Resource not found.

500 Response

Internal server error.

Back to Top