Skip to main content

Get DealerAssociate Groups for filters​


ApiScope: manage.dealerassociate.group
API Scope Level: DepartmentScope
Path Parameters
    ServiceSubscriberDepartment string required
Query Parameters
    includeInvalid boolean
Request Body required
    dealerAssociateUuidList DA UUIDs for which you want to filter the DA Groups returned. Only DA Groups having these DA as members will be returned. When nothing is passed this filter will not be appllied[]
    daGroupPurposeTypeKeys DA GROUP Purpose Type Keys for which you want to filter the DA Groups returned. Only DA Groups belonging to this category will be returrned. When nothing is passed this filter will not be appllied[]
    dealerAssociateGroupUuids DA GROUP UUIDs for which you want to filter the DA Groups returned. When nothing is passed this filter will not be appllied[]
Responses

OK

Schema
    errors object[]
  • Array [
    • errorCode int32
    errorTitle string
    errorMessage string
  • ]
    • warnings object[]
  • Array [
    • warningCode int32
    warningTitle string
    warningMessage string
  • ]
    • apiRequestId string
    dealerAssociateGroups object[]
  • Array [
    • name string
    uuid string
    virtualDealerAssociateUuid string
    virtualDealerAssociateIdentifier object
    userUUID string
    departmentUUID string
    dealerAssociateUuids string[] deprecated
    dealerAssociateIdentifiers object[]
  • Array [
    • userUUID string
    departmentUUID string
  • ]
    • groupPhoneNumber string
    valid boolean
    defaultCommunicationDealerAssociateGroup boolean
    defaultDealerAssociateUuid string
    defaultDealerAssociateIdentifier object
    userUUID string
    departmentUUID string
    purposesList object[]
  • Array [
    • key The key which is a unique identifier for a group purpose type. Can only contain lowercase characters and "-","_"
    name The name for the group purpose type
    authorities object[]
  • Array [
    • authority string
    description string
  • ]
    • uuid string
  • ]
    • dealerAssociateGroupAuthorities object[]
  • Array [
    • authority string
    description string
  • ]
    • virtualDealerAssociateUserUuid string
    enableGroupThreadOwnership boolean
  • ]
POST /v2/department/:ServiceSubscriberDepartment/dealerAssociate/dealerAssociateGroup/list

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL
/manage
Username
Password
ServiceSubscriberDepartment — path required
includeInvalid — query
Body required
{

  "dealerAssociateUuidList": [

    "string"

  ],

  "daGroupPurposeTypeKeys": [

    "string"

  ],

  "dealerAssociateGroupUuids": [

    "string"

  ]

}
Accept
curl / cURL
curl -L -X POST '/manage/v2/department/:ServiceSubscriberDepartment/dealerAssociate/dealerAssociateGroup/list' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerAssociateUuidList": [
    "string"
  ],
  "daGroupPurposeTypeKeys": [
    "string"
  ],
  "dealerAssociateGroupUuids": [
    "string"
  ]
}'