Версия API Graph

Business Role Request

Чтение

Represents a business user request. See the requests from an admin of the Business for people to join as member of this business.

Пример

Graph API Explorer
GET /v21.0/{business-role-request-id} HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->get(
    '/{business-role-request-id}',
    '{access-token}'
  );
} catch(Facebook\Exceptions\FacebookResponseException $e) {
  echo 'Graph returned an error: ' . $e->getMessage();
  exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
  echo 'Facebook SDK returned an error: ' . $e->getMessage();
  exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */
/* make the API call */
FB.api(
    "/{business-role-request-id}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{business-role-request-id}",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{business-role-request-id}"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];
Чтобы узнать, как использовать API Graph, ознакомьтесь с нашим руководством по API Graph.

Параметры

Эта конечная точка не содержит параметров.

Поля

ПолеОписание
id
numeric string

Business role invitation request ID.

created_by
BusinessUser|SystemUser

User who sent the invitation to join this business.

created_time
datetime

Admin sent this request to someone to join a business at this time.

email
string

Email of user invited to join the business.

expiration_time
datetime

Invitation to join business expires at this time.

finance_role
enum

When you invite someone to join business, pre-assign the Finance role.

invited_user_type
list<enum>

Invited user type of this role request

owner

Invite someone to join this business.

role
enum

Business role for user invited to the business.

status
enum

Status of the invitation, such as accepted, declined, expired and so on.

updated_by
BusinessUser|SystemUser

User who updated the invitation.

updated_time
datetime

Time invitation updated.

Error Codes

ОшибкаОписание
100Invalid parameter

Создание

Нельзя выполнить эту операцию в этой конечной точке.

Обновление

Чтобы обновить a BusinessRoleRequest, отправьте запрос POST на адрес /{business_role_request_id}.

Параметры

ПараметрОписание
role
enum {FINANCE_EDITOR, FINANCE_ANALYST, ADS_RIGHTS_REVIEWER, ADMIN, EMPLOYEE, DEVELOPER, PARTNER_CENTER_ADMIN, PARTNER_CENTER_ANALYST, PARTNER_CENTER_OPERATIONS, PARTNER_CENTER_MARKETING, PARTNER_CENTER_EDUCATION, MANAGE, DEFAULT, FINANCE_EDIT, FINANCE_VIEW}

Update invitation to include this role, such as ADMIN.

Тип возврата

Эта конечная точка поддерживает чтение после записи и будет считывать узел, в который вы сделали публикацию.
Struct {
id: numeric string,
}

Error Codes

ОшибкаОписание
100Invalid parameter
415Two factor authentication required. User have to enter a code from SMS or TOTP code generator to pass 2fac. This could happen when accessing a 2fac-protected asset like a page that is owned by a 2fac-protected business manager.
368The action attempted has been deemed abusive or is otherwise disallowed
190Invalid OAuth 2.0 Access Token

Удаление

You can delete a BusinessRoleRequest by making a DELETE request to /{business_role_request_id}.

Параметры

Эта конечная точка не содержит параметров.

Тип возврата

Struct {
success: bool,
}

Error Codes

ОшибкаОписание
200Permissions error
368The action attempted has been deemed abusive or is otherwise disallowed
415Two factor authentication required. User have to enter a code from SMS or TOTP code generator to pass 2fac. This could happen when accessing a 2fac-protected asset like a page that is owned by a 2fac-protected business manager.
100Invalid parameter
190Invalid OAuth 2.0 Access Token
457The session has an invalid origin