GetSalesRep

Description

The GetSalesRep method retrieves a SalesRep object from the EBizCharge platform.

Syntax

SalesRep GetSalesRep(SecurityToken securityToken, string salesRepId, string salesRepInternalId)

Arguments

Type

Name

Req.

Description

SecurityToken

securityToken

R

A unique token that is used to identify a merchant and authenticate the API request.

string

salesRepID

D

Custom ID of the requested SalesRep object.

Note: Required if the salesRepInternalId is not sent.

string

salesRepInternalId

D

Internal ID of the requested SalesRep object.

Note: Required if the salesRepID is not sent.

Return Value

TypeDescription
SalesRepOn success, returns the requested SalesRep object. Otherwise, a fault is returned.

Example Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ebiz="http://eBizCharge.ServiceModel.SOAP">
   <soapenv:Header/>
   <soapenv:Body>
      <ebiz:GetSalesRep>
         <ebiz:securityToken>
            <ebiz:SecurityId>********-23f6-4466-a993-************</ebiz:SecurityId>
            <ebiz:UserId/>
            <ebiz:Password/>
         </ebiz:securityToken>
         <ebiz:salesRepId>Sr-0002</ebiz:salesRepId>
         <ebiz:salesRepInternalId>********-23f6-4466-a993-************</ebiz:salesRepInternalId>
      </ebiz:GetSalesRep>
   </soapenv:Body>
</soapenv:Envelope>
public static void GetSalesRep()
{
  //Create EBizCharge SOAP client
  IeBizService apiClient = new IeBizServiceClient();

  //Set up merchant authentication
  SecurityToken securityToken = new SecurityToken
    {
      SecurityId = "********-23f6-4466-a993-************",
      UserId = "",
      Password = ""
      };

  try
    {
      //Provide identifiers
      string salesRepId = "Sr-0002";
      string salesRepInternalId = "";
      SalesRep salesRep = apiClient.GetSalesRep(securityToken, salesRepId, salesRepInternalId);

      //Display SalesRep details
      Console.WriteLine($"Sales Rep Internal ID: {salesRep.SalesRepInternalId}");
      Console.WriteLine($"Sales Rep ID:          {salesRep.SalesRepId}");
      Console.WriteLine($"Type:                  {salesRep.SalesRepType}");
      Console.WriteLine($"First Name:            {salesRep.FirstName}");
      Console.WriteLine($"Last Name:             {salesRep.LastName}");
      Console.WriteLine($"Company Name:          {salesRep.CompanyName}");
      Console.WriteLine($"Phone:                 {salesRep.Phone}");
      Console.WriteLine($"Cell Phone:            {salesRep.CellPhone}");
      Console.WriteLine($"Fax:                   {salesRep.Fax}");
      Console.WriteLine($"Email:                 {salesRep.Email}");
      Console.WriteLine($"Website:               {salesRep.WebSite}");
      Console.WriteLine($"Account Number:        {salesRep.AccountNumber}");
      Console.WriteLine($"Is Inactive:           {salesRep.IsInactive}");
    }
  catch (Exception ex) 
    {
      //There doesn't exist a Sales Rep with that specific salesRepId/salesRepInternalId OR possible issues with the security token provided
      Console.WriteLine(ex.ToString());
    }
}
function getSalesRep()
{
  $client = new SoapClient("End point URL");
  // Define the merchant security token
  $securityToken = array(
    'SecurityId' => '******-454757-4567457-********', 
    'UserId' => 'merchant1', 
    'Password' => 'merchant1' 
  );

  // Prepare parameters for the GetSalesRep call
  $params = array(
    'securityToken' => $securityToken,
    'salesRepId' => 'SR1001',
    'salesRepInternalId' => ''
  );

  try {
    // Make the SOAP request
    $response = $client->GetSalesRep($params);

    // Extract result object from response
    $result = $response->GetSalesRepResult;

    // Display the response
    echo "<pre>";
    print_r($result);
    echo "</pre>";

  } catch (SoapFault $e) {
    // Handle any SOAP errors
    echo "SOAP Error: " . $e->getMessage();
  }
}

Example Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <GetSalesRepResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <GetSalesRepResult>
            <SalesRepInternalId>********-*******-********-68678687</SalesRepInternalId>
            <SalesRepId>Sr-0002</SalesRepId>
            <SalesRepType>Sales</SalesRepType>
            <LinkedToInternalId/>
            <FirstName>Tim</FirstName>
            <LastName>Litton</LastName>
            <CompanyName>A.Datum</CompanyName>
            <Phone>123-456-7890</Phone>
            <CellPhone>123-456-7890</CellPhone>
            <Fax/>
            <Email>[email protected]</Email>
            <WebSite/>
            <Address>
               <Address1>123 Sesame Street</Address1>
               <Address2/>
               <Address3/>
               <City>Irvine</City>
               <State>CA</State>
               <ZipCode>92644</ZipCode>
               <IsDefault>true</IsDefault>
            </Address>
            <AccountNumber>000027</AccountNumber>
            <IsInactive>false</IsInactive>
         </GetSalesRepResult>
      </GetSalesRepResponse>
   </s:Body>
</s:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <s:Fault>
         <faultcode>s:NotFound</faultcode>
         <faultstring xml:lang="en-US">Not Found</faultstring>
      </s:Fault>
   </s:Body>
</s:Envelope>