onBehalfOf

Article
04/19/2022

Applies to: Skype for Business 2015

Represents the contact on whose behalf the invitation was received.

Web Link

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.

Resource description

This resource is usually present in an incoming invitation when a delegate makes a call on the behalf of someone else.

Properties

Name	Description
company	The name of the contact's company.
department	The name of the contact's department.
emailAddresses	The contact's e-mail addresses.
homePhoneNumber	The contact's home phone number.
sourceNetworkIconUrl	The web URI of the icon representing the contact's source network.
mobilePhoneNumber	The contact's mobile phone number.
name	The contact's name.
office	The contact's office number.
otherPhoneNumber	The contact's other phone number.
sourceNetwork	The contact's source network (SourceNetwork), such as SameEnterprise or PublicCloud (such as a Skype contact).
title	The contact's title.
type	The contact's type (ContactType), such as User, Phone, or Bot.
uri	The contact's URI.
workPhoneNumber	The contact's work phone number.

Links

This resource can have the following relationships.

Link	Description
self	The link to the current resource.
contactLocation	Represents a contact's location.
contactNote	Represents a contact's personal or out-of-office note.
contactPhoto	The photo of a contact.
contactPresence	Represents a contact's availability and activity.
contactPrivacyRelationship	Represents the privacy relationship between the user and a contact.
contactSupportedModalities	Represents the communication modalities supported by a contact.

Azure Active Directory scopes for online applications

The user must have at least one of these scopes for operations on the resource to be allowed.

Scope	Permission	Description
Contacts.ReadWrite	Read/write Skype user contacts and groups	Allows the app to read and write Skype user contacts and groups

Operations

GET

Returns a representation of the contact on behalf of whom the invitation was received.

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
Forbidden	403	None	Returned when an application does not have permission to view this contact's information.
Forbidden	403	None	The user does not have sufficient privileges to access the contact list.
Forbidden	403	None	The user does not have sufficient privileges to access pending contacts
ServiceFailure	500	InvalidExchangeServerVersion	Invalid exchange server version.The exchange mailbox of the server might have moved to an unsupported version for the required feature.
Conflict	409	AlreadyExists	The already exists error.
Conflict	409	TooManyGroups	The too many groups error.
Conflict	409	None	Un-supported Service/Resource/API error.
Gone	410	CannotRedirect	Cannot redirect since there is no back up pool configured.

Examples

JSON Request

Get https://fe1.contoso.com:443/ucwa/v1/applications/192/people/444 HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Accept: application/json
if-none-match: 8da8650f-392b-4cbc-9395-4ce777e82ed8

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: 801b4380-cf7a-4fad-97a5-f0181285d65c
Content-Type: application/json
Content-Length: 1109
{
  "rel" : "onBehalfOf",
  "company" : "Contoso Corp.",
  "department" : "Engineering",
  "emailAddresses" : [
    "Alex.Doe@contoso.com"
  ],
  "homePhoneNumber" : "tel:+19185550107",
  "sourceNetworkIconUrl" : "https://images.contoso.com/logo_16x16.png",
  "mobilePhoneNumber" : "tel:4255551212;phone-context=defaultprofile",
  "name" : "Alex Doe",
  "office" : "tel:+1425554321;ext=54321",
  "otherPhoneNumber" : "tel:+19195558194",
  "sourceNetwork" : "SameEnterprise",
  "title" : "Engineer 2",
  "type" : "User",
  "uri" : "sip:alex@contoso.com",
  "workPhoneNumber" : "tel:+1425554321;ext=54321",
  "_links" : {
    "self" : {
      "href" : "/ucwa/v1/applications/192/people/444"
    },
    "contactLocation" : {
      "href" : "/ucwa/v1/applications/192/people/282/contactLocation"
    },
    "contactNote" : {
      "href" : "/ucwa/v1/applications/192/people/282/contactNote"
    },
    "contactPhoto" : {
      "href" : "/ucwa/v1/applications/192/people/282/contactPhoto"
    },
    "contactPresence" : {
      "href" : "/ucwa/v1/applications/192/people/282/contactPresence"
    },
    "contactPrivacyRelationship" : {
      "href" : "/ucwa/v1/applications/192/people/282/contactPrivacyRelationship"
    },
    "contactSupportedModalities" : {
      "href" : "/ucwa/v1/applications/192/people/282/contactSupportedModalities"
    }
  }
}

XML Request

Get https://fe1.contoso.com:443/ucwa/v1/applications/192/people/444 HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Accept: application/xml
if-none-match: 88faf5d8-bb9a-46a1-ab86-93e804a06e15

XML Response