Csr

Get customer service record from a provider.

get/v1/Provider/csr

Request

Query parameters

csr.profile_idinteger required

Identifier of the provider profile used to lookup a customer service record.

csr.phone_numberstring required

Phone number that will be used for customer service record inquiry.

csr.provider_account_idinteger

Provider account identifier used to further identify how to lookup the customer service record.

csr.provider_recordboolean

Indicates if the customer service record should pull all records of the provider and not just your records (not supported by all providers).

Response

OK

customer_numberstring

Primary number of the customer in the provider's system.

namestring

Name of the customer in the provider's system.

class'Business' | 'Residential'

Class of the customer in the provider's system.

customer_codestring

Secondary customer identifier used in the provider's system.

is_activeboolean

Indicates whether the customer is active in the provider's system.

deny_datestring date-time

The most recent date that the customer's service was denied/suspended in the provider's system.

company_codestring

Primary identifier of the account where the customer is provisioned in the provider's system.

reseller_idstring

Secondary identifier of the account where the customer is provisioned in the provider's system.

sic_codestring

SIC (Standard Industry Classification) code of the customer in the provider's system.

yellow_pagestring

Yellow page heading of the customer in the provider's system.

Changes

    • breaking

      removed the media type application/json for the response with the status

    • breaking

      removed the media type text/html for the response with the status

    • breaking

      removed the media type text/json for the response with the status

    • warning

      added the new ANT enum value to the / response property for the response status (media type: application/json)

    • warning

      added the new ANT enum value to the / response property for the response status (media type: text/json)

    • warning

      added the new ANT enum value to the / response property for the response status (media type: text/html)

    • warning

      added the new ANT enum value to the / response property for the response status (media type: application/json)

    • warning

      added the new ANT enum value to the / response property for the response status (media type: text/json)

    • warning

      added the new ANT enum value to the / response property for the response status (media type: text/html)

    • warning

      added the new ANT enum value to the /// response property for the response status (media type: application/json)

    • warning

      added the new ANT enum value to the /// response property for the response status (media type: text/json)

    • warning

      added the new ANT enum value to the /// response property for the response status (media type: text/html)

    • warning

      added the new SCG enum value to the / response property for the response status (media type: application/json)

    • warning

      added the new SCG enum value to the / response property for the response status (media type: text/json)

    • warning

      added the new SCG enum value to the / response property for the response status (media type: text/html)

    • warning

      added the new SCG enum value to the / response property for the response status (media type: application/json)

    • warning

      added the new SCG enum value to the / response property for the response status (media type: text/json)

    • warning

      added the new SCG enum value to the / response property for the response status (media type: text/html)

    • warning

      added the new SCG enum value to the /// response property for the response status (media type: application/json)

    • warning

      added the new SCG enum value to the /// response property for the response status (media type: text/json)

    • warning

      added the new SCG enum value to the /// response property for the response status (media type: text/html)

    • warning

      added the new YUG enum value to the / response property for the response status (media type: application/json)

    • warning

      added the new YUG enum value to the / response property for the response status (media type: text/json)

    • warning

      added the new YUG enum value to the / response property for the response status (media type: text/html)

    • warning

      added the new YUG enum value to the / response property for the response status (media type: application/json)

    • warning

      added the new YUG enum value to the / response property for the response status (media type: text/json)

    • warning

      added the new YUG enum value to the / response property for the response status (media type: text/html)

    • warning

      added the new YUG enum value to the /// response property for the response status (media type: application/json)

    • warning

      added the new YUG enum value to the /// response property for the response status (media type: text/json)

    • warning

      added the new YUG enum value to the /// response property for the response status (media type: text/html)

    • info

      api operation id GETv1_Provider_csr-profile_id-profile_id-phone_number-phone_number-provider_ removed and replaced with GETv1_Provider_csr?profile_id=profile_id&phone_number=phone_number&provider_account_id=provider_account_id&provider_record=provider_record