Export (0) Print
Expand All
me
to
Expand Minimize

me (UCWA)

Last modified: June 17, 2013

Applies to: Lync Server 2013

In this article
Web link
Resource description
Events
Operations

Represents the user.

For more on web links, see Web links.

Name

Description

rel

The resource that this link points to. In JSON, this is the outer container.

href

The location of this resource on the server, and the target of an HTTP operation.

me will get updated whenever the application becomes ready for incoming calls and leaves lurker mode (makeMeAvailable). Please note that me will not get updated if any of its properties, such as emailAddresses or title, change while the application is active.

Properties

Name

Description

department

The user's department.

emailAddresses

The user's e-mail addresses.

name

The user's display name.

title

The user's title.

uri

The user's URI.

Links

This resource can have the following relationships.

Link

Description

self

The link to the current resource.

callForwardingSettings (UCWA)

Represents settings that govern call forwarding.

location (UCWA)

Represents the user's location.

makeMeAvailable (UCWA)

Makes the user available for incoming communications.

note (UCWA)

Represents the user's personal or out-of-office note.

phones (UCWA)

A collection of phone resources that represent the phone numbers of the logged-on user.

photo (UCWA)

Represents the user's photo.

presence (UCWA)

Represents the user's availability and activity.

reportMyActivity (UCWA)

Indicates that the user is actively using this application.

updated

Resource

Priority

Sender

Reason

me

Medium

me

Indicates that the application is no longer in lurker mode and therefore visible to contacts. The application can now set things such as the user's presence and note.

Sample of returned event data.

This sample is given only as an illustration of event syntax. The semantic content is not guaranteed to correspond to a valid scenario.

{
  "_links" : {
    "self" : {
      "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/543/events?ack=1"
    },
    "next" : {
      "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/543/events?ack=2"
    }
  },
  "sender" : [
    {
      "rel" : "me",
      "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/543/me",
      "events" : [
        {
          "link" : {
            "rel" : "me",
            "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/543/me"
          },
          "type" : "updated"
        }
      ]
    }
  ]
}

GET

Operation description coming soon...

Request body

None

Response body

The response from a GET request contains the properties and links shown in the Properties and Links sections at the top of this page.

Synchronous errors

The errors below, if any, are specific to this resource. Generic errors that can apply to any resource are covered in Generic synchronous errors.

Error

Code

Subcode

Description

Conflict

409

None

Returned when an application is in the process of initializing or terminating.

Examples

JSON Request

Get https://fe1.contoso.com:443/ucwa/v1/applications/543/me HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Accept: application/json


JSON Response

This sample is given only as an illustration of response syntax. The semantic content is not guaranteed to correspond to a valid scenario.

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 732
{
  "rel" : "me",
  "department" : "Sales",
  "emailAddresses" : [
    "johndoe@contoso.com"
  ],
  "name" : "JohnDoe",
  "title" : "SeniorManager",
  "uri" : "sip : johndoe@contoso.com",
  "_links" : {
    "self" : {
      "href" : "/ucwa/v1/applications/543/me"
    },
    "callForwardingSettings" : {
      "href" : "/ucwa/v1/applications/543/me/callForwardingSettings"
    },
    "location" : {
      "href" : "/ucwa/v1/applications/543/me/location"
    },
    "makeMeAvailable" : {
      "href" : "/ucwa/v1/applications/543/communication/makeMeAvailable"
    },
    "note" : {
      "href" : "/ucwa/v1/applications/543/me/note"
    },
    "phones" : {
      "href" : "/ucwa/v1/applications/543/me/phones"
    },
    "photo" : {
      "href" : "/ucwa/v1/applications/543/photo"
    },
    "presence" : {
      "href" : "/ucwa/v1/applications/543/me/presence"
    },
    "reportMyActivity" : {
      "href" : "/ucwa/v1/applications/543/reportMyActivity"
    }
  }
}

XML Request

Get https://fe1.contoso.com:443/ucwa/v1/applications/543/me HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Accept: application/xml

XML Response

This sample is given only as an illustration of response syntax. The semantic content is not guaranteed to correspond to a valid scenario.

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 1052
<?xml version="1.0" encoding="utf-8"?>
<resource rel="me" href="/ucwa/v1/applications/543/me" xmlns="http://schemas.microsoft.com/rtc/2012/03/ucwa">
  <link rel="callForwardingSettings" href="/ucwa/v1/applications/543/me/callForwardingSettings" />
  <link rel="location" href="/ucwa/v1/applications/543/me/location" />
  <link rel="makeMeAvailable" href="/ucwa/v1/applications/543/communication/makeMeAvailable" />
  <link rel="note" href="/ucwa/v1/applications/543/me/note" />
  <link rel="phones" href="/ucwa/v1/applications/543/me/phones" />
  <link rel="photo" href="/ucwa/v1/applications/543/photo" />
  <link rel="presence" href="/ucwa/v1/applications/543/me/presence" />
  <link rel="reportMyActivity" href="/ucwa/v1/applications/543/reportMyActivity" />
  <property name="rel">me</property>
  <property name="department">Sales</property>
  <propertyList name="emailAddresses">
    <item>johndoe@contoso.com</item>
  </propertyList>
  <property name="name">John Doe</property>
  <property name="title">Senior Manager</property>
  <property name="uri">sip:johndoe@contoso.com</property>
</resource>

Show:
© 2014 Microsoft