Provider Numbers

The Provider Numbers Changed Subscription feature will allow the user to retrieve changed provider numbers for a specific practice. The user will need to initiate subscriptions. For more information about subscriptions, please refer Changed Data Subscriptions

Was this information helpful? Yes | No What went wrong? Incomplete or incorrect information | Irrelevant Content | Others

Endpoints

Get list of change events for provider numbers
GET
/v1/{practiceid}/providernumbers/changed/subscription/events

Retrieves a list of events for changed providers

Was this information helpful? Yes | No What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid

Output Parameters

Expand all
status string Will return one of following statuses: ACTIVE, INACTIVE, or PARTIAL. The PARTIAL status means that not all events are subscribed to. In the event of a problem, UNKNOWN may be returned.
subscriptions array List of events you are subscribed to.
Example Code
Subscribe to all/specific change events for provider numbers
POST
/v1/{practiceid}/providernumbers/changed/subscription

Subscribes for changed providernumbers events

Was this information helpful? Yes | No What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
Content-Type string Content type of the payload

❙ Request Body

Expand all
eventname string By default, you are subscribed to all possible events. If you only wish to subscribe to an individual event, pass the event name with this argument.

Output Parameters

Expand all
success string Returns if the call to manipulate subscriptions for providernumbers was successful.
Example Code
Get list of subscribed events for changes in provider numbers
GET
/v1/{practiceid}/providernumbers/changed/subscription

Retrieves list of events applicable for changed providernumbers

Was this information helpful? Yes | No What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid

Output Parameters

Expand all
status string Will return one of following statuses: ACTIVE, INACTIVE, or PARTIAL. The PARTIAL status means that not all events are subscribed to. In the event of a problem, UNKNOWN may be returned.
subscriptions array List of events you are subscribed to.
Example Code
Unsubscribe to all/specific events for changes in provider numbers
DELETE
/v1/{practiceid}/providernumbers/changed/subscription

Deletes a specific event which is no longer required

Was this information helpful? Yes | No What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
eventname string By default, you are unsubscribed from all possible events. If you only wish to unsubscribe from an individual event, pass the event name with this argument.

Output Parameters

Expand all
success string Returns if the call to manipulate subscriptions for providernumbers was successful.
Example Code