🤳GET - Call Pickup Group User

my_api.get.call_pickup_group_user()

Retrieves Pickup Group information for the specified user.

Parameters

• service_provider_id (str): Target Service Provider ID

• group_id (str): The Target Group ID the user is apart of.

• user_id (str): Target User ID

Returns

• Dict: Specified users pickup group, and the users within that group.

How To Use:

from odins_spear import api

my_api= api.Api(base_url="https://base_url/api/vx", username="john.smith", password="ODIN_INSTANCE_1")
my_api.authenticate()

my_api.put.call_pickup_group_user(
    "my_service_provider_id", 
    "my_group_id", 
    "[e-mail]"
)

Example Data Returned (Formatted)

{
  "serviceProviderId": "my_service_provider_id",
  "groupId": "my_group_id",
  "name": "Call Pickup 1",
  "users":  [
        {
        "userId": "[e-mail]", 
        "lastName": "Smith", 
        "firstName": "John", 
        "hiraganaLastName": "Smith", 
        "hiraganaFirstName": "John", 
        "phoneNumber": "[phone]", 
        "extension": "1234", 
        "department": None, 
        "emailAddress": None
        }, 
        {
        "userId": "[e-mail]", 
        "lastName": "Smith", 
        "firstName": "Jane", 
        "hiraganaLastName": "Smith", 
        "hiraganaFirstName": "jane", 
        "phoneNumber": "[phone]", 
        "extension": "4321", 
        "department": None, 
        "emailAddress": None
        }
    ]
}