Export (0) Print
Expand All

SearchUserInvitations Service Operation

Searches for user invitations that match a specified criteria.

Request | Response

Error Codes

Service: CustomerManagementService.svc v9 | Namespace: https://bingads.microsoft.com/Customer/v9

SearchUserInvitationsRequest Message

The SearchUserInvitationsRequest object defines the elements of the request’s body. The elements must be in the same order as shown in the SOAP example.

Request Body

Element

Description

Data Type

Required

Predicates

Determines the request conditions. This operation's response will include user invitations that match all of the specified predicates.

System_CLiX_note Note

You may specify only one predicate.

For this service operation, the following are supported Field and Operator elements of a Predicate object.

Field

Operator

Description

CustomerId

Equals

Use this field to search the CustomerId element of the UserInvitation object.

Predicate array

Yes

Request Header

For information about the values you set the DeveloperToken, Password, and UserName elements to, see Getting Started With the Bing Ads API.

Element

Description

Data Type

ApplicationToken

The application-access token. This header element is not used and should be null.

string

AuthenticationToken

The OAuth access token used to manage Bing Ads accounts linked to a Microsoft Account. For more information, see Managing User Authentication with OAuth.

string

DeveloperToken

The client application's developer access token.

string

Password

The Bing Ads user's sign-in password.

string

UserName

The Bing Ads user's sign-in user name. You may not set this element to a Microsoft account.

string

Request SOAP

The following example shows the complete request envelope.

<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/Customer/v9">
    <Action mustUnderstand="1">SearchUserInvitations</Action>
    <ApplicationToken i:nil="false"></ApplicationToken>
    <AuthenticationToken i:nil="false"></AuthenticationToken>
    <DeveloperToken i:nil="false"></DeveloperToken>
    <Password i:nil="false"></Password>
    <UserName i:nil="false"></UserName>
  </s:Header>
  <s:Body>
    <SearchUserInvitationsRequest xmlns="https://bingads.microsoft.com/Customer/v9">
      <Predicates xmlns:e39="https://bingads.microsoft.com/Customer/v9/Entities" i:nil="false">
        <e39:Predicate>
          <e39:Field i:nil="false"></e39:Field>
          <e39:Operator></e39:Operator>
          <e39:Value i:nil="false"></e39:Value>
        </e39:Predicate>
      </Predicates>
    </SearchUserInvitationsRequest>
  </s:Body>
</s:Envelope>

SearchUserInvitationsResponse Message

Response Body

Element

Description

Data Type

UserInvitations

A list of user invitations that meet the specified criteria.

UserInvitation array

Response Header

Element

Description

Data Type

TrackingId

The identifier of the log entry that contains the details of the API call.

string

Response SOAP

The following example shows the complete response envelope.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/Customer/v9">
    <TrackingId p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance"></TrackingId>
  </s:Header>
  <s:Body>
    <SearchUserInvitationsResponse xmlns="https://bingads.microsoft.com/Customer/v9">
      <UserInvitations xmlns:e40="https://bingads.microsoft.com/Customer/v9/Entities" p5:nil="false" xmlns:p5="http://www.w3.org/2001/XMLSchema-instance">
        <e40:UserInvitation>
          <e40:Id></e40:Id>
          <e40:FirstName p5:nil="false"></e40:FirstName>
          <e40:LastName p5:nil="false"></e40:LastName>
          <e40:Email p5:nil="false"></e40:Email>
          <e40:CustomerId></e40:CustomerId>
          <e40:Role></e40:Role>
          <e40:AccountIds p5:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <a1:long></a1:long>
          </e40:AccountIds>
          <e40:ExpirationDate></e40:ExpirationDate>
          <e40:Lcid></e40:Lcid>
        </e40:UserInvitation>
      </UserInvitations>
    </SearchUserInvitationsResponse>
  </s:Body>
</s:Envelope>

Error Codes

If the service operation fails, it throws a FaultException exception, which contains one or more of the Bing Ads API error data objects. For information about the fault detail objects, see Customer Management Error Data Objects and Handling Service Errors and Exceptions.

The following are example error codes that the error objects can include when using this service operation. For all documented error codes, please see Bing Ads Operation Error Codes.

Error Code

InvalidCredentials

Community Additions

ADD
Show:
© 2015 Microsoft