Export (0) Print
Expand All
me
to
Expand Minimize

applications (UCWA)

Lync 2013

Last modified: June 17, 2013

Applies to: Lync Server 2013

In this article
Web link
#sectionSection1
Operations

Represents the entry point for registering this application with the server.

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.

Properties

None

Links

None

POST

This very first operation used to create an instance of the application resource. The application resource is the starting point for all applications to discover and navigate all available resources and capabilities of the service.

Request body

Name

Description

Required?

culture

Gets or sets the Culture of the client. Cannot be null or empty. The maximum length is 100 characters.

Yes

endpointId

Gets or sets a unique Id for this application. This value is required and cannot be null or empty. This value does not have to necessarily match the device id on which the application is running. But, it should be unique among applications for the same user currently running across all the devices. The maximum length is 100 characters.

Yes

userAgent

Gets or sets the user agent string to be used for identifying messages sent on behalf of this application. This value is required and cannot be null or empty. The maximum length is 100 characters.

Yes

Response body

Item

Description

application

Represents your real-time communication application.

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

Forbidden

403

None

Forbidden when a federated Office Communications Server 2007 R2 user joins a meeting.

Forbidden

403

None

Indicates that user is not allowed to create mobile application.

Examples

JSON Request

Post https://fe1.contoso.com:443/ucwa/v1/applications HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Content-Type: application/json
Accept: application/json
Content-Length: 93
{
  "culture" : "en-us",
  "endpointId" : "123456",
  "userAgent" : "ContosoApp/1.0(WindowsPhoneOS7.5)"
}
  

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 201 Created
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

Post https://fe1.contoso.com:443/ucwa/v1/applications HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Content-Type: application/xml
Accept: application/xml
Content-Length: 268
<?xml version="1.0" encoding="utf-8"?>
<input xmlns="http://schemas.microsoft.com/rtc/2012/03/ucwa">
  <property name="culture">en-us</property>
  <property name="endpointId">123456</property>
  <property name="userAgent">ContosoApp/1.0 (Windows Phone OS 7.5)</property>
</input>

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 201 Created
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>

Show:
© 2015 Microsoft