Export (0) Print
Expand All
me
to
Expand Minimize

application (UCWA)

Last modified: July 30, 2013

Applies to: Lync Server 2013

In this article
Web link
Resource description
Operations

Represents your real-time communication application.

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.

This resource represents an application on one of the user's devices. This resource is used as entry point to start to communicate and collaborate. The application gives all supported capabilities and embeds the resources associated with the following relationships: me (UCWA), people (UCWA), communication (UCWA), onlineMeetings (UCWA).The application resource will expire if the application remains idle (i.e. no HTTP requests are received for a period of time from the application) for a certain amount of time. The expiration time varies depending upon whether the application makes use of the event channel (by issuing pending GETs on events) or not.

Properties

Name

Description

culture

The culture and locale information. This property is used to control various language-specific items, such as the language of the online meeting announcement service.

userAgent

The application user agent. This property specifies the identity of the application and possibly can specify information about the operating system.

Links

This resource can have the following relationships.

Link

Description

self

The link to the current resource.

batch (UCWA)

Initiates an operation that groups multiple, independent HTTP operations into a single HTTP request payload.

events (UCWA)

Represents the event channel resource.

policies (UCWA)

Represents the admin policies that may apply to a user's application.

communication (UCWA)

Represents the dashboard for communication capabilities.

me (UCWA)

Represents the user.

onlineMeetings (UCWA)

Represents the dashboard for viewing and scheduling online meetings.

people (UCWA)

A hub for the people with whom the logged-on user can communicate, using Lync.

GET

Returns a representation of an application.

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.

Examples

JSON Request

Get https://fe1.contoso.com:443/ucwa/v1/applications/543 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: 3332
{
  "rel" : "application",
  "culture" : "en-us",
  "userAgent" : "ContosoApp/1.0",
  "_links" : {
    "self" : {
      "href" : "/ucwa/v1/applications/543"
    },
    "batch" : {
      "href" : "/ucwa/v1/applications/543/batch"
    },
    "events" : {
      "href" : "/ucwa/v1/applications/543/events"
    },
    "policies" : {
      "href" : "/ucwa/v1/applications/543/policies"
    }
  },
  "_embedded" : {
    "communication" : {
      "rel" : "communication",
      "phoneNumber" : "tel : +14255552222",
      "supportedMessageFormats" : [
        "Plain",
        "Html"
      ],
      "supportedModalities" : [
        "PhoneAudio",
        "Messaging"
      ],
      "_links" : {
        "self" : {
          "href" : "/ucwa/v1/applications/543/communication"
        },
        "conversations" : {
          "href" : "/ucwa/v1/applications/543/communication/conversations"
        },
        "joinOnlineMeeting" : {
          "href" : "/ucwa/v1/applications/543/communication/joinOnlineMeeting"
        },
        "startMessaging" : {
          "href" : "/ucwa/v1/applications/543/communication/startMessaging"
        },
        "startOnlineMeeting" : {
          "href" : "/ucwa/v1/applications/543/communication/startOnlineMeeting"
        },
        "startPhoneAudio" : {
          "href" : "/ucwa/v1/applications/543/communication/startPhoneAudio"
        }
      }
    },
    "me" : {
      "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"
        }
      }
    },
    "onlineMeetings" : {
      "rel" : "onlineMeetings",
      "_links" : {
        "self" : {
          "href" : "/ucwa/v1/applications/543/onlineMeetings"
        },
        "myAssignedOnlineMeeting" : {
          "href" : "/ucwa/v1/applications/543/onlineMeetings/myOnlineMeetings/143"
        },
        "myOnlineMeetings" : {
          "href" : "/ucwa/v1/applications/543/onlineMeetings/myOnlineMeetings"
        },
        "onlineMeetingDefaultValues" : {
          "href" : "/ucwa/v1/applications/543/onlineMeetings/onlineMeetingDefaultValues"
        },
        "onlineMeetingEligibleValues" : {
          "href" : "/ucwa/v1/applications/543/onlineMeetings/onlineMeetingEligibleValues"
        },
        "onlineMeetingInvitationCustomization" : {
          "href" : "/ucwa/v1/applications/543/onlineMeetings/onlineMeetingInvitationCustomization"
        },
        "onlineMeetingPolicies" : {
          "href" : "/ucwa/v1/applications/543/onlineMeetings/onlineMeetingPolicies"
        },
        "phoneDialInInformation" : {
          "href" : "/ucwa/v1/applications/543/onlineMeetings/phoneDialInInformation"
        }
      }
    },
    "people" : {
      "rel" : "people",
      "_links" : {
        "self" : {
          "href" : "/ucwa/v1/applications/543/people"
        },
        "myContactsAndGroupsSubscription" : {
          "href" : "/ucwa/v1/applications/543/people/myContactsAndGroupsSubscription"
        },
        "myContacts" : {
          "href" : "/ucwa/v1/applications/543/contacts"
        },
        "myGroupMemberships" : {
          "href" : "/ucwa/v1/applications/543/myGroupMemberships"
        },
        "myGroups" : {
          "href" : "/ucwa/v1/applications/543/groups"
        },
        "myPrivacyRelationships" : {
          "href" : "/ucwa/v1/applications/543/myPrivacyRelationships"
        },
        "presenceSubscriptionMemberships" : {
          "href" : "/ucwa/v1/applications/543/presenceSubscriptionMemberships"
        },
        "presenceSubscriptions" : {
          "href" : "/ucwa/v1/applications/543/presenceSubscriptions"
        },
        "search" : {
          "href" : "/ucwa/v1/applications/543/search"
        },
        "subscribedContacts" : {
          "href" : "/ucwa/v1/applications/543/subscribedContacts"
        }
      }
    }
  }
}
  

XML Request

Get https://fe1.contoso.com:443/ucwa/v1/applications/543 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: 4108
<?xml version="1.0" encoding="utf-8"?>
<resource rel="application" href="/ucwa/v1/applications/543" xmlns="http://schemas.microsoft.com/rtc/2012/03/ucwa">
  <link rel="batch" href="/ucwa/v1/applications/543/batch" />
  <link rel="events" href="/ucwa/v1/applications/543/events" />
  <link rel="policies" href="/ucwa/v1/applications/543/policies" />
  <property name="rel">application</property>
  <property name="culture">en-us</property>
  <property name="userAgent">ContosoApp/1.0</property>
  <resource rel="communication" href="/ucwa/v1/applications/543/communication">
    <link rel="conversations" href="/ucwa/v1/applications/543/communication/conversations" />
    <link rel="joinOnlineMeeting" href="/ucwa/v1/applications/543/communication/joinOnlineMeeting" />
    <link rel="startMessaging" href="/ucwa/v1/applications/543/communication/startMessaging" />
    <link rel="startOnlineMeeting" href="/ucwa/v1/applications/543/communication/startOnlineMeeting" />
    <link rel="startPhoneAudio" href="/ucwa/v1/applications/543/communication/startPhoneAudio" />
    <property name="rel">communication</property>
    <property name="phoneNumber">tel:+14255552222</property>
    <propertyList name="supportedMessageFormats">
      <item>Plain</item>
      <item>Html</item>
    </propertyList>
    <propertyList name="supportedModalities">
      <item>PhoneAudio</item>
      <item>Messaging</item>
    </propertyList>
  </resource>
  <resource rel="me" href="/ucwa/v1/applications/543/me">
    <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>
  <resource rel="onlineMeetings" href="/ucwa/v1/applications/543/onlineMeetings">
    <link rel="myAssignedOnlineMeeting" href="/ucwa/v1/applications/543/onlineMeetings/myOnlineMeetings/143" />
    <link rel="myOnlineMeetings" href="/ucwa/v1/applications/543/onlineMeetings/myOnlineMeetings" />
    <link rel="onlineMeetingDefaultValues" href="/ucwa/v1/applications/543/onlineMeetings/onlineMeetingDefaultValues" />
    <link rel="onlineMeetingEligibleValues" href="/ucwa/v1/applications/543/onlineMeetings/onlineMeetingEligibleValues" />
    <link rel="onlineMeetingInvitationCustomization" href="/ucwa/v1/applications/543/onlineMeetings/onlineMeetingInvitationCustomization" />
    <link rel="onlineMeetingPolicies" href="/ucwa/v1/applications/543/onlineMeetings/onlineMeetingPolicies" />
    <link rel="phoneDialInInformation" href="/ucwa/v1/applications/543/onlineMeetings/phoneDialInInformation" />
    <property name="rel">onlineMeetings</property>
  </resource>
  <resource rel="people" href="/ucwa/v1/applications/543/people">
    <link rel="myContactsAndGroupsSubscription" href="/ucwa/v1/applications/543/people/myContactsAndGroupsSubscription" />
    <link rel="myContacts" href="/ucwa/v1/applications/543/contacts" />
    <link rel="myGroupMemberships" href="/ucwa/v1/applications/543/myGroupMemberships" />
    <link rel="myGroups" href="/ucwa/v1/applications/543/groups" />
    <link rel="myPrivacyRelationships" href="/ucwa/v1/applications/543/myPrivacyRelationships" />
    <link rel="presenceSubscriptionMemberships" href="/ucwa/v1/applications/543/presenceSubscriptionMemberships" />
    <link rel="presenceSubscriptions" href="/ucwa/v1/applications/543/presenceSubscriptions" />
    <link rel="search" href="/ucwa/v1/applications/543/search" />
    <link rel="subscribedContacts" href="/ucwa/v1/applications/543/subscribedContacts" />
    <property name="rel">people</property>
  </resource>
</resource>

DELETE

Terminates the running application. This operation will tear down all active communications and subscriptions, ultimately signing the application out.

Request body

None

Response body

None

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.

Examples

JSON Request

Delete https://fe1.contoso.com:443/ucwa/v1/applications/543 HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com


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 204 No Content

XML Request

Delete https://fe1.contoso.com:443/ucwa/v1/applications/543 HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com


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 204 No Content

Show:
© 2015 Microsoft