GetSalesPersons
Gets a list of sales employees.
Request Information
Parameters
SalesPersonSearchCriteria
| Name | Description | Type | Additional information |
|---|
| Types |
|
Collection of SalesPersonType
|
|
| Status |
|
EmployeeStatusScope
|
|
| StoreIds |
|
Collection of integer
|
Required
|
| MaxElapsedSinceUpdate |
Filter records that have been created or modified between the difference of now and this
PullRepairOrders Notice:
The length of time allowed is limited to 32 days.
|
time interval
|
|
| ChangedPeriodStart |
Filter records that have been created or modified starting with this
Note:
ChangedPeriodStart is not used by PullRepairOrders
|
date
|
|
| ChangedPeriodEnd |
Filter records that have been created or modified ending with this
Note:
ChangedPeriodEnd is not used by PullRepairOrders
|
date
|
|
| SuppressErrors |
If an error occurs in a multi-dealer pull, continue pulling from other dealers instead of failing the
whole request.
|
boolean
|
|
Sample Request
<SalesPersonSearchCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.BaseApi">
<ChangedPeriodEnd>2025-07-03T13:01:56.3662307Z</ChangedPeriodEnd>
<ChangedPeriodStart>2025-07-03T13:01:56.3662307Z</ChangedPeriodStart>
<MaxElapsedSinceUpdate>PT0.1234567S</MaxElapsedSinceUpdate>
<SuppressErrors>true</SuppressErrors>
<StoreIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:long>1</d2p1:long>
<d2p1:long>2</d2p1:long>
</StoreIds>
<Status>All</Status>
<Types>
<SalesPersonType>Salesman</SalesPersonType>
<SalesPersonType>Salesman</SalesPersonType>
</Types>
</SalesPersonSearchCriteria>
Response Information
Resource Description
Collection of
StorePersons
| Name | Description | Type | Additional information |
|---|
| Persons |
|
Collection of SalesPerson
|
|
| Placement |
|
StorePlacement
|
|
Sample Response
<ArrayOfStorePersons xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.BaseApi">
<StorePersons>
<Placement>
<GroupId>8</GroupId>
<GroupName>sample string 9</GroupName>
<EnvironmentId>7</EnvironmentId>
<EnvironmentType>Undefined</EnvironmentType>
<DealerId>6</DealerId>
<SourceId>5</SourceId>
<CompanyId>3</CompanyId>
<CompanyName>sample string 4</CompanyName>
<StoreId>1</StoreId>
<StoreName>sample string 2</StoreName>
</Placement>
<Persons>
<SalesPerson>
<EventDescription xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">sample string 9</EventDescription>
<EventID xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">sample string 8</EventID>
<EventOccurrenceDateTime xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">2025-07-03T13:01:56.3662307Z</EventOccurrenceDateTime>
<FactoryID xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">sample string 5</FactoryID>
<IsActive xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">true</IsActive>
<Number xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">sample string 1</Number>
<OtherId xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">sample string 6</OtherId>
<PersonalName xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">
<FirstName>sample string 1</FirstName>
<LastName>sample string 2</LastName>
<MiddleName>sample string 3</MiddleName>
<SingularName>sample string 4</SingularName>
<Suffix>sample string 5</Suffix>
<Title>None</Title>
</PersonalName>
<SpecialRemarksDescription xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">sample string 7</SpecialRemarksDescription>
<Ssn xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">sample string 3</Ssn>
<StreetAddress xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">
<City>sample string 3</City>
<Country>sample string 7</Country>
<County>sample string 6</County>
<Line1>sample string 1</Line1>
<Line2>sample string 2</Line2>
<State>sample string 4</State>
<Zip>sample string 5</Zip>
</StreetAddress>
<Username xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">sample string 2</Username>
<Type>Salesman</Type>
</SalesPerson>
<SalesPerson>
<EventDescription xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">sample string 9</EventDescription>
<EventID xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">sample string 8</EventID>
<EventOccurrenceDateTime xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">2025-07-03T13:01:56.3662307Z</EventOccurrenceDateTime>
<FactoryID xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">sample string 5</FactoryID>
<IsActive xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">true</IsActive>
<Number xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">sample string 1</Number>
<OtherId xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">sample string 6</OtherId>
<PersonalName xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">
<FirstName>sample string 1</FirstName>
<LastName>sample string 2</LastName>
<MiddleName>sample string 3</MiddleName>
<SingularName>sample string 4</SingularName>
<Suffix>sample string 5</Suffix>
<Title>None</Title>
</PersonalName>
<SpecialRemarksDescription xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">sample string 7</SpecialRemarksDescription>
<Ssn xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">sample string 3</Ssn>
<StreetAddress xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">
<City>sample string 3</City>
<Country>sample string 7</Country>
<County>sample string 6</County>
<Line1>sample string 1</Line1>
<Line2>sample string 2</Line2>
<State>sample string 4</State>
<Zip>sample string 5</Zip>
</StreetAddress>
<Username xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">sample string 2</Username>
<Type>Salesman</Type>
</SalesPerson>
</Persons>
</StorePersons>
<StorePersons>
<Placement>
<GroupId>8</GroupId>
<GroupName>sample string 9</GroupName>
<EnvironmentId>7</EnvironmentId>
<EnvironmentType>Undefined</EnvironmentType>
<DealerId>6</DealerId>
<SourceId>5</SourceId>
<CompanyId>3</CompanyId>
<CompanyName>sample string 4</CompanyName>
<StoreId>1</StoreId>
<StoreName>sample string 2</StoreName>
</Placement>
<Persons>
<SalesPerson>
<EventDescription xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">sample string 9</EventDescription>
<EventID xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">sample string 8</EventID>
<EventOccurrenceDateTime xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">2025-07-03T13:01:56.3662307Z</EventOccurrenceDateTime>
<FactoryID xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">sample string 5</FactoryID>
<IsActive xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">true</IsActive>
<Number xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">sample string 1</Number>
<OtherId xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">sample string 6</OtherId>
<PersonalName xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">
<FirstName>sample string 1</FirstName>
<LastName>sample string 2</LastName>
<MiddleName>sample string 3</MiddleName>
<SingularName>sample string 4</SingularName>
<Suffix>sample string 5</Suffix>
<Title>None</Title>
</PersonalName>
<SpecialRemarksDescription xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">sample string 7</SpecialRemarksDescription>
<Ssn xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">sample string 3</Ssn>
<StreetAddress xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">
<City>sample string 3</City>
<Country>sample string 7</Country>
<County>sample string 6</County>
<Line1>sample string 1</Line1>
<Line2>sample string 2</Line2>
<State>sample string 4</State>
<Zip>sample string 5</Zip>
</StreetAddress>
<Username xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">sample string 2</Username>
<Type>Salesman</Type>
</SalesPerson>
<SalesPerson>
<EventDescription xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">sample string 9</EventDescription>
<EventID xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">sample string 8</EventID>
<EventOccurrenceDateTime xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">2025-07-03T13:01:56.3662307Z</EventOccurrenceDateTime>
<FactoryID xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">sample string 5</FactoryID>
<IsActive xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">true</IsActive>
<Number xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">sample string 1</Number>
<OtherId xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">sample string 6</OtherId>
<PersonalName xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">
<FirstName>sample string 1</FirstName>
<LastName>sample string 2</LastName>
<MiddleName>sample string 3</MiddleName>
<SingularName>sample string 4</SingularName>
<Suffix>sample string 5</Suffix>
<Title>None</Title>
</PersonalName>
<SpecialRemarksDescription xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">sample string 7</SpecialRemarksDescription>
<Ssn xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">sample string 3</Ssn>
<StreetAddress xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">
<City>sample string 3</City>
<Country>sample string 7</Country>
<County>sample string 6</County>
<Line1>sample string 1</Line1>
<Line2>sample string 2</Line2>
<State>sample string 4</State>
<Zip>sample string 5</Zip>
</StreetAddress>
<Username xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">sample string 2</Username>
<Type>Salesman</Type>
</SalesPerson>
</Persons>
</StorePersons>
</ArrayOfStorePersons>