Skype for Business - application Resource

application

  • JSON
  • XML

Represents your real-time communication application.

Web link

For more on web links, see Web Links.

Name Description
relThe resource that this link points to. In JSON, this is the outer container.
hrefThe location of this resource on the server, and the target of an HTTP operation.

Resource description

This resource represents an application on one of the user's devices. This resource is used as an entry point to start to communicate and collaborate. The application gives all supported capabilities and embeds the resources associated with the following relationships: me, people, communication, onlineMeetings.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.

endpointId Gets or sets the endpoint identifier.
instanceId Gets or sets the instance identifier.
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
selfThe link to the current resource.
batch Initiates an operation that groups multiple, independent HTTP operations into a single HTTP request payload.
events
policies Represents the admin policies that can apply to a user's application.
communication Represents the dashboard for communication capabilities.
me Represents the user.
onlineMeetings Represents the dashboard for viewing and scheduling online meetings.
people A hub for the people with whom the logged-on user can communicate, using Skype for Business.

Operations

  • GET
  • DELETE

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.

Error Code Subcode Description
ServiceFailure500InvalidExchangeServerVersion
Conflict409AlreadyExists
Conflict409TooManyGroups
Conflict409None

Examples

Request

Get https://fe1.contoso.com:443//v1/applications/970 HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Accept: application/json
if-none-match: a6743165-3b08-4724-b87a-5fa507d4290e

  

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
Etag: 3afad5af-7ec0-42d4-b643-144e1b9a24a0
Content-Type: application/json
Content-Length: 3487
{
  "rel" : "application",
  "culture" : "en-us",
  "endpointId" : "samplevalue",
  "instanceId" : "samplevalue",
  "userAgent" : "ContosoApp/1.0",
  "_links" : {
    "self" : {
      "href" : "//v1/applications/970"
    },
    "batch" : {
      "href" : "//v1/applications/970/batch"
    },
    "events" : {
      "href" : "http : //sample/ucwa/v1/applications/appId/events"
    },
    "policies" : {
      "href" : "//v1/applications/970/policies"
    }
  },
  "_embedded" : {
    "communication" : {
      "simultaneousRingNumberMatch" : "Disabled",
      "rel" : "communication",
      "conversationHistory" : "Disabled",
      "phoneNumber" : "tel : +14255552222",
      "supportedMessageFormats" : [
        "Plain",
        "Html"
      ],
      "supportedModalities" : [
        "PhoneAudio",
        "Messaging"
      ],
      "_links" : {
        "self" : {
          "href" : "//v1/applications/970/communication"
        },
        "conversationLogs" : {
          "href" : "//v1/applications/970/communication/conversationLogs"
        },
        "conversations" : {
          "href" : "//v1/applications/970/communication/conversations"
        },
        "joinOnlineMeeting" : {
          "href" : "//v1/applications/970/communication/joinOnlineMeeting"
        },
        "missedItems" : {
          "href" : "//v1/applications/970/communication/missedItems"
        },
        "startMessaging" : {
          "href" : "//v1/applications/970/communication/startMessaging"
        },
        "startOnlineMeeting" : {
          "href" : "//v1/applications/970/communication/startOnlineMeeting"
        },
        "startPhoneAudio" : {
          "href" : "//v1/applications/970/communication/startPhoneAudio"
        }
      }
    },
    "me" : {
      "rel" : "me",
      "department" : "Sales",
      "emailAddresses" : [
        "johndoe@contoso.com"
      ],
      "name" : "JohnDoe",
      "title" : "SeniorManager",
      "uri" : "sip : johndoe@contoso.com",
      "_links" : {
        "self" : {
          "href" : "//v1/applications/970/me"
        },
        "callForwardingSettings" : {
          "href" : "//v1/applications/970/me/callForwardingSettings"
        },
        "location" : {
          "href" : "//v1/applications/970/me/location"
        },
        "makeMeAvailable" : {
          "href" : "//v1/applications/970/communication/makeMeAvailable"
        },
        "note" : {
          "href" : "//v1/applications/970/me/note"
        },
        "phones" : {
          "href" : "//v1/applications/970/me/phones"
        },
        "photo" : {
          "href" : "//v1/applications/970/photo"
        },
        "presence" : {
          "href" : "//v1/applications/970/me/presence"
        },
        "reportMyActivity" : {
          "href" : "//v1/applications/970/reportMyActivity"
        }
      }
    },
    "onlineMeetings" : {
      "rel" : "onlineMeetings",
      "_links" : {
        "self" : {
          "href" : "//v1/applications/970/onlineMeetings"
        },
        "myAssignedOnlineMeeting" : {
          "href" : "//v1/applications/970/onlineMeetings/myOnlineMeetings/817"
        },
        "myOnlineMeetings" : {
          "href" : "//v1/applications/970/onlineMeetings/myOnlineMeetings"
        },
        "onlineMeetingDefaultValues" : {
          "href" : "//v1/applications/970/onlineMeetings/onlineMeetingDefaultValues"
        },
        "onlineMeetingEligibleValues" : {
          "href" : "//v1/applications/970/onlineMeetings/onlineMeetingEligibleValues"
        },
        "onlineMeetingInvitationCustomization" : {
          "href" : "//v1/applications/970/onlineMeetings/onlineMeetingInvitationCustomization"
        },
        "onlineMeetingPolicies" : {
          "href" : "//v1/applications/970/onlineMeetings/onlineMeetingPolicies"
        },
        "phoneDialInInformation" : {
          "href" : "//v1/applications/970/onlineMeetings/phoneDialInInformation"
        }
      }
    },
    "people" : {
      "rel" : "people",
      "_links" : {
        "self" : {
          "href" : "//v1/applications/970/people"
        },
        "myContactsAndGroupsSubscription" : {
          "href" : "//v1/applications/970/people/myContactsAndGroupsSubscription"
        },
        "myContacts" : {
          "href" : "//v1/applications/970/contacts"
        },
        "myGroupMemberships" : {
          "href" : "//v1/applications/970/myGroupMemberships"
        },
        "myGroups" : {
          "href" : "//v1/applications/970/groups"
        },
        "myPrivacyRelationships" : {
          "href" : "//v1/applications/970/myPrivacyRelationships"
        },
        "presenceSubscriptionMemberships" : {
          "href" : "//v1/applications/970/presenceSubscriptionMemberships"
        },
        "presenceSubscriptions" : {
          "href" : "//v1/applications/970/presenceSubscriptions"
        },
        "search" : {
          "href" : "//v1/applications/970/search"
        },
        "subscribedContacts" : {
          "href" : "//v1/applications/970/subscribedContacts"
        }
      }
    }
  }
}
  

Request

Get https://fe1.contoso.com:443//v1/applications/970 HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Accept: application/xml
if-none-match: b16736fb-c348-4e92-95db-f9434dc2abe1

  

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
Etag: 465bf339-07c0-425d-bedc-95718fc82cd4
Content-Type: application/xml
Content-Length: 4371
<?xml version="1.0" encoding="utf-8"?>
<resource rel="application" href="//v1/applications/970" xmlns="http://schemas.microsoft.com/rtc/2012/03/ucwa">
  <link rel="batch" href="//v1/applications/970/batch" />
  <link rel="events" href="http://sample/ucwa/v1/applications/appId/events" />
  <link rel="policies" href="//v1/applications/970/policies" />
  <property name="rel">application</property>
  <property name="culture">en-us</property>
  <property name="endpointId">samplevalue</property>
  <property name="instanceId">samplevalue</property>
  <property name="userAgent">ContosoApp/1.0</property>
  <resource rel="communication" href="//v1/applications/970/communication">
    <link rel="conversationLogs" href="//v1/applications/970/communication/conversationLogs" />
    <link rel="conversations" href="//v1/applications/970/communication/conversations" />
    <link rel="joinOnlineMeeting" href="//v1/applications/970/communication/joinOnlineMeeting" />
    <link rel="missedItems" href="//v1/applications/970/communication/missedItems" />
    <link rel="startMessaging" href="//v1/applications/970/communication/startMessaging" />
    <link rel="startOnlineMeeting" href="//v1/applications/970/communication/startOnlineMeeting" />
    <link rel="startPhoneAudio" href="//v1/applications/970/communication/startPhoneAudio" />
    <property name="simultaneousRingNumberMatch">Disabled</property>
    <property name="rel">communication</property>
    <property name="conversationHistory">Disabled</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="//v1/applications/970/me">
    <link rel="callForwardingSettings" href="//v1/applications/970/me/callForwardingSettings" />
    <link rel="location" href="//v1/applications/970/me/location" />
    <link rel="makeMeAvailable" href="//v1/applications/970/communication/makeMeAvailable" />
    <link rel="note" href="//v1/applications/970/me/note" />
    <link rel="phones" href="//v1/applications/970/me/phones" />
    <link rel="photo" href="//v1/applications/970/photo" />
    <link rel="presence" href="//v1/applications/970/me/presence" />
    <link rel="reportMyActivity" href="//v1/applications/970/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="//v1/applications/970/onlineMeetings">
    <link rel="myAssignedOnlineMeeting" href="//v1/applications/970/onlineMeetings/myOnlineMeetings/817" />
    <link rel="myOnlineMeetings" href="//v1/applications/970/onlineMeetings/myOnlineMeetings" />
    <link rel="onlineMeetingDefaultValues" href="//v1/applications/970/onlineMeetings/onlineMeetingDefaultValues" />
    <link rel="onlineMeetingEligibleValues" href="//v1/applications/970/onlineMeetings/onlineMeetingEligibleValues" />
    <link rel="onlineMeetingInvitationCustomization" href="//v1/applications/970/onlineMeetings/onlineMeetingInvitationCustomization" />
    <link rel="onlineMeetingPolicies" href="//v1/applications/970/onlineMeetings/onlineMeetingPolicies" />
    <link rel="phoneDialInInformation" href="//v1/applications/970/onlineMeetings/phoneDialInInformation" />
    <property name="rel">onlineMeetings</property>
  </resource>
  <resource rel="people" href="//v1/applications/970/people">
    <link rel="myContactsAndGroupsSubscription" href="//v1/applications/970/people/myContactsAndGroupsSubscription" />
    <link rel="myContacts" href="//v1/applications/970/contacts" />
    <link rel="myGroupMemberships" href="//v1/applications/970/myGroupMemberships" />
    <link rel="myGroups" href="//v1/applications/970/groups" />
    <link rel="myPrivacyRelationships" href="//v1/applications/970/myPrivacyRelationships" />
    <link rel="presenceSubscriptionMemberships" href="//v1/applications/970/presenceSubscriptionMemberships" />
    <link rel="presenceSubscriptions" href="//v1/applications/970/presenceSubscriptions" />
    <link rel="search" href="//v1/applications/970/search" />
    <link rel="subscribedContacts" href="//v1/applications/970/subscribedContacts" />
    <property name="rel">people</property>
  </resource>
</resource>
  

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

Request

Delete https://fe1.contoso.com:443//v1/applications/970 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

  

Request

Delete https://fe1.contoso.com:443//v1/applications/970 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