Jump to

• Request
• Response
• Examples

Get Sales Company User

get

/rest/v16/salesCompanies/{companyLogin}/users/{userLoginName}

Use this endpoint to retrieve the specified sales company user.

Request

Path Parameters

• companyLogin(required): string
  The unique variable name to identify the company
• userLoginName(required): string
  The unique login of the sales user

Back to Top

Response

200 Response

The users for the company retrieved successfully

Body ()

Root Schema : salesUserItem

Type: object

Show Source

• dateAdded: string
  Example: 2008-05-03T15:29:35.000Z
• dateModified: string
  Example: 2008-05-03T15:29:35.000Z
• email: string
  Example: [e-mail]
• firstName: string
  Example: Kevin
• lastName: string
  Example: Peterson
• links: array links
• login: string
  Example: user1234
• userKey: string
  Example: sssss-fffff-3333-aaa

{
    "type":"object",
    "properties":{
        "login":{
            "type":"string",
            "example":"user1234"
        },
        "firstName":{
            "type":"string",
            "example":"Kevin"
        },
        "lastName":{
            "type":"string",
            "example":"Peterson"
        },
        "userKey":{
            "type":"string",
            "example":"sssss-fffff-3333-aaa"
        },
        "email":{
            "type":"string",
            "example":"[e-mail]"
        },
        "dateAdded":{
            "type":"string",
            "example":"2008-05-03T15:29:35.000Z"
        },
        "dateModified":{
            "type":"string",
            "example":"2008-05-03T15:29:35.000Z"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object reference links
  Title: reference links

  Reference links for the Parent, Self, Children and Related as applicable

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

Nested Schema : reference links

Type: object

Title: reference links

Reference links for the Parent, Self, Children and Related as applicable

Show Source

• href: string
  Title: URL to the related object

  URL to the related object
• name: string
• rel: string
  Title: Link Relationship to the current object

  Default Value: self

  Link Relationship to the current object

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Link Relationship to the current object",
            "title":"Link Relationship to the current object",
            "default":"self"
        },
        "href":{
            "type":"string",
            "description":"URL to the related object",
            "title":"URL to the related object"
        },
        "name":{
            "type":"string"
        }
    },
    "title":"reference links",
    "description":"Reference links for the Parent, Self, Children and Related as applicable"
}

403 Response

User has no access to the company resource

404 Response

The company resource or the user not found

Back to Top

Examples

The following example shows how to retrieve the specified sales company user by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl - X GET - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v16/salesCompanies/a_Co1BM/users/FA_date4

Response Body Sample

{
  "login": "FA_date4",
  "firstName": "duncin",
  "lastName": "salesagent",
  "userKey": "d453a7df-b6d1-4dbf-8ebe-9507e0740d16",
  "email": "[e-mail]",
  "dateAdded": "2011-02-09T22:55:11.000Z",
  "dateModified": "2024-05-14T04:19:16.000Z",
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v16/salesCompanies/a_Co1BM/users/FA_date4"
    }, {
      "rel": "parent",
      "href": "https://sitename.oracle.com/rest/v16/salesCompanies/a_Co1BM/users"
    }
  ]
}

Back to Top