GET user/…/third-party-id/…

Retrieves a third-party ID of a user account.

Users are always permitted to retrieve the details of their own user account. Retrieving the details of another user account is only permitted if the calling user is an administrator (staff user) of the same organization that manages the requested user account.

Resource URL

https://www.drillster.com/api/2.1.1/user/{user_id}/third-party-id/{third_party_id}

or

https://www.drillster.com/api/2.1.1/user/{user_id}/third-party-id/{third_party}/{id}

Response

A 2.1.1 ThirdPartyId object.

Parameters

Field Description
user_id
required		 The user ID of the user. The following types can be used:

  • The account ID
  • self for the user performing the request
  • An email address registered for the user
  • A third-party ID registered for the user, using $ as separator. The value must be URL-encoded: <third-party>%24<ID>
third_party_id
required		 The third-party ID to remove, using $ as separator. The value must be URL-encoded: <third-party>%24<ID>.

Example value: ACME%241234
third_party
required		 The third-party of the third-party ID to remove.

Example value: ACME
id
required		 The ID of the third-party ID to remove.

Example value: 1234

Example request

GET https://www.drillster.com/api/2.1.1/user/self/third-party-id/ACME%242058392

Response

{
  "thirdParty": "ACME",
  "id": "2058392"
}

Error responses

The following error situations are possible:

ID Response code Description
nonexistent_user 404 (Not found) Requested user not found
no_access 403 (Forbidden) Caller does not have access to requested user
multiple_accounts 400 (Bad request) The e-mail address is used by multiple accounts
invalid_third_party_id 400 (Bad request) The provided third party ID is invalid
unknown_third_party_id 404 (Not found) The requested third party ID is not found

 

Last updated on