NAV

Authentication

Authentication calls enable you to gain access to your Network instance using the API. You make a POST call with a user name and password, and receive a session ID in response. You should pass the session ID as the value to the Authorization HTTP header for all subsequent API requests.

Authenticate

This API enables user authentication.

Sample response

{
    "responseStatus": "SUCCESS",
    "sessionId": "DC6DADC28D0BE0BE0420CE1BFA2E3616703A791130C87D9F940C05EDC9CB165FA63EDBD51C3B4DAE7771B48886275088",
    "userId": 2000001093,
    "networkId": "21017",
    "networkIds": [
        {
            "id": 21017,
            "name": "MyVeevaNetwork",
            "url": "https://my.veevanetwork.com/api"
        }
    ]
}

Compatibility

This API uses the POST HTTP method and is available in the following:

Syntax

https://<DNS>/api/<version>/auth

where:

Parameters

username (required): The user ID for Network, for example, john.smith@veevanetwork.com.

password (required): The password for the user ID.

Sample request

curl -X POST -d username=john.smith@veevasystems.com -d "password=12345" https://{dns}/api/v16.0/auth

Response

responseStatus: The status of the automatic response generated by Network on login.

sessionId: The session ID for subsequent API calls. This should be set with an Authorization header.

userId: The ID number for the authenticated user.

networkIds - The objects containing details about each Network that the authenticated user can access:

networkId: The Network ID number for the network that the authenticated user most recently accessed.

Associating custom keys

Associate custom key to children

This API enables you to submit external key identifiers when new children (address, license, or parent HCOs) are downloaded from Network without going through the full change request process.

Note: This API requires system administrator or API-only permissions.

Compatibility

This API uses the POST HTTP method and is available in the following:

Syntax

https://<DNS>/api/<version>/entities/<vid_key>/children/<children_key>/custom_keys

where:

Parameters

custom_key_source_type (required): The source of the new key.

custom_key_item_type (required): The item type for the new key.

custom_key_value (required): The value for the new key.

system_name (optional): The name of the system for the new key.

Sample request

POST https://my.veevanetwork.com/api/v16.0/entities/myveevanetwork:HCO:1325540/children/Network:ParentHCO:6044433/custome_keys?custom_key_source_type=VCRM&custom_key_item_type=ChildAccount&custom_key_value=789102&system_name=VCRM2

Response

Sample response

{
   "responseStatus": "SUCCESS"
}

responseStatus: The status of the response from Network.

Associate custom key to entity

This API enables you to submit external key identifiers when new HCPs or HCOs are downloaded from Network without going through the full change request process.

Note: This API requires system administrator or API-only permissions.

Compatibility

This API uses the POST HTTP method and is available in the following:

Syntax

https://<DNS>/api/<version>/entities/<vid_key>/custom_keys

where:

Parameters

custom_key_source_type (required): The source of the new key.

custom_key_item_type (required): The item type for the new key.

custom_key_value (required): The value for the new key.

system_name (optional): The name of the system for the new key.

Sample request

POST https://my.veevanetwork.com/api/v16.0/entities/Network:Entity:813873/custom_keys?custom_key_source_type=VCRM&custom_key_item_type=Account&custom_key_value=123456&system_name=VCRM6

Response

Sample response

{
   "responseStatus": "SUCCESS"
}

responseStatus: The status of the response from Network.

Batch associate custom key to children

Post data:

{
  "entities": [
    {
      "vid_key": "Network:Entity:291256782200767488",
      "child_type": "licenses",
      "child_key": "Network:License:291256858360939523",
      "custom_key_source_type": "VCRM",
      "custom_key_item_type": "LICENSE",
      "custom_key_value": "123456789",
      "system_name": "VCRM"
    },
    {
      "vid_key": "Network:Entity:291256748453397507",
      "child_type": "addresses",
      "child_key": "Network:Address:291256848747594752",
      "custom_key_source_type": "VCRM",
      "custom_key_item_type": "ADDRESS",
      "custom_key_value": "123123123123",
      "system_name": "VCRM"
    },
    {
      "vid_key": "Network:Entity:291256757999633408",
      "child_type": "parent_hcos",
      "child_key": "Network:ParentHCO:291256757999633600",
      "custom_key_source_type": "VCRM",
      "custom_key_item_type": "CHILDACCOUNT",
      "custom_key_value": "987654321",
      "system_name": "VCRM"
    }
  ]
}

This API enables you to submit external key identifiers when new children (address, license, or parent HCOs) are downloaded from Network without going through the full change request process.

Note: This API requires system administrator or API-only permissions.

Compatibility

This API uses the POST HTTP method and is available in the following:

Syntax

https://<DNS>/api/<version>/entities/children/custom_keys/associate/batch

where:

POST data

An array of entity objects:

vid_key (required): The external child (Address, License, or ParentHCO) vid_key.

child_type (required): The child type (Address, License, or ParentHCO). To select a child by vid_key alone, specify the general type (children).

child_key (required): The vid_key of the child object.

custom_key_source_type (required): The source of the new key.

custom_key_item_type (required): The item type for the new key.

custom_key_value (required): The value for the new key.

system_name (optional): The name of the system for the new key.

Sample request

POST https://my.network.com/api/v16.0/entities/children/custom_keys/associate/batch

Response

Sample response: Success

{
   "responseStatus": "SUCCESS"
}

Sample response: Partial success

{
  "responseStatus": "PARTIAL_SUCCESS",
  "errors": [
    {
      "type": "INVALID_DATA",
      "message": "No entity found with the given Id 291256782200767488"
    },
    {
      "type": "INVALID_DATA",
      "message": "No child object found with the given Id 291256757999633600"
    }
  ]
}

responseStatus: The status of the response from Network.

errors - An array of attribute information objects:

Batch associate custom keys to entities

Post data:

{
  "entities": [
    {
      "vid_key": "Network:Entity:291256782200767488",
      "custom_key_source_type": "VCRM",
      "custom_key_item_type": "ENTITY",
      "custom_key_value": "123123123123",
      "system_name": "VCRM"
    },
    {
      "vid_key": "Network:Entity:291256782200767400",
      "custom_key_source_type": "VCRM",
      "custom_key_item_type": "ENTITY",
      "custom_key_value": "123456789",
      "system_name": "VCRM"
    },
    {
      "vid_key": "Network:Entity:291256796914385922",
      "custom_key_source_type": "VCRM",
      "custom_key_item_type": "ENTITY",
      "custom_key_value": "987654321",
      "system_name": "VCRM"
    }
  ]
}

This API enables you to submit external key identifiers whenever new HCPs or HCOs are downloaded from Network without going through the full change request process.

Note: This API requires system administrator or API-only permissions.

Compatibility

This API uses the POST HTTP method and is available in the following:

Syntax

https://<DNS>/api/<version>/entities/custom_keys/associate/batch

where: * DNS is the URL for your API service * version is the API version

POST data

An array of entity objects:

vid_key (required): The external HCP or HCO vid_key.

custom_key_source_type (required): The source of the new key.

custom_key_item_type (required): The item type for the new key.

custom_key_value (required): The value for the new key.

system_name (optional): The name of the system for the new key.

Sample request

POST https://my.network.com/api/v16.0/entities/custom_keys/associate/batch

Response

Sample response: Success

{
   "responseStatus": "SUCCESS"
}

Sample response: Partial success

{
  "responseStatus": "PARTIAL_SUCCESS",
  "errors": [
    {
      "type": "INVALID_DATA",
      "message": "No entity found with the given Id 291256782200767400"
    }
  ]
}

responseStatus: The status of the response from Network.

errors - An array of attribute information objects:

Batch disassociate custom key

POST data:

{
  "entities": [
    {
      "vid_key": "VCRM:ENTITY:291256782200767500"
    },
    {
      "vid_key": "VCRM:LICENSE:123456789"
    },
    {
      "vid_key": "VCRM:ADDRESS:123123123123"
    }
  ]
}

This API enables you to inactivate external key identifiers for any entity (HCP, HCO, Address, License, or ParentHCO) in Network without going through the full change request process.

Note: This API requires system administrator or API-only permissions.

Compatibility

This API uses the POST HTTP method and is available in the following:

Syntax

https://<DNS>/api/<version>/custom_keys/disassociate/batch

where:

POST data

entities (required): The external HCP, HCO, Address, License, or ParentHCO vid_key supplied by the client

Sample request

POST https://my.network.com/api/v16.0/custom_keys/disassociate/batch

Response

Sample response: Success

{
   "responseStatus": "SUCCESS"
}

Sample response: Partial success

{
  "responseStatus": "PARTIAL_SUCCESS",
  "errors": [
    {
      "type": "INVALID_DATA",
      "message": "The specified key could not be found: VCRM:ENTITY:291256782200767500"
    }
  ]
}

responseStatus: The status of the response from Network.

errors - An array of attribute information objects:

Disassociate custom key

This API enables you to deactivate external key identifiers for any entity (an HCP, HCO, Address, License, or ParentHCO) in Network without going through the full change request process.

Note: This API requires system administrator or API-only permissions.

Compatibility

This API uses the DELETE HTTP method and is available in the following:

Syntax

https://<DNS>/api/<version>/custom_keys/<vid_key>

where: * DNS is the URL for your API service * version is the API version * vid_key is the key for the entity you want to deactivate

Parameters

None

Sample request

DELETE https://my.veevanetwork.com/api/v16.0/custom_keys/Network:Entity:813873

Response

Sample response

{
   "responseStatus": "SUCCESS"
}

responseStatus: The status of the response from Network.

Manage change requests

Change requests are the standard method used to submit changes in Network. The Change request APIs enable you to create change requests to add, update, merge, or split HCPs and HCOs.

Address, License, and ParentHCO information, including their custom keys, are part of each HCP and HCO. To add a new Address, License, or ParentHCO (including new custom keys) to either an HCP or HCO, you use the Create change request API. You can provide the vid_key of the HCP or HCO and the external ID of the new Address, License, or ParentHCO for more efficient processing.

Change request APIs to delete entities are not available, as information in Network cannot be deleted. For HCPs and HCOs, a change request for the Status field is the standard method to deactivate resources. Addresses, Licenses, and ParentHCOs follow the same procedure as part of the HCP or HCO in the Network data model.

The fields of any entity call are the properties for the corresponding entity. You can get the list of properties by accessing the Network external data model to see all fields for a particular entity. The data model also describes the fields required to create any resources, as well as any group of fields that must be submitted all together, if any of them changes (for example, address fields for regular mail).

If successful, each change request record received is responded to with a unique Network change request ID and date/time value upon reception.

Create a change request

Create HCP with two addresses, one license, and one parentHCO

{  
  "reserve_vid": true,
  "metadata": {
    "creator": "crmuser@pharma.com",
    "system": "VCRM",
    "note": "John Smith is a new doctor in the Network Hospital",
    "source": "Veeva CRM"
  },
  "entity_type": "HCP",
  "vid_key": "VCRM:HCP:001A000000pKagwIAC",
  "entity": {
    "attribute 1": "Value 1",
    "attribute 2": "Value 2",
    " ... ": " ... ",
    "addresses__v": [
      {
        "vid_key": "VCRM:Address:001A000000pLjigIAC",
        "attribute 1": "Value 1",
        "attribute 2": "Value 2",
        " ... ": " ... "
      }
    ],
    "licenses__v": [
      {
        "vid_key": "VCRM:License:001A000000pNfruIAC",
        "address_vid_key": "VCRM:Address:001A000000pLjigIAC",
        "attribute 1": "Value 1",
        "attribute 2": "Value 2",
        " ... ": " ... "
      }
    ],
    "parent_hcos__v": [
      {
        "vid_key": "VCRM:ChildAccount:001A000000pLkioIAC",
        "parent_hco_vid_key": "Network:HCO:215249678634058752",
        "attribute 1": "Value 1",
        "attribute 2": "Value 2",
        " ... ": " ... "
      }
    ]
  }
}

Update HCP with an existing address, a new address, and existing license

{
  "metadata": {
    "creator": "crmuser@pharma.com",
    "system": "VCRM",
    "note": "John Smith is a new doctor in the Network Hospital",
    "source": "Veeva CRM"
  },
  "entity_type": "HCP",
  "vid_key": "Network:HCP:214065474881717253",
  "entity": {
    "addresses__v": [
      {
        "vid_key": "Network:Address:214066274852930560",
        "attribute 1": "Value 1",
        "attribute 2": "Value 2",
        " ... ": " ... "
      },
      {
        "vid_key": "CRM:Address:001A000000hTapwIAC",
        "attribute 1": "Value 1",
        "attribute 2": "Value 2",
        " ... ": " ... "
      }
    ],
    "licenses__v": [
      {
        "vid_key": "VCRM:License:001A000000pNfruIAC",
        "address_vid_key": "VCRM:Address:001A000000hTapwIAC",
        "attribute 1": "Value 1",
        "attribute 2": "Value 2",
        " ... ": " ... "
      }
    ]
  }
}

Create HCO with one address and one parentHCO

{
  "metadata": {
    "creator": "crmuser@pharma.com",
    "system": "VCRM",
    "note": "New Hospital",
    "source": "Veeva CRM"
  },
  "entity_type": "HCO",
  "vid_key": "VCRM:HCO:001A000000pClakIAC",
  "entity": {
    "attribute 1": "Value 1",
    "attribute 2": "Value 2",
    " ... ": " ... ",
    "addresses__v": [
      {
        "vid_key": "VCRM:Address:001A000000pPlkjIAC",
        "attribute 1": "Value 1",
        "attribute 2": "Value 2",
        " ... ": " ... "
      }
    ],
    "parent_hcos__v": [
      {
        "vid_key": "VCRM:ChildAccount:001A000000pLkioIAC",
        "attribute 1": "Value 1",
        "attribute 2": "Value 2",
        " ... ": " ... "
      }
    ]
  }
}

Update HCO with new license

{
  "metadata": {
    "creator": "crmuser@pharma.com",
    "system": "VCRM",
    "note": "Update Hospital License",
    "source": "Veeva CRM"
  },
  "entity_type": "HCO",
  "vid_key": "Network:HCO:214065474881717253",
  "entity": {
    "licenses__v": [
      {
        "vid_key": "VCRM:License:001A000000pNfruIAC",
        "address_vid_key": "Network:Address:210909264435217422",
        "attribute 1": "Value 1",
        "attribute 2": "Value 2",
        " ... ": " ... "
      }
    ]
  }
}

Create HCP with create unverified on

{
  "create_unverified": true,
    "metadata": {
    "creator": "crmuser@pharma.com",
    "system": "VCRM",
    "note": "John Smith is a new doctor in the Network Hospital",
    "source": "Veeva CRM"
  },
  "entity_type": "HCP",
  "entity": {  }
}

This API enables you to create a Network change request to add or update an HCP or HCO and related entities (including Addresss, Licenses, or ParentHCOs) for gray data only. Change requests created using the API against orange data will be rejected.

Compatibility

This API uses the POST HTTP method and is available in the following:

Syntax

https://<DNS>/api/<version>/change_request

where:

Parameters

None

POST data

reserve_vid (optional Boolean type): Request to reserve a VID immediately when an add request is submitted.

metadata (required) - Details about the request being made. The details are saved in the entity history if the change is accepted (an array of fields within itself):

entity_type (required): The entity type of the change request (HCP or HCO).

vid_key (optional): The external HCP or HCO vid_key supplied by the client.

create_unverified (optional): Override the workflow settings for creating unverified records. If True, an unverified record is created with the DCR. If False, only the DCR is created. If not specified, the workflow settings persist.

entity - Details of the changes, one per field, for the entity provided:

Name Description
field (optional) The Network API name of the HCP or HCO field.
value (optional) The new value of the HCP or HCO field.
addresses__v (optional) An array of change requests for addresses, one per address, for the entity provided:

vid_key (optional) - the address vid_key supplied by the client
field (required) - the Network API name of the HCP or HCO Address field
value (required) - the new value of the HCP or HCO Address field

licenses__v (optional) An array of change requests for licenses, one per license, for the entity provided:

vid_key (optional) - the license vid_key supplied by the client
address_vid_key (optional) - the address vid_key to which the license is related, supplied by the client
address_index (optional) - the address index within the addresses__v object. Can be used when vid_key is not available. (The index is zero-based.)
field (required) - the Network API name of the HCP or HCO License field
value (required) - the new value of the HCP or HCO License field

parent_hcos__v (optional) An array of change requests for parent HCOs, one per parent HCO, for the entity provided:

vid_key (optional) - the parent HCO vid_key supplied by the client
parent_hco_vid_key (optional) - the actual HCO vid_key of the parent, supplied by the client
field (required) - the Network API name of the HCP or HCO ParentHCO field
value (required) - the new value of the HCP or HCO ParentHCO field

custom_keys__v (optional) An array of change requests for custom keys, one per custom key, for the entity provided:

vid_key (optional) - the custom key vid_key supplied by the client
field (required) - the Network API name of the custom key field
value (required) - the new value of the custom key field

Sample response

{
   "responseStatus": "SUCCESS",
   "change_request_id": 63259874100112589  
}
{
    "responseStatus": "FAILURE",
    "responseMessage": "Change requests are not supported for: EMPLOYEE__C.",
    "errors": [
        {
            "type": "UNSUPPORTED_TYPE",
            "message": "Change requests are not supported for: EMPLOYEE__C."
        }
    ],
    "errorType": "UNSUPPORTED_TYPE"
}

Response

responseStatus: The status of the response from Network.

change_request_id: The ID of the change request generated in Network.

Notes

Update Change Request

PUT data:

{
  "metadata": {
    "creator": "fName.lName@sandbox.veevanetwork.com",
    "note": "New record added via API.",
    "system": "ERP1"
  },
  "entity": {
    "hcp_type__v": {
      "change_requested": "P",
      "final_value": null,
      "result": "CHANGE_ACCEPTED"
    },
    "first_name__v": {
      "change_requested": "Charlie",
      "final_value": null,
      "result": "CHANGE_ACCEPTED"
    },
    "last_name__v": {
      "change_requested": "Brown",
      "final_value": null,
      "result": "CHANGE_ACCEPTED"
    },
    "hcp_status__v": {
      "change_requested": "A",
      "final_value": null,
      "result": "CHANGE_ACCEPTED"
    },
    "medical_degree_1__v": {
      "change_requested": "MD",
      "final_value": null,
      "result": "CHANGE_ACCEPTED"
    },
    "specialty_1__v": {
      "change_requested": "IM",
      "final_value": null,
      "result": "CHANGE_ACCEPTED"
    },
    "primary_country__v": {
      "change_requested": "US",
      "final_value": null,
      "result": "CHANGE_ACCEPTED"
    },
    "gender__v": {
      "change_requested": "M",
      "final_value": null,
      "result": "CHANGE_ACCEPTED"
    },
    "master_keys": [
      "master_source:HCP:997200002"
    ]
  },
  "taskCountry": "US",
  "task_type": "CHANGE_REQUEST",
  "original_task_type": "CHANGE_REQUEST",
  "change_request_id": "542116772438868992",
  "status__v": "CHANGE_NEW",
  "result__v": "CHANGE_PENDING",
  "entity_type": "HCP",
  "vid_key": null,
  "vid__v": null,
  "resolution_notes": null,
  "created_date": "2014-10-08T09:54:55.000-04:00",
  "completed_date": null,
  "job_ids": [
    "486"
  ],
  "comment": "All fields updated through load"
}

Sample response

 {
    "responseStatus": "SUCCESS",
    "change_requests": [
        {
            "responseStatus": "SUCCESS",
            "change_request_id": "542116772438868992"
        }
    ]
}
{
    "responseStatus": "FAILURE",
    "responseMessage": "Change requests are not supported for: EMPLOYEE__C.",
    "errors": [
        {
            "type": "UNSUPPORTED_TYPE",
            "message": "Change requests are not supported for: EMPLOYEE__C."
        }
    ],
    "errorType": "UNSUPPORTED_TYPE"
}

This API enables you to update an unprocessed change request through the API.

Compatibility

This API uses the PUT HTTP method and is available in the following:

Syntax

https://<DNS>/api/<version>/change_request

where:

PUT Data

system: The name of a valid system in Network. This parameter is required if you are using reference code aliases.

result (required):

master_keys: This parameter is only required if you are updating a change request from a third-party master. It is an array of external keys to identify the entity and each of the child objects (addresses, licenses, parent HCOs). The key format is the three-part format used by vid_key, consisting of source type (typically the name of the system used to load the master data), item type, and value, separated by colons. The master keys are essential to link the entity and child objects in the change request to the entity loaded through a subscription job.

taskCountry (required): The country code of the change request.

change_request_id (required): The ID of the change request generated in Network.

job_ids: A list of IDs of source subscription jobs used to load the entity in this change request. Upon processing, the final values of the fields of the entity will be obtained from the entity loaded through jobs.

comment: A comment about the feedback related to the change request update. The comment will be transfer to the resolution notes after each update.

Sample request

PUT https://my.network.com/api/v16.0/change_request

Response

responseStatus: The status of the response from Network.

change_requests - An array of change requests (only one for this API):

errors - An array of errors:

Notes

Not all fields in the change requests can be updated by the integrator system; however, those fields can be provided during the update and Network will ignore them.

Cancel change request

Sample response

{
   "responseStatus": "SUCCESS",
   "change_request_id": 63259874100112630 
}
{
    "responseStatus": "FAILURE",
    "responseMessage": "Change requests are not supported for: EMPLOYEE__C.",
    "errors": [
        {
            "type": "UNSUPPORTED_TYPE",
            "message": "Change requests are not supported for: EMPLOYEE__C."
        }
    ],
    "errorType": "UNSUPPORTED_TYPE"
}

Compatibility

This API uses the DELETE HTTP method and is available in the following:

Syntax

https://<DNS>/api/<version>/change_request/<change_request_id>

where:

Parameters

None

Sample request

DELETE https://my.network.com/api/v16.0/change_request/35647210469872563

Response

responseStatus: The status of the response from Network.

change_request_id: The ID of the change request generated in Network.

Notes

Retrieve change requests

Sample response

{
  "responseStatus": "SUCCESS",
  "change_requests": [
    {
      "metadata": {
        "creator": "fName.lName@sandbox.veevanetwork.com",
        "note": "New record added via Network portal.",
        "source": "Entity Profile Editor",
        "system": null
      },
      "entity": {
        "hcp_type__v": {
          "change_requested": "P",
          "final_value": "P",
          "result": "CHANGE_ACCEPTED"
        },
        "pdrp_optout__v": {
          "change_requested": "N",
          "final_value": "N",
          "result": "CHANGE_ACCEPTED"
        },
        "last_name__v": {
          "change_requested": "Baggings",
          "final_value": "Baggings",
          "result": "CHANGE_ACCEPTED"
        },
        "hcp_status__v": {
          "change_requested": "A",
          "final_value": "A",
          "result": "CHANGE_ACCEPTED"
        },
        "primary_country__v": {
          "change_requested": "US",
          "final_value": "US",
          "result": "CHANGE_ACCEPTED"
        },
        "ama_do_not_contact__v": {
          "change_requested": "N",
          "final_value": "N",
          "result": "CHANGE_ACCEPTED"
        },
        "first_name__v": {
          "change_requested": "Frodo",
          "final_value": "Frodo",
          "result": "CHANGE_ACCEPTED"
        },
        "addresses__v": [
          {
            "vid_key": null,
            "vid__v": "544410648797250562",
            "object_id": "544408526605255680",
            "administrative_area__v": {
              "change_requested": "US-NY",
              "final_value": "US-NY",
              "result": "CHANGE_ACCEPTED"
            },
            "postal_code__v": {
              "change_requested": "11235",
              "final_value": "11235",
              "result": "CHANGE_ACCEPTED"
            },
            "address_line_1__v": {
              "change_requested": "3049 Brighton 1st St|",
              "final_value": "3049 Brighton 1st St|",
              "result": "CHANGE_ACCEPTED"
            },
            "country__v": {
              "change_requested": "US",
              "final_value": "US",
              "result": "CHANGE_ACCEPTED"
            },
            "locality__v": {
              "change_requested": "Brooklyn",
              "final_value": "Brooklyn",
              "result": "CHANGE_ACCEPTED"
            },
            "address_status__v": {
              "change_requested": "A",
              "final_value": "A",
              "result": "CHANGE_ACCEPTED"
            },
            "address_type__v": {
              "change_requested": "P",
              "final_value": "P",
              "result": "CHANGE_ACCEPTED"
            },
            "address_line_2__v": {
              "change_requested": null,
              "final_value": null,
              "result": "CHANGE_ACCEPTED"
            }
          }
        ]
      },
      "task_type": "ADD_REQUEST",
      "original_task_type": "ADD_REQUEST",
      "taskCountry": "US",
      "change_request_id": "544408527049851904",
      "status__v": "CHANGE_PROCESSED",
      "result__v": "CHANGE_ACCEPTED",
      "entity_type": "HCP",
      "vid_key": null,
      "vid__v": "544410648772084737",
      "resolution_notes": [
        {
          "comment": "Accepted all changes",
          "fields": [
            "hcp_type__v",
            "pdrp_optout__v",
            "last_name__v",
            "hcp_status__v",
            "primary_country__v",
            "ama_do_not_contact__v",
            "first_name__v",
            "administrative_area__v",
            "postal_code__v",
            "address_line_1__v",
            "country__v",
            "locality__v",
            "address_status__v",
            "address_type__v",
            "address_line_2__v"
          ],
          "created_date": "2014-12-17T16:01:50.237-06:00",
          "code": "A-10001"
        }
      ],
      "created_date": "2014-12-17T15:57:50.000-06:00",
      "completed_date": "2014-12-17T16:03:26.000-06:00"
    }
  ]
}
{
    "responseStatus": "FAILURE",
    "responseMessage": "Change requests are not supported for: EMPLOYEE__C.",
    "errors": [
        {
            "type": "UNSUPPORTED_TYPE",
            "message": "Change requests are not supported for: EMPLOYEE__C."
        }
    ],
    "errorType": "UNSUPPORTED_TYPE"
}

This API enables you to retrieve response information for the create, update, and merge change requests submitted by a client application.

Compatibility

This API uses the GET HTTP method and is available in the following:

Syntax

https://<DNS>/api/<version>/change_requests/<change_request_ids>

where:

Parameters

status (required): Specifies only to retrieve change requests of a specific status from the IDs provided.

systemName: Specifies that Network will return target aliases specified for this system as well as the external customer keys associated to it. If a system is not provided, Network will return default reference value codes and empty external custom keys.

includeEntity: Specifies that Network will return the full entity or entities related to the requested change requests. An entity for a change request is determined from the entity identifier (vid__v) of the change request.

sinceDate: Include change requests modified after the specified date (exclusive). This value is specified in epoch time in milliseconds.

toDate: Include change requests modified on or before the specified date (inclusive). This value is specified in epoch time in milliseconds.

Sample requests

GET https://my.veevanetwork.com/api/v16.0/change_requests/544408527049851904,544411763097994240?status=CHANGE_PROCESSED&status=CHANGE_CANCELLED

GET https://my.veevanetwork.com/api/v16.0/change_requests/544408527049851904,544411763097994240?status=CHANGE_PROCESSED&systemName=VCRM

Response

responseStatus: The status of the response from Network.

metadata - Details about the request being made. The details are saved in the entity history if the change is accepted (an array of fields within itself):

entity - Details of the response changes, one per field, for the entity provided:

Name Description
field The Network API name of the HCP or HCO field. An array of object attributes within itself:

change_requested - the value of the requested change
final_value - the new value of the field
result - one of the following:

  • CHANGE_ACCEPTED: The change for this field has been accepted.
  • CHANGE_REJECTED: The change for this field has been rejected.
  • CHANGE_MODIFIED: The change for this field has been accepted with differences.
  • CHANGE_ALREADYAPPLIED: The change for this field has been already applied.
  • CHANGE_ADDED: The change for this field has been added to the change request after creation.
master_keys An array of external keys to identify the entity used when updating change requests through the API.
external_custom_keys An array of active external keys to identify the entity loaded through a subscription.
addresses__v An array of change requests for addresses, one per address, for the entity provided:

vid_key - the address vid_key supplied by the client
vid__v - the HCP or HCO Address ID
field - the Network API name of the HCP or HCO Address field.

The following are required:

change_requested - the value of the requested change
final_value - the new value of the field
result -

  • CHANGE_ACCEPTED: The change for this field has been accepted.
  • CHANGE_REJECTED: The change for this field has been rejected.
  • CHANGE_MODIFIED: The change for this field has been accepted with differences.
  • CHANGE_ALREADYAPPLIED: The change for this field has been already applied.
  • CHANGE_ADDED: The change for this field has been added to the change request after creation.

master_keys - An array of external keys to identify the address used when updating change requests through the API.
external_custom_keys - An array of active external keys to identify the address loaded through a subscription.

licenses__v An array of change requests for licenses, one per license, for the entity provided:

vid_key - the license vid_key supplied by the client
vid__v - the HCP or HCO License ID
field - the Network API name of the HCP or HCO License field.

The following are required:

change_requested - the value of the requested change
final_value - the new value of the field
result -

  • CHANGE_ACCEPTED: The change for this field has been accepted.
  • CHANGE_REJECTED: The change for this field has been rejected.
  • CHANGE_MODIFIED: The change for this field has been accepted with differences.
  • CHANGE_ALREADYAPPLIED: The change for this field has been already applied.
  • CHANGE_ADDED: The change for this field has been added to the change request after creation.

master_keys - An array of external keys to identify the license used when updating change requests through the API.
external_custom_keys - An array of active external keys to identify the license loaded through a subscription.

parent_hcos__v An array of change requests for parent HCOs, one per parent HCO, for the entity provided:

vid_key - the parent HCO vid_key supplied by the client
vid__v - the HCP or HCO Parent HCO ID
field - the Network API name of the HCP or HCO Parent HCO field.

The following are required:

change_requested - the value of the requested change
final_value - the new value of the field
result -

  • CHANGE_ACCEPTED: The change for this field has been accepted.
  • CHANGE_REJECTED: The change for this field has been rejected.
  • CHANGE_MODIFIED: The change for this field has been accepted with differences.
  • CHANGE_ALREADYAPPLIED: The change for this field has been already applied.
  • CHANGE_ADDED: The change for this field has been added to the change request after creation.

master_keys - An array of external keys to identify the parent HCO used when updating change requests through the API.
external_custom_keys - An array of active external keys to identify the parent HCO loaded through a subscription.

custom_keys__v An array of change requests for custom keys, one per custom key, for the entity provided:

vid_key - the custom key vid_key supplied by the client
vid__v - the custom key ID
field - the Network API name of the custom key field.

The following are required:

change_requested - the value of the requested change
final_value - the new value of the field
result -

  • CHANGE_ACCEPTED: The change for this field has been accepted.
  • CHANGE_REJECTED: The change for this field has been rejected.
  • CHANGE_MODIFIED: The change for this field has been accepted with differences.
  • CHANGE_ALREADYAPPLIED: The change for this field has been already applied.
  • CHANGE_ADDED: The change for this field has been added to the change request after creation.

task_type:

original_task_type:

taskCountry: The country code of the entity.

change_request_id: The ID of the change request generated in Network.

status__v:

result__v:

entity_type: The entity type of the change request (HCP or HCO).

vid_key: The external HCP or HCO vid_key supplied by the client.

vid__v: The ID of the entity (HCP or HCO).

resolution_notes - An array of comments containing all notes added while processing the change request:

created_date - The creation date of the change request. The date format uses the ISO8601 standard.

completed_date - The completed date of the change request. The date format uses the ISO8601 standard.

errors - Errors in retrieving the requested change requests.

entities - An array of entities associated with the change requests. Each entity is related to a change request through the vid__v field.

Notes

Batch Retrieve Change Requests

Retrieve change requests in batch:

{
  "change_requests":[
   {
    "change_request_id":"527723033129911296"
   },
   {
    "change_request_id":"493664636982264832"
   }
  ]
}

Retrieve change requests in batch with system name:

{
  "change_requests":[
   {
    "change_request_id":"441305647707849728"
   },
   {
    "change_request_id":"441306106715702272"
   }
  ],
  "systemName":"ODS"
}

Retrieve change requests in batch with status codes:

{
  "change_requests":[
   {
    "change_request_id":"441305647707849728"
   },
   {
    "change_request_id":"441306106715702272"
   }
  ],
  "status_codes":[
    "CHANGE_NEW",
    "CHANGE_PENDINGREVIEW"
  ]
}

Sample response

{
  "responseStatus": "SUCCESS",
  "change_requests": [
    {
      "metadata": {
        "creator": "fName.lName@sandbox.veevanetwork.com",
        "note": "Customer Master changes applied",
        "source": "Entity Profile Editor",
        "system": "ERP1"
      },
      "entity": {
        "specialty_2__v": {
          "change_requested": "MT",
          "final_value": null,
          "result": "CHANGE_REJECTED"
        },
        "external_custom_keys": [
          "ERP1:HCP:654321"
        ]
      },
      "taskCountry": "US",
      "task_type": "CHANGE_REQUEST",
      "original_task_type": "CHANGE_REQUEST",
      "change_request_id": "493664636982264832",
      "status__v": "CHANGE_PROCESSED",
      "result__v": "CHANGE_REJECTED",
      "entity_type": "HCP",
      "vid_key": "Network:Entity:462463289150931969",
      "vid__v": "462463289150931969",
      "resolution_notes": [
        {
          "comment": "System Rejected - Can't update an INVALID/MERGED-INTO record",
          "fields": [
            "specialty_2__v"
          ],
          "created_date": "2014-12-15T17:20:09.620-06:00",
          "code": "R-10001"
        }
      ],
      "created_date": "2014-10-08T16:38:47.000-05:00",
      "completed_date": "2014-12-15T17:20:11.000-06:00"
    },
    {
      "metadata": {
        "creator": "fName.lName@sandbox.veevanetwork.com",
        "note": "Customer Master changes applied",
        "source": "Entity Profile Editor",
        "system": null
      },
      "entity": {
        "external_custom_keys": [
          "ERP1:HCP:987654"
        ],
        "parent_hcos__v": [
          {
            "vid_key": "Network:ParentHCO:477715384619762691",
            "vid__v": "477715384619762691",
            "object_id": "527723032584651776",
            "is_primary_relationship__v": {
              "change_requested": "N",
              "final_value": null,
              "result": null
            },
            "external_custom_keys": [
              "ERP1:PARENTHCO:123456"
            ]
          }
        ]
      },
      "taskCountry": "US",
      "task_type": "CHANGE_REQUEST",
      "original_task_type": "CHANGE_REQUEST",
      "change_request_id": "527723033129911296",
      "status__v": "CHANGE_PENDINGREVIEW",
      "result__v": null,
      "entity_type": "HCP",
      "vid_key": "Network:Entity:469466290176656385",
      "vid__v": "469466290176656385",
      "resolution_notes": null,
      "created_date": "2014-11-24T15:26:44.000-06:00",
      "completed_date": null
    }
  ]
}
{
    "responseStatus": "FAILURE",
    "responseMessage": "Change requests are not supported for: EMPLOYEE__C.",
    "errors": [
        {
            "type": "UNSUPPORTED_TYPE",
            "message": "Change requests are not supported for: EMPLOYEE__C."
        }
    ],
    "errorType": "UNSUPPORTED_TYPE"
}

This API enables you to obtain information about multiple change requests through the API.

Compatibility

This API uses the POST HTTP method and is available in the following:

Syntax

https://<DNS>/api/<version>/change_requests/batch

where:

Parameters

change_requests (required): An array of change requests to retrieve.

systemName: The name of the system for the change requests.

status_codes: Status codes for which to retrieve change requests.

includeEntity: Specifies that Network will return the full entity or entities related to the requested change requests. An entity for a change request is determined from the entity identifier (vid__v) of the change request.

sinceDate: Include change requests modified after the specified date (exclusive). This value is specified in epoch time in milliseconds.

toDate: Include change requests modified on or before the specified date (inclusive). This value is specified in epoch time in milliseconds.

Sample request

POST https://my.network.com/api/v16.0/change_requests/batch

Response

responseStatus: The status of the response from Network.

metadata - Details about the request being made. The details are saved in the entity history if the change is accepted (an array of fields within itself):

entity - Details of the response changes, one per field, for the entity provided:

Name Description
field The Network API name of the HCP or HCO field. An array of object attributes within itself:

change_requested - the value of the requested change
final_value - the new value of the field
result - one of the following:

  • CHANGE_ACCEPTED: The change for this field has been accepted.
  • CHANGE_REJECTED: The change for this field has been rejected.
  • CHANGE_MODIFIED: The change for this field has been accepted with differences.
  • CHANGE_ALREADYAPPLIED: The change for this field has been already applied.
  • CHANGE_ADDED: The change for this field has been added to the change request after creation.
master_keys An array of external keys to identify the entity used when updating change requests through the API.
external_custom_keys An array of active external keys to identify the entity loaded through a subscription.
addresses__v An array of change requests for addresses, one per address, for the entity provided:

vid_key - the address vid_key supplied by the client
vid__v - the HCP or HCO Address ID
field - the Network API name of the HCP or HCO Address field.

The following are required:

change_requested - the value of the requested change
final_value - the new value of the field
result -

  • CHANGE_ACCEPTED: The change for this field has been accepted.
  • CHANGE_REJECTED: The change for this field has been rejected.
  • CHANGE_MODIFIED: The change for this field has been accepted with differences.
  • CHANGE_ALREADYAPPLIED: The change for this field has been already applied.
  • CHANGE_ADDED: The change for this field has been added to the change request after creation.

master_keys - An array of external keys to identify the address used when updating change requests through the API.
external_custom_keys - An array of active external keys to identify the address loaded through a subscription.

licenses__v An array of change requests for licenses, one per license, for the entity provided:

vid_key - the license vid_key supplied by the client
vid__v - the HCP or HCO License ID
field - the Network API name of the HCP or HCO License field.

The following are required:

change_requested - the value of the requested change
final_value - the new value of the field
result -

  • CHANGE_ACCEPTED: The change for this field has been accepted.
  • CHANGE_REJECTED: The change for this field has been rejected.
  • CHANGE_MODIFIED: The change for this field has been accepted with differences.
  • CHANGE_ALREADYAPPLIED: The change for this field has been already applied.
  • CHANGE_ADDED: The change for this field has been added to the change request after creation.

master_keys - An array of external keys to identify the license used when updating change requests through the API.
external_custom_keys - An array of active external keys to identify the license loaded through a subscription.

parent_hcos__v An array of change requests for parent HCOs, one per parent HCO, for the entity provided:

vid_key - the parent HCO vid_key supplied by the client
vid__v - the HCP or HCO Parent HCO ID
field - the Network API name of the HCP or HCO Parent HCO field.

The following are required:

change_requested - the value of the requested change
final_value - the new value of the field
result -

  • CHANGE_ACCEPTED: The change for this field has been accepted.
  • CHANGE_REJECTED: The change for this field has been rejected.
  • CHANGE_MODIFIED: The change for this field has been accepted with differences.
  • CHANGE_ALREADYAPPLIED: The change for this field has been already applied.
  • CHANGE_ADDED: The change for this field has been added to the change request after creation.

master_keys - An array of external keys to identify the parent HCO used when updating change requests through the API.
external_custom_keys - An array of active external keys to identify the parent HCO loaded through a subscription.

custom_keys__v An array of change requests for custom keys, one per custom key, for the entity provided:

vid_key - the custom key vid_key supplied by the client
vid__v - the custom key ID
field - the Network API name of the custom key field.

The following are required:

change_requested - the value of the requested change
final_value - the new value of the field
result -

  • CHANGE_ACCEPTED: The change for this field has been accepted.
  • CHANGE_REJECTED: The change for this field has been rejected.
  • CHANGE_MODIFIED: The change for this field has been accepted with differences.
  • CHANGE_ALREADYAPPLIED: The change for this field has been already applied.
  • CHANGE_ADDED: The change for this field has been added to the change request after creation.

task_type:

original_task_type:

taskCountry: The country code of the entity.

change_request_id: The ID of the change request generated in Network.

status__v:

result_v:

entity_type: The entity type of the change request (HCP or HCO).

vid_key: The external HCP or HCO vid_key supplied by the client.

vid__v: The ID of the entity (HCP or HCO).

resolution_notes - An array of comments containing all notes added while processing the change request:

created_date: The creation date of the change request. The date format uses the ISO8601 standard.

completed_date: The completed date of the change request. The date format uses the ISO8601 standard.

errors: Errors in retrieving the requested change requests.

entities: An array of entities associated with the change requests. Each entity is related to a change request through the vid__v field.

Notes

None

Batch Update Change Requests

PUT data:

{
  "change_requests": [
    {
      "metadata": {
        "creator": "fName.lName@sandbox.veevanetwork.com",
        "note": "New record added via API.",
        "system": "ERP1"
      },
      "entity": {
        "hcp_type__v": {
          "change_requested": "P",
          "final_value": null,
          "result": "CHANGE_ACCEPTED"
        },
        "first_name__v": {
          "change_requested": "Marvin",
          "final_value": null,
          "result": "CHANGE_ACCEPTED"
        },
        "last_name__v": {
          "change_requested": "Gaye",
          "final_value": null,
          "result": "CHANGE_ACCEPTED"
        },
        "hcp_status__v": {
          "change_requested": "A",
          "final_value": null,
          "result": "CHANGE_ACCEPTED"
        },
        "medical_degree_1__v": {
          "change_requested": "MD",
          "final_value": null,
          "result": "CHANGE_ACCEPTED"
        },
        "specialty_1__v": {
          "change_requested": "IM",
          "final_value": null,
          "result": "CHANGE_ACCEPTED"
        },
        "primary_country__v": {
          "change_requested": "US",
          "final_value": null,
          "result": "CHANGE_ACCEPTED"
        },
        "gender__v": {
          "change_requested": "M",
          "final_value": null,
          "result": "CHANGE_ACCEPTED"
        },
        "master_keys": [
          "master_source:HCP:997200012"
        ]
      },
      "taskCountry": "US",
      "change_request_id": "543667922896159744",
      "status__v": "CHANGE_PARTIALLYPROCESSED",
      "result__v": null,
      "entity_type": "HCP",
      "vid_key": null,
      "vid__v": null,
      "resolution_notes": null,
      "created_date": "2014-11-06T08:49:33.000-05:00",
      "completed_date": null,
      "job_ids": [
        "504"
      ],
      "comment": "All fields updated through master data load"
    },
    {
      "metadata": {
        "creator": "fName.lName@sandbox.veevanetwork.com",
        "note": "New record added via API.",
        "source": "API"
      },
      "entity": {
        "hcp_type__v": {
          "change_requested": "P",
          "final_value": null,
          "result": "CHANGE_ACCEPTED"
        },
        "first_name__v": {
          "change_requested": "Nigella",
          "final_value": null,
          "result": "CHANGE_ACCEPTED"
        },
        "last_name__v": {
          "change_requested": "Lam",
          "final_value": null,
          "result": "CHANGE_ACCEPTED"
        },
        "hcp_status__v": {
          "change_requested": "A",
          "final_value": null,
          "result": "CHANGE_ACCEPTED"
        },
        "medical_degree_1__v": {
          "change_requested": "MD",
          "final_value": null,
          "result": "CHANGE_ACCEPTED"
        },
        "specialty_1__v": {
          "change_requested": "IM",
          "final_value": null,
          "result": "CHANGE_ACCEPTED"
        },
        "primary_country__v": {
          "change_requested": "US",
          "final_value": null,
          "result": "CHANGE_ACCEPTED"
        },
        "gender__v": {
          "change_requested": "M",
          "final_value": null,
          "result": "CHANGE_ACCEPTED"
        },
        "master_keys": [
          "master_source:HCP:997200013"
        ]
      },
      "taskCountry": "US",
      "change_request_id": "542116772438868992",
      "status__v": "CHANGE_PARTIALLYPROCESSED",
      "result__v": null,
      "entity_type": "HCP",
      "vid_key": null,
      "vid__v": null,
      "resolution_notes": null,
      "created_date": "2014-11-06T08:49:33.000-05:00",
      "completed_date": null,
      "job_ids": [
        "504"
      ],
      "comment": "All fields updated through master data load"
    }
  ]
}

Sample response

 {
    "responseStatus": "SUCCESS",
    "change_requests": [
        {
            "responseStatus": "SUCCESS",
            "change_request_id": "543667922896159744"
        },
        {
            "responseStatus": "SUCCESS",
            "change_request_id": "542116772438868992"
        }
    ]
}

This API enables you to update multiple unprocessed change requests through the API.

Compatibility

This API uses the PUT HTTP method and is available in the following:

Syntax

https://<DNS>/api/<version>/change_request/batch

where:

PUT data

system (required): The system used to load the data through a subscription job. result (required):

master_keys (required): An array of external keys to identify the entity and each of the child objects (addresses, licenses, parent HCOs). The key format is the three-part format used by vid_key, consisting of source type (typically the name of the system used to load the master data), item type, and value, separated by colons. The master keys are essential to link the entity and child objects in the change request to the entity loaded through a subscription job.

taskCountry (required): The country code of the change request.

change_request_id (required): The ID of the change request generated in Network.

job_ids: A list of IDs of source subscription jobs used to load the entity in this change request. Upon processing, the final values of the fields of the entity will be obtained from the entity loaded through jobs.

comment: A comment about the feedback related to the change request update. The comment will be transfer to the resolution notes after each update.

Sample request

PUT https://my.network.com/api/v16.0/change_request/batch

Response

responseStatus: The status of the response from Network.

change_requests - An array of change requests:

errors - An array of errors.

Notes

None

Batch Approve Change Request

Sample response

{
   "responseStatus": "SUCCESS"
}

This API enables you to bulk approve up to 500 change requests.

Compatibility

This API uses the PUT HTTP method and is available in the following:

Syntax

https://<DNS>/api/<version>/change_request/approve/batch

where:

PUT data

change_request_id (required): The IDs of the change request to approve.

systemName (optional): The name of the system for the change requests.

Sample request

PUT https://my.network.com/api/v13.0/change_request/approve/batch

Response

responseStatus: The status of the response from Network.

Notes

None

Batch Reject Change Request

Sample response

{
   "responseStatus": "SUCCESS"
}

This API enables you to bulk reject up to 500 change requests.

Compatibility

This API uses the PUT HTTP method and is available in the following:

Syntax

https://<DNS>/api/<version>/change_request/reject/batch

where:

PUT data

change_request_id (required): The IDs of the change request to reject.

systemName (optional): The name of the system for the change requests.

Sample request

PUT https://my.network.com/api/v13.0/change_request/reject/batch

Response

responseStatus: The status of the response from Network.

Notes

None

Process Change Request

Sample response

{
   "responseStatus": "SUCCESS"
}

This API enables you to process an unprocessed change request through the API.

Compatibility

This API uses the PUT HTTP method and is available in the following:

Syntax

https://<DNS>/api/<version>/change_request/process

where:

PUT data

change_request_id (required): The IDs of the change request to process.

systemName (optional): The name of the system for the change requests.

Sample request

PUT https://my.veevanetwork.com/api/v16.0/change_request/process/542116772438868992?systemName=ODS

Response

responseStatus: The status of the response from Network.

Notes

None

Batch Process Change Requests

PUT data:

{
  "change_requests": [
    {
      "change_request_id": "543667922896159744"
    },
    {
      "change_request_id": "542116772438868992"
    }
  ],
  "systemName": "ERP1"
}

Sample response

{
   "responseStatus": "SUCCESS"
}

This API enables you to process multiple unprocessed change requests through the API.

Compatibility

This API uses the PUT HTTP method and is available in the following:

Syntax

https://<DNS>/api/<version>/change_request/process/batch

where:

PUT data

change_requests (required): The IDs of each change request to process.

systemName (optional): The name of the system for the change requests.

Sample request

PUT https://my.network.com/api/v16.0/change_requests/process/batch

Response

responseStatus: The status of the response from Network.

Notes

None

Sample response

{
  "responseStatus": "SUCCESS",
  "totalCount": 84,
  "offset": 0,
  "limit": 2,
  "change_requests": [
    {
      "metadata": {
        "creator": "fName.lName@sandbox.veevanetwork.com",
        "note": "New record added via Network portal.",
        "source": "Entity Profile Editor",
        "system": null
      },
      "entity": {
        "prefix__v": {
          "change_requested": "DR",
          "final_value": null,
          "result": null
        },
        "hcp_type__v": {
          "change_requested": "P",
          "final_value": null,
          "result": null
        },
        "last_name__v": {
          "change_requested": "rao",
          "final_value": null,
          "result": null
        },
        "hcp_status__v": {
          "change_requested": "A",
          "final_value": null,
          "result": null
        },
        "medical_degree_1__v": {
          "change_requested": "ACDT",
          "final_value": null,
          "result": null
        },
        "board_certification__v": {
          "change_requested": "AS",
          "final_value": null,
          "result": null
        },
        "grad_year__v": {
          "change_requested": 2011,
          "final_value": null,
          "result": null
        },
        "mpa__v": {
          "change_requested": "30",
          "final_value": null,
          "result": null
        },
        "medical_degree_2__v": {
          "change_requested": "ACDT",
          "final_value": null,
          "result": null
        },
        "pdrp_optout__v": {
          "change_requested": "Y",
          "final_value": null,
          "result": null
        },
        "primary_country__v": {
          "change_requested": "US",
          "final_value": null,
          "result": null
        },
        "pdrp_optout_date__v": {
          "change_requested": "2014-11-05",
          "final_value": null,
          "result": null
        },
        "fellow__v": {
          "change_requested": "Y",
          "final_value": null,
          "result": null
        },
        "education_level__v": {
          "change_requested": "SPEC",
          "final_value": null,
          "result": null
        },
        "grad_trg_start_date__v": {
          "change_requested": "2014-10-02",
          "final_value": null,
          "result": null
        },
        "gender__v": {
          "change_requested": "F",
          "final_value": null,
          "result": null
        },
        "place_of_employment__v": {
          "change_requested": "31",
          "final_value": null,
          "result": null
        },
        "first_name__v": {
          "change_requested": "stefanie",
          "final_value": null,
          "result": null
        }
      },
      "taskCountry": "US",
      "task_type": "ADD_REQUEST",
      "original_task_type": "ADD_REQUEST",
      "change_request_id": "488453991114474496",
      "status__v": "CHANGE_PARTIALLYPROCESSED",
      "result__v": null,
      "entity_type": "HCP",
      "vid_key": null,
      "vid__v": "488454076267234305",
      "resolution_notes": [
        {
          "comment": "System Rejected - Invalid change requested value",
          "fields": [
            "specialty_1__v"
          ],
          "created_date": "2015-08-03T04:09:59.817-07:00",
          "code": "A-10001"
        }
      ],
      "created_date": "2014-10-01T12:06:10.000-05:00",
      "completed_date": null
    },
    {
      "metadata": {
        "creator": "fName.lName@sandbox.veevanetwork.com",
        "note": "Customer Master changes applied",
        "source": "Entity Profile Editor",
        "system": null
      },
      "entity": {
        "licenses__v": [
          {
            "vid_key": null,
            "vid__v": "519053402886374401",
            "object_id": "519053178885374976",
            "type_value__v": {
              "change_requested": "DEA",
              "final_value": null,
              "result": null
            },
            "expiration_date__v": {
              "change_requested": "2014-11-20",
              "final_value": null,
              "result": null
            },
            "license_eligibility__v": {
              "change_requested": "E",
              "final_value": null,
              "result": null
            },
            "license_status__v": {
              "change_requested": "A",
              "final_value": null,
              "result": null
            },
            "license_number__v": {
              "change_requested": "2316547",
              "final_value": null,
              "result": null
            },
            "external_custom_keys": [
              "TEST:HCP:997200021"
            ],
            "master_keys": [
              "TEST:HCP:997200021"
            ]
          }
        ]
      },
      "taskCountry": "US",
      "task_type": "CHANGE_REQUEST",
      "original_task_type": "CHANGE_REQUEST",
      "change_request_id": "519053192273593344",
      "status__v": "CHANGE_PARTIALLYPROCESSED",
      "result__v": null,
      "entity_type": "HCP",
      "vid_key": "Network:Entity:462313921169064961",
      "vid__v": "462313921169064961",
      "resolution_notes": null,
      "created_date": "2014-11-12T16:21:20.000-06:00",
      "completed_date": null
    }
  ]
}

This API enables you to retrieve all change requests that match a specified search criteria.

Compatibility

This API uses the GET HTTP method and is available in the following:

Syntax

https://<DNS>/api/<version>/change_request/search

where:

Parameters

q(optional) - The query string used for fuzzy search in text fields. This includes the following fields:

offset (optional): The first record to retrieve (type Integer). The default is 0.

limit (optional): The number to limit the results returned (type Integer). The default is 10. The maximum is 100.

sort (optional): The attribute to sort results by (type Text). For example, task_type.

sortOrder (optional): The sort order for the search. Value is asc for ascending or desc for descending.

filters (optional) - Filters for refining the results. Filters are based on the following attributes:

Attribute Description
task_type CHANGE_REQUEST - A change request submitted on an existing record in Network.
ADD_REQUEST – An add request for a new record in Network.
By default, both task types are returned.
task_status NEW - A new task that has been received but not run yet.
IN_PROGRESS - A task that is pending approval by a master or customer steward.
CLOSED - A task that has been closed.
task_country The country that the task belongs to.
task_state NEW - A new task that has been received but not run yet.
PENDINGREVIEW - A task that was received and processed but is pending review by data stewards or another upstream source.
CANCELLED – A task that was cancelled.
FAILED – A task that failed due to an unexpected error.
PROCESSED – A task that was processed and a result issued.
PROCESSING – A task that is being processed.
resolution CHANGE_PENDING - All changes for this request that are pending approval.
CHANGE_ACCEPTED - All changes for this request that have been accepted.
CHANGE_REJECTED - No changes for this request were accepted.
CHANGE_PARTIAL - At least one field change was accepted.
created_at The date the task was created.
created_by The ID of the user that generated the change request.
creator The user name of the user that generated the change request.
completed_at The completed date of the task. This attribute is empty if the change request is not completed. The date format is ISO8601 standard.
completed_by The ID of the user that approved the task.
open The task is open. The value of this attribute is True or False.
system The name of the system that generated the task.
entity_type The entity type of the task (HCP or HCO).
entity_id The Veeva Network entity ID.
owner The ID of the owner of the task.

systemName (optional): If provided, Network will return target alias values specified for reference value codes for this system. If system is not provided, Network will return default reference value codes.

masterSystemNames (optional): A comma-separated list of master system names. Search results will include only change requests for the specified master systems. This includes all pending and processed change requests.

pendingMasterSystemNames (optional): A comma-separated list of master system names. Search results will include only change requests awaiting processing for the specified master systems.

Sample request

Search on requests with a task status of NEW for US records:

https://my.veevanetwork.com/api/v16.0/change_request/search?offset=0&limit=100&filters=task_status:NEW~task_country:US

Search on requests between specified dates:

https://my.veevanetwork.com/api/v16.0/change_request/search?filters=range||created_at:1403531171000||1406123171000

Search on requests from a specified date to the current date:

https://my.veevanetwork.com/api/v16.0/change_request/search?filters=range||created_at:1403531171000

Search on requests created before the last 48 hours:

https://my.veevanetwork.com/api/v16.0/change_request/search?rangeDiff||created_at:||48

Response

responseStatus: The status of the response from Network.

totalCount: The total number of records found by search, regardless of the search limit.

offset: The first record to retrieve from the specified offset.

limit: The specified limit for results.

change_requests - An array of change requests:

Name Description
metadata creator - The name of the user that generated the change request.
note - Details about the change request.
source - Additional information about the source of the change request.
system - The name of the system that generated the change request (used for reference aliases and other validation)
entity An array of fields in the change request with the following information:

change_requested - the value of the requested change
final_value - the new value of the field
result - one of the following:

  • CHANGE_ACCEPTED: The change for this field has been accepted.
  • CHANGE_REJECTED: The change for this field has been rejected.
  • CHANGE_MODIFIED: The change for this field has been accepted with differences.
  • CHANGE_ALREADYAPPLIED: The change for this field has been already applied.
  • CHANGE_ADDED: The change for this field has been added to the change request after creation.
master_keys An array of external keys to identify the license used when updating change requests through the API.
external_custom_keys An array of active external keys to identify the license loaded through a subscription.
addresses__v An array of change requests for addresses, one per address, for the entity provided:

vid_key - the address vid_key supplied by the client
vid__v - the HCP or HCO Address ID
field - the Network API name of the HCP or HCO Address field.

The following are required:

change_requested - the value of the requested change
final_value - the new value of the field
result -

  • CHANGE_ACCEPTED: The change for this field has been accepted.
  • CHANGE_REJECTED: The change for this field has been rejected.
  • CHANGE_MODIFIED: The change for this field has been accepted with differences.
  • CHANGE_ALREADYAPPLIED: The change for this field has been already applied.
  • CHANGE_ADDED: The change for this field has been added to the change request after creation.

master_keys - An array of external keys to identify the address used when updating change requests through the API.
external_custom_keys - An array of active external keys to identify the address loaded through a subscription.

licenses__v An array of change requests for licenses, one per license, for the entity provided:

vid_key - the license vid_key supplied by the client
vid__v - the HCP or HCO License ID
field - the Network API name of the HCP or HCO License field.

The following are required:

change_requested - the value of the requested change
final_value - the new value of the field
result -

  • CHANGE_ACCEPTED: The change for this field has been accepted.
  • CHANGE_REJECTED: The change for this field has been rejected.
  • CHANGE_MODIFIED: The change for this field has been accepted with differences.
  • CHANGE_ALREADYAPPLIED: The change for this field has been already applied.
  • CHANGE_ADDED: The change for this field has been added to the change request after creation.

master_keys - An array of external keys to identify the license used when updating change requests through the API.
external_custom_keys - An array of active external keys to identify the license loaded through a subscription.

parent_hcos__v An array of change requests for parent HCOs, one per parent HCO, for the entity provided:

vid_key - the parent HCO vid_key supplied by the client
vid__v - the HCP or HCO Parent HCO ID
field - the Network API name of the HCP or HCO Parent HCO field.

The following are required:

change_requested - the value of the requested change
final_value - the new value of the field
result -

  • CHANGE_ACCEPTED: The change for this field has been accepted.
  • CHANGE_REJECTED: The change for this field has been rejected.
  • CHANGE_MODIFIED: The change for this field has been accepted with differences.
  • CHANGE_ALREADYAPPLIED: The change for this field has been already applied.
  • CHANGE_ADDED: The change for this field has been added to the change request after creation.

master_keys - An array of external keys to identify the parent HCO used when updating change requests through the API.
external_custom_keys - An array of active external keys to identify the parent HCO loaded through a subscription.

taskCountry: The country for the change request.

task_type:

original_task_type:

change_request_id: The ID of the change request generated in Network.

status__v: The status of the change request in Network:

result_v - The result of the change request:

entity_type: The entity for the change request (HCP or HCO).

vid_key: The external HCP or HCOvid_key supplied by the client.

vid__v: The ID of the entity (HCP or HCO).

resolution_notes - An array of comments containing all notes added while processing the change request:

created_date - The creation date of the change request. The date format uses the ISO8601 standard.

completed_date: The completed date of the change request. The date format uses the ISO8601 standard.

errors - Errors in retrieving the requested change requests.

Notes

None

Change Request Match

Sample response

{
   "responseStatus": "SUCCESS",
   "change_request_id": 542116772438868992
}

This API enables you to match a request to an existing entity. You can use either the Veeva ID or custom key of an existing entity to match the request against.

Compatibility

This API uses the POST HTTP method and is available in the following:

Syntax

https://dns/api/version/change_request/match/change_request_id

where:

Parameters

vidKey (required): The external HCP or HCOvid_key or the Veeva ID of the entity.

comment (optional): Notes added by the Network user.

Sample requests

POST https://my.veevanetwork.com/api/v16.0/change_request/match/542116772438868992?vidKey=847328898944336896

POST https://my.veevanetwork.com/api/v16.0/change_request/match/542116772438868992?vidKey=Network:Entity:1325540&comment=comments

Response

responseStatus: The status of the response from Network.

change_request_id: The ID of the change request generated in Network.

Notes

Batch Process Suspect Match

Sample request - Reject suspect match

{
   "suspect_matches":[
      {
         "task_id":"929058362287521823",
         "comment":"Rejected suspect match"
      }
   ]
}

Sample response - Reject suspect match

{
   "responseStatus": "SUCCESS",
   "suspect_matches": [
      {
         "responseStatus": "SUCCESS",
         "task_id": "929058362287521823"
      }
   ]
}

Sample request - Accept suspect match

{
   "suspect_matches":[
      {
         "task_id":"929058346986962975",
         "comment":"Accepted suspect match",
         "match_entities":[
            {
               "source_entity_id":"928729167160023840",
               "target_entity_id":"928729206350945055"
            }
         ]
      }
   ]
}

Sample response - Accept suspect match

{
   "responseStatus": "SUCCESS",
   "suspect_matches": [
      {
         "responseStatus": "SUCCESS",
         "task_id": "929058346986962975"
      }
   ]
}

This API enables enables you to process multiple unprocessed suspect matches.

Compatibility

This API uses the PUT HTTP method and is available in the following:

Syntax

https://dns/api/version/suspect-match/process/batch

where:

PUT data

comment (optional): The resolution note to apply.

match_entities (optional): The pairs of entities to match. Leave empty to reject the suspect match.

source_entity_id (optional): The ID of the entity to be merged.

target_entity_id (optional): The ID of the entity that the match will be merged into.

task_id (required): The ID of a suspect match to process.

Sample requests

PUT https://my.veevanetwork.com/api/v16.0/suspect-match/process/batch

Response

responseStatus: The status of the response from Network.

suspect_matches: An array of suspect matches that correspond to the objects in the request:

Notes

Batch Create Suspect Match

POST data

{
    "suspect_matches": [{
            "metadata": {
                "note": "",
                "creator": "creator name"
            },
            "vid_key": "Network:Entity:932020967181320223",
            "matching_vid_key": "Network:Entity:932020953046843423"
        }, {
            "metadata": {
                "note": "",
                "creator": "creator name"
            },
            "vid_key": "Network:Entity:847332072463795200",
            "matching_vid_key": "Network:Entity:847332072480572416"
        }
    ]
}

This API enables enables you to create multiple suspect matches.

Compatibility

This API uses the POST HTTP method and is available in the following:

Syntax

https://dns/api/version/entity/createSuspectMatch/batch

where:

POST data

vid_key (required): The Network ID of the entity to be merged.

matching_vid_key (required): The Network ID of the entity to match.

metadata (required): Details about the request:

Sample requests

POST https://my.veevanetwork.com/api/v15.0/entity/createSuspectMatch/batch

Sample response

{
    "responseStatus": "PARTIAL_SUCCESS",
    "errors": [
        {
            "type": "UNEXPECTED_ERROR",
            "message": "No entity found with the given Id Network:Entity:932020967181320223"
        }
    ],
    "errorType": "UNEXPECTED_ERROR",
    "suspect_matches": [
        {
            "suspect_match_id": "932217992971223103"
        }
    ]
}

Response

responseStatus: The status of the response from Network.

suspect_matches: An array of suspect matches that correspond to the objects in the request:

Notes

Batch Reject Suspect Match

POST data

{
  "suspect_matches": [
    {
      "suspect_match_id": "932217992971xx223103"
    },
    {
      "suspect_match_id": "932218031792324671"
    }
    ]
}

This API enables enables you to reject multiple suspect match tasks.

Compatibility

This API uses the POST HTTP method and is available in the following:

Syntax

https://dns/api/version/suspect_match/reject/batch

where:

POST data

suspect match IDs (required) - An array of suspect_match_ids to reject.

Sample requests

POST https://my.veevanetwork.com/api/v15.0/suspect_match/reject/batch

Sample response

{
    "responseStatus": "PARTIAL_SUCCESS",
    "errors": [
        {
            "type": "INVALID_DATA",
            "message": "Suspect match id 932217992971xx223103 is invalid"
        }
    ],
    "suspect_matches": [
        {
            "suspect_match_id": "932218031792324671"
        }
    ]
}

Response

responseStatus: The status of the response from Network.

suspect_matches: An array of suspect matches that correspond to the objects in the request:

Notes

Batch Retrieve Suspect Match

POST data

{
  "suspect_matches": [
    {
      "suspect_match_id": "932128278332112959"
    },
    {
      "suspect_match_id": "932128278332234456"
    }
    ]
}

This API enables enables you to retrieve information about multiple suspect matches.

Compatibility

This API uses the POST HTTP method and is available in the following:

Syntax

https://dns/api/version/suspect_match/batch

where:

POST data

suspect match IDs (required) - An array of suspect_match_ids to retrieve.

Sample requests

POST https://my.veevanetwork.com/api/v15.0/suspect_match/batch

Sample response

{
    "responseStatus": "PARTIAL_SUCCESS",
    "errors": [
        {
            "type": "INVALID_DATA",
            "message": "Suspect Match Task 931697085670096927 not found"
        },
        {
            "type": "INVALID_DATA",
            "message": "Suspect Match Task 931697013151105055 not found"
        }
    ],
    "suspect_matches": [
        {
            "id": 932218057214525503,
            "resolution": "NOT_MATCHED",
            "state": "PROCESSED",
            "created_date": "2018-04-10T11:25:43.000-07:00",
            "completed_date": "2018-04-10T11:27:31.000-07:00",
            "suspect_match_results": [
                {
                    "merge_into_vid": 847332072463795200,
                    "surviving_entity_vid": null
                }
            ]
        }
    ]
}

Response

responseStatus: The status of the response from Network.

suspect_matches: An array of suspect matches that correspond to the objects in the request:

Notes

Retrieve entities

This API enables you to retrieve entity information and associate custom keys with or disassociate them from other entities.

Retrieve Entity

Sample response

{   
  "responseStatus": "SUCCESS",
  "entities": [
    {
      "entityId": "505659322685034497",
      "entityType": "HCP",
      "metaData": {},
      "entity": {
        "attribute 1": "Value 1",
        "attribute 2": "Value 2",
        " ... ": " ... ",
        "custom_keys__v": [
          {
            "attribute 1": "Value 1",
            "attribute 2": "Value 2",
            " ... ": " ... "
          }
        ],
        "addresses__v": [
          {
            "attribute 1": "Value 1",
            "attribute 2": "Value 2",
            " ... ": " ... ",
            "custom_keys__v": [
              {
                "attribute 1": "Value 1",
                "attribute 2": "Value 2",
                " ... ": " ... "
              }
            ]
          }
        ],
        "licenses__v": [
          {
            "attribute 1": "Value 1",
            "attribute 2": "Value 2",
            " ... ": " ... ",
            "custom_keys__v": [
              {
                "attribute 1": "Value 1",
                "attribute 2": "Value 2",
                " ... ": " ... "
              }
            ]
         }
        ],
        "parent_hcos__v": [
          {
            "attribute 1": "Value 1",
            "attribute 2": "Value 2",
            " ... ": " ... ",
            "custom_keys__v": [
              {
                "attribute 1": "Value 1",
                "attribute 2": "Value 2",
                " ... ": " ... "
              }
            ]
          }
        ]
      }
    }
  ]
}

Sample response (custom objects)

{
    "responseStatus": "SUCCESS",
    "entities": [
        {
            "entityId": "933580259012116863",
            "entityType": "EMPLOYEE__C",
            "metaData": {},
            "entity": {
                "employee_title__c": "Key Account Manager",
                "record_owner_type__v": "LOCAL",
                "employee_status__c": "A",
                "employee_business_unit__c": "Sales",
                "employee_number__c": "103",
                "employee_last_name__c": "Carter",
                "record_delta_id__v": "933580259060776959",
                "record_owner_name__v": "Local",
                "employee_name__c": "Daniel Carter",
                "primary_country__v": "US",
                "created_date__v": "2018-12-07T08:11:33.000Z",
                "employee_first_name__c": "Daniel",
                "employee_hire_date__c": "2018-12-01",
                "is_veeva_master__v": false,
                "status_update_time__v": "2018-12-07T08:11:33.000Z",
                "modified_date__v": "2018-12-07T08:11:33.000Z",
                "record_state__v": "VALID",
                "candidate_record__v": false,
                "record_version__v": 0,
                "vid__v": "933580259012116863",
                "is_externally_mastered__v": false,
                "custom_keys__v": [
                    {
                        "custom_key_entity_id__v": "933580259012116863",
                        "custom_key_item_type__v": "EMPLOYEE__C",
                        "custom_key_value__v": "933580259012116863",
                        "modified_date__v": "2018-12-07T08:11:33.000Z",
                        "vid__v": "933580259018867071",
                        "custom_key_vid_key__v": "CUSTOMER__v/3/change_request:EMPLOYEE__C:933580259012116863",
                        "custom_key_source_type__v": "CUSTOMER__v/3/change_request",
                        "created_date__v": "2018-12-07T08:11:33.000Z",
                        "custom_key_entity_type__v": "EMPLOYEE__C",
                        "custom_key_status__v": "A",
                        "status_update_time__v": "2018-12-07T08:11:33.000Z"
                    },
                    {
                        "custom_key_entity_id__v": "933580259012116863",
                        "custom_key_item_type__v": "DCRID__v",
                        "custom_key_value__v": "933580258951365023",
                        "modified_date__v": "2018-12-07T08:11:33.000Z",
                        "vid__v": "933580259019194751",
                        "custom_key_vid_key__v": "WORKFLOW__v:DCRID__v:933580258951365023",
                        "custom_key_source_type__v": "WORKFLOW__v",
                        "created_date__v": "2018-12-07T08:11:33.000Z",
                        "custom_key_entity_type__v": "EMPLOYEE__C",
                        "custom_key_status__v": "A",
                        "status_update_time__v": "2018-12-07T08:11:33.000Z"
                    }
                ],
                "addresses__v": [
                    {
                        "nwk_primary_address__c": "Y",
                        "address_line_1__v": "200 Park Blvd.",
                        "record_owner_type__v": "LOCAL",
                        "record_delta_id__v": "933580259020275711",
                        "record_owner_name__v": "Local",
                        "locality__v": "San Diego",
                        "country__v": "US",
                        "created_date__v": "2018-12-07T08:11:33.000Z",
                        "is_veeva_master__v": false,
                        "status_update_time__v": "2018-12-07T08:11:33.000Z",
                        "address_type__v": "P",
                        "entity_type__v": "EMPLOYEE__C",
                        "address_verification_status__v": "DS",
                        "address_status__v": "A",
                        "modified_date__v": "2018-12-07T08:11:33.000Z",
                        "record_state__v": "VALID",
                        "vid__v": "933580259012116864",
                        "entity_vid__v": "933580259012116863",
                        "postal_code__v": "91915",
                        "administrative_area__v": "US-CA",
                        "formatted_address__v": "200 Park Blvd. San Diego US-CA 91915",
                        "address_ordinal__v": 1,
                        "custom_keys__v": []
                    }
                ],
                "employee_account_rel_rel_set__c": [
                    {
                        "employee_account_rel_rel_status__c": "A",
                        "related_entity_type__v": "HCO",
                        "record_owner_type__v": "LOCAL",
                        "status_update_time__v": "2018-12-07T08:11:33.000Z",
                        "related_entity_vid__v": "242976972248974337",
                        "related_entity_name__v": "Kindred Hospital San Diego",
                        "record_delta_id__v": "933580259020275712",
                        "entity_type__v": "EMPLOYEE__C",
                        "record_owner_name__v": "Local",
                        "modified_date__v": "2018-12-07T08:11:33.000Z",
                        "record_state__v": "VALID",
                        "is_primary_relationship__v": "N",
                        "vid__v": "933580259012116865",
                        "entity_vid__v": "933580259012116863",
                        "created_date__v": "2018-12-07T08:11:33.000Z",
                        "is_veeva_master__v": false,
                        "custom_keys__v": []
                    }
                ]
            }
        }
    ]
}

This API enables you to obtain information on any entity without identifying the specific entity type. This API is only used to retrieve information from Network using the GET method.

Note that this API downloads the record for the specified entity from Veeva OpenData to your customer instance.

Compatibility

This API uses the GET HTTP method and is available in the following:

Syntax

https://<DNS>/api/<version>/entity/<vid_key>

where:

Parameters

systemName (optional): If provided, Network returns target alias values specified for reference value codes for the system. If system is not provided, Network returns default reference value codes.

Sample request

GET https://my.veevanetwork.com/api/v16.0/entity/Network:Entity:63259874100112525

Response

responseStatus: The status of the response from Network.

entities - An array of attribute information objects:

Retrieve Child Entity

Sample response

{
  "responseStatus": "SUCCESS",
  "entities": [
    {
      "entityId": "847332583464240130",
      "entityType": "ADDRESS",
      "metaData": {},
      "entity": {
        "record_state__v": "VALID",
        "delivery_address_1__v": "愚园路786号",
        "thoroughfare_name__v": "愚园",
        "premise_number__v": "786号",
        "postal_code__v": "50",
        "administrative_area__v": "CN-SH",
        "ISO_3166_n__v": "156",
        "thoroughfare_trailing_type__v": "路",
        "delivery_address__v": "愚园路786号",
        "sub_administrative_area__v": "长宁区",
        "is_veeva_master__v": true,
        "dpv_confirmed_indicator__v": "X",
        "premise__v": "786号",
        "entity_vid__v": "847332077438239745",
        "ISO_3166_3__v": "CHN",
        "status_update_time__v": "2016-02-08T14:47:57.000-08:00",
        "thoroughfare__v": "愚园路",
        "address_line_2__v": "Shanghai上海市愚园路786号",
        "created_date__v": "2016-02-08T14:47:57.000-08:00",
        "address_verification_status__v": "A",
        "vid__v": "847332583464240130",
        "postal_code_primary__v": "50",
        "formatted_address__v": "50 Shanghai上海市愚园路786号",
        "address_line_1__v": "50",
        "entity_type__v": "HCO",
        "country__v": "CN",
        "modified_date__v": "2016-02-08T14:47:57.000-08:00",
        "address_ordinal__v": 1,
        "locality__v": "上海市",
        "address_status__v": "A",
        "record_delta_id__v": "847390011362903043"
      }
    }
  ]
}

This API enables you to obtain information on any child entity (such as address or license) without identifying the specific entity type. This API is only used to retrieve information from Network using the GET method.

Compatibility

This API uses the GET HTTP method and is available in the following:

Syntax

https://<DNS>/api/<version>/child/<vid_key>

where:

Parameters

systemName (optional): If provided, Network returns target alias values specified for reference value codes for the system. If system is not provided, Network returns default reference value codes.

Sample request

GET https://my.veevanetwork.com/api/v16.0/child/Network:Address:847332583464240130

Response

responseStatus: The status of the response from Network.

entities - An array of attribute information objects:

Notes

Batch Retrieve Entities

Post data:

{
  "entities": [
    {
      "vid_key": "Network:Entity:330476099081339904"
    },
    {
      "vid_key": "Network:Entity:330476022510126080"
    },
    {
      "vid_key": "Network:Entity:330476022510126099"
    }
  ],
  "systemName": "VCRM:Account:001000sdfdsf"
}

Sample response

{
  "responseStatus": "PARTIAL_SUCCESS",
  "errors": [
    {
      "type": "INVALID_DATA",
      "message": "No entity found with the given Id Network:Entity:330476022510126099"
    }
  ],
  "entities": [
    {
      "entityType": "HCP",
      "metaData": {},
      "entity": {
        "attribute 1": "Value 1",
        "attribute 2": "Value 2",
        " ... ": " ... ",
        "custom_keys__v": [
          {
            "attribute 1": "Value 1",
            "attribute 2": "Value 2",
            " ... ": " ... "
          }
        ],
        "addresses__v": [
          {
            "attribute 1": "Value 1",
            "attribute 2": "Value 2",
            " ... ": " ... ",
            "custom_keys__v": [
              {
                "attribute 1": "Value 1",
                "attribute 2": "Value 2",
                " ... ": " ... "
              }
            ]
          }
        ],
        "licenses__v": [
          {
            "attribute 1": "Value 1",
            "attribute 2": "Value 2",
            " ... ": " ... ",
            "custom_keys__v": [
              {
                "attribute 1": "Value 1",
                "attribute 2": "Value 2",
                " ... ": " ... "
              }
            ]
          }
        ],
        "parent_hcos__v": [
          {
            "attribute 1": "Value 1",
            "attribute 2": "Value 2",
            " ... ": " ... ",
            "custom_keys__v": [
              {
                "attribute 1": "Value 1",
                "attribute 2": "Value 2",
                " ... ": " ... "
              }
            ]
          }
        ]
      }
    }
  ]
}

This API enables you to obtain information about entities directly from Network through the API. Users are only allow the retrieve (GET) information from Network. All other operations (POST and DELETE) are restricted and can only be performed by submitting a change request using the Change Request APIs.

Compatibility

This API uses the POST HTTP method and is available in the following:

Syntax

https://<DNS>/api/<version>/entities/batch

where:

POST data

entities (required): An array of attribute information objects, including vid_key.

systemName (optional): If provided, Network returns target alias values specified for reference value codes for the system. If system is not provided, Network returns default reference value codes.

Sample request

POST https://my.network.com/api/v16.0/entities/batch

Response

responseStatus: The status of the response from Network.

errors - An array of attribute information objects:

entities - An array of attribute information objects:

Notes

Batch Retrieve Child Entities

Post data:

{
  "entities": [
    {
      "vid_key": "Network:Entity:330476099081339904"
    },
    {
      "vid_key": "Network:Entity:330476022510126080"
    },
    {
      "vid_key": "Network:Entity:330476022510126099"
    }
  ],
  "systemName": "VCRM:Account:001000sdfdsf"
}

Sample response

{
   "responseStatus": "PARTIAL_SUCCESS",
   "errors": [
     {
       "type": "INVALID_DATA",
       "message": "No entity found with the given Id
 Network:License:847329970740003846xx"
     }
   ],
   "entities": [
     {
       "entityId": "847332542603330562",
       "entityType": "LICENSE",
       "metaData": {},
       "entity": {
         "record_state__v": "VALID",
         "entity_vid__v": "847332072858059779",
         "status_update_time__v": "2016-02-08T14:47:57.000-08:00",
         "created_date__v": "2016-02-08T14:47:57.000-08:00",
         "vid__v": "847332542603330562",
         "entity_type__v": "HCP",
         "license_status__v": "A",
         "modified_date__v": "2016-02-08T14:47:57.000-08:00",
         "license_number__v": "210441581000032",
         "type__v": "PLC",
         "record_delta_id__v": "847390010448544774",
         "is_veeva_master__v": true
       }
     },
     {
       "entityId": "847332583464240130",
       "entityType": "ADDRESS",
       "metaData": {},
       "entity": {
         "record_state__v": "VALID",
         "delivery_address_1__v": "愚园路786号",
         "thoroughfare_name__v": "愚园",
         "premise_number__v": "786号",
         "postal_code__v": "50",
         "administrative_area__v": "CN-SH",
         "ISO_3166_n__v": "156",
         "thoroughfare_trailing_type__v": "路",
         "delivery_address__v": "愚园路786号",
         "sub_administrative_area__v": "长宁区",
         "is_veeva_master__v": true,
         "dpv_confirmed_indicator__v": "X",
         "premise__v": "786号",
         "entity_vid__v": "847332077438239745",
         "ISO_3166_3__v": "CHN",
         "status_update_time__v": "2016-02-08T14:47:57.000-08:00",
         "thoroughfare__v": "愚园路",
         "address_line_2__v": "Shanghai上海市愚园路786号",
         "created_date__v": "2016-02-08T14:47:57.000-08:00",
         "address_verification_status__v": "A",
         "vid__v": "847332583464240130",
         "postal_code_primary__v": "50",
         "formatted_address__v": "50 Shanghai上海市愚园路786号",
         "address_line_1__v": "50",
         "entity_type__v": "HCO",
         "country__v": "CN",
         "modified_date__v": "2016-02-08T14:47:57.000-08:00",
         "address_ordinal__v": 1,
         "locality__v": "上海市",
         "address_status__v": "A",
         "record_delta_id__v": "847390011362903043"
       }
     }
   ]
 }

This API enables you to obtain information on child entities without identifying the specific entity type.

Compatibility

This API uses the POST HTTP method and is available in the following:

Syntax

https://<DNS>/api/<version>/children/batch

where:

POST data

entities (required): An array of attribute information objects, including vid_key (required), which is the external HCP or HCO vid_key supplied by the client.

systemName (optional): If provided, Network returns target alias values specified for reference value codes for the system. If system is not provided, Network returns default reference value codes.

Sample request

POST https://my.network.com/api/v16.0/children/batch

Response

responseStatus: The status of the response from Network.

errors - An array of attribute information objects:

entities - An array of attribute information objects:

Notes

Health care organization (HCO)

Compatibility: Network Customer Master

The health care organization API enable you to retrieve HCO information and associate custom keys with or disassociate them from other entities.

Retrieve HCO

Sample response

{
  "responseStatus": "SUCCESS",
  "entities": [
    {
      "entityId": "505659322685034498",
      "entityType": "HCO",
      "metaData": {},
      "entity": {
        "attribute 1": "Value 1",
        "attribute 2": "Value 2",
        " ... ": " ... ",
        "custom_keys__v": [
          {
            "attribute 1": "Value 1",
            "attribute 2": "Value 2",
            " ... ": " ... "
          }
        ],
        "addresses__v": [
          {
            "attribute 1": "Value 1",
            "attribute 2": "Value 2",
            " ... ": " ... ",
            "custom_keys__v": [
              {
                "attribute 1": "Value 1",
                "attribute 2": "Value 2",
                " ... ": " ... "
              }
            ]
          }
        ],
        "licenses__v": [
          {
            "attribute 1": "Value 1",
            "attribute 2": "Value 2",
            " ... ": " ... ",
            "custom_keys__v": [
              {
                "attribute 1": "Value 1",
                "attribute 2": "Value 2",
                " ... ": " ... "
              }
            ]
          }
        ],
        "parent_hcos__v": [
          {
            "attribute 1": "Value 1",
            "attribute 2": "Value 2",
            " ... ": " ... ",
            "custom_keys__v": [
              {
                "attribute 1": "Value 1",
                "attribute 2": "Value 2",
                " ... ": " ... "
              }
            ]
          }
        ]
      }
    }
  ]
}

This API enables you to retrieve information about an HCO. Information you can retrieve for an HCO includes the HCO, address, license, and parent HCO information (including their custom keys) for the HCO vid_key you provide.

Note that this API downloads the record for the specified entity from Veeva OpenData to your customer instance.

Compatibility

This API uses the GET HTTP method and is available in the following:

Syntax

https://<DNS>/api/<version>/hcos/<vid_key>

where:

Parameters

systemName (optional). Retrieve information for the specified system. If not specified, all information is returned.

Sample request

GET https://my.veevanetwork.com/api/v16.0/hcos/Network:Entity:23541897412569876

Response

responseStatus: The status of the response from Network.

entities - An array of attribute information objects:

Associate custom key to HCO

Sample response

{
   "responseStatus": "SUCCESS"
}

This API enables you to submit external key identifiers when new HCOs are downloaded from Network without going through the full change request process. This API associates the external identifier you submit to the HCO vid_key you provide.

Note: This API requires system administrator or API-only permissions.

Compatibility

This API uses the POST HTTP method and is available in the following:

Syntax

https://<DNS>/api/<version>/hcos/<vid_key>/custom_keys

where:

Parameters

custom_key_source_type (required): The source of the new key.

custom_key_item_type (required): The item type for the new key.

custom_key_value (required): The value for the new key.

system_name (optional): The name of the system for the new key.

Sample request

POST https://my.veevanetwork.com/api/v16.0/hcos/Network:Entity:1325540/custom_keys?custom_key_source_type=VCRM&custom_key_item_type=Account&custom_key_value=789102&system_name=VCRM2

Response

responseStatus: The status of the response from Network.

Associate custom key to HCO address

Sample response

{
   "responseStatus": "SUCCESS"
}

This API enables you to submit external key identifiers when new HCO addresses are downloaded from Network without going through the full change request process. This API associates the external identifier you submit to the HCO address_key you provide.

Note: This API requires system administrator or API-only permissions.

Compatibility

This API uses the POST HTTP method and is available in the following:

Syntax

https://<DNS>/api/<version>/hcos/<vid_key>/addresses/<address_key>/custom_keys

where:

Parameters

custom_key_source_type (required): The source of the new key.

custom_key_item_type (required): The item type for the new key.

custom_key_value (required): The value for the new key.

system_name (optional): The name of the system for the new key.

Sample request

POST https://my.veevanetwork.com/api/v16.0/hcos/myveevanetwork:HCO:1325540/addresses/Network:Address:1791798/custome_keys?custom_key_source_type=VCRM&custom_key_item_type=Address&custom_key_value=789102&system_name=VCRM2

Response

responseStatus: The status of the response from Network.

Associate custom key to HCO license

Sample response

{
   "responseStatus": "SUCCESS"
}

This API enables you to submit external key identifiers when new HCO licenses are downloaded from Network without going through the full change request process. This API associates the external identifier you submit to the HCO license_key you provide.

Note: This API requires system administrator or API-only permissions.

Compatibility

This API uses the POST HTTP method and is available in the following:

Syntax

https://<DNS>/api/<version>/hcos/<vid_key>/licenses/<license_key>/custom_keys

where:

Parameters

custom_key_source_type (required): The source of the new key.

custom_key_item_type (required): The item type for the new key.

custom_key_value (required): The value for the new key.

system_name (optional): The name of the system for the new key.

Sample request

POST https://my.veevanetwork.com/api/v16.0/hcos/myveevanetwork:HCO:1325540/licenses/Network:License:6044433/custome_keys?custom_key_source_type=VCRM&custom_key_item_type=License&custom_key_value=789102&system_name=VCRM2

Response

responseStatus: The status of the response from Network.

Associate custom key to HCO parent HCO

Sample response

{
   "responseStatus": "SUCCESS"
}

This API enables you to submit external key identifiers when new HCO parent HCOs are downloaded from Network without going through the full change request process. This API associates the external identifier you submit to the HCO parenthco_key you provide.

Note: This API requires system administrator or API-only permissions.

Compatibility

This API uses the POST HTTP method and is available in the following:

Syntax

https://<DNS>/api/<version>/hcos/<vid_key>/parent_hcos/<parenthco_key>/custom_keys where:

Parameters

custom_key_source_type (required): The source of the new key.

custom_key_item_type (required): The item type for the new key.

custom_key_value (required): The value for the new key.

system_name (optional): The name of the system for the new key.

Sample request

POST https://my.veevanetwork.com/api/v16.0/hcos/myveevanetwork:HCO:1325540/parent_hcos/Network:ParentHCO:6044433/custome_keys?custom_key_source_type=VCRM&custom_key_item_type=ChildAccount&custom_key_value=789102&system_name=VCRM2

Response

responseStatus: The status of the response from Network.

Health care professional (HCP)

Compatibility: Network Customer Master

The health care professional API enable you to retrieve HCP information and associate custom keys with or disassociate them from other entities.

Retrieve HCP

Sample response

{
  "responseStatus": "SUCCESS",
  "entities": [
    {
      "entityId": "505659322685034497",
      "entityType": "HCP",
      "metaData": {},
      "entity": {
        "attribute 1": "Value 1",
        "attribute 2": "Value 2",
        " ... ": " ... ",
        "custom_keys__v": [
          {
            "attribute 1": "Value 1",
            "attribute 2": "Value 2",
            " ... ": " ... "
          }
        ],
        "addresses__v": [
          {
            "attribute 1": "Value 1",
            "attribute 2": "Value 2",
            " ... ": " ... ",
            "custom_keys__v": [
              {
                "attribute 1": "Value 1",
                "attribute 2": "Value 2",
                " ... ": " ... "
              }
            ]
          }
        ],
        "licenses__v": [
          {
            "attribute 1": "Value 1",
            "attribute 2": "Value 2",
            " ... ": " ... ",
            "custom_keys__v": [
              {
                "attribute 1": "Value 1",
                "attribute 2": "Value 2",
                " ... ": " ... "
              }
            ]
          }
        ],
        "parent_hcos__v": [
          {
            "attribute 1": "Value 1",
            "attribute 2": "Value 2",
            " ... ": " ... ",
            "custom_keys__v": [
              {
                "attribute 1": "Value 1",
                "attribute 2": "Value 2",
                " ... ": " ... "
              }
            ]
          }
        ]
      }
    }
  ]
}

This API enables you to retrieve information about an HCP. Information you can retrieve for an HCP includes the HCP, address, license, and parent HCO information (including their custom keys) for the HCP vid_key you provide.

Note that this API downloads the record for the specified entity from Veeva OpenData to your customer instance.

Compatibility

This API uses the GET HTTP method and is available in the following:

Syntax

https://<DNS>/api/<version>/hcps/<vid_key>

where:

Parameters

systemName (optional). Retrieve information for the specified system. If not specified, all information is returned.

Sample request

GET https://my.veevanetwork.com/api/v16.0/hcps/Network:Entity:63259874100112525

Response

responseStatus: The status of the response from Network.

entities - An array of attribute information objects:

Associate custom key to HCP

Sample response

{
   "responseStatus": "SUCCESS"
}

This API enables you to submit external key identifiers when new HCPs are downloaded from Network without going through the full change request process. This API associates the external identifier you submit to the HCP vid_key you provide.

Note: This API requires system administrator or API-only permissions.

Compatibility

This API uses the POST HTTP method and is available in the following:

Syntax

https://<DNS>/api/<version>/hcps/<vid_key>/custom_keys

where:

Parameters

custom_key_source_type (required): The source of the new key.

custom_key_item_type (required): The item type for the new key.

custom_key_value (required): The value for the new key.

system_name (optional): The name of the system for the new key.

Sample request

POST https://my.veevanetwork.com/api/v16.0/hcps/myveevanetwork:HCP:813873/custom_keys?custom_key_source_type=VCRM&custom_key_item_type=Account&custom_key_value=123456&system_name=VCRM6

Response

responseStatus: The status of the response from Network.

Associate custom key to HCP address

Sample response

{
   "responseStatus": "SUCCESS"
}

This API enables you to submit external key identifiers when new HCP addresses are downloaded from Network without going through the full change request process. This API associates the external identifier you submit to the HCP address_key you provide.

Note: This API requires system administrator or API-only permissions.

Compatibility

This API uses the POST HTTP method and is available in the following:

Syntax

https://<DNS>/api/<version>/hcps/<vid_key>/addresses/<address_key>/custom_keys

where:

Parameters

custom_key_source_type (required): The source of the new key.

custom_key_item_type (required): The item type for the new key.

custom_key_value (required): The value for the new key.

system_name (optional): The name of the system for the new key.

Sample request

POST https://my.veevanetwork.com/api/v16.0/hcps/myveevanetwork:HCP:813873/addresses/Network:Address:954576/custom_keys?custom_key_source_type=VCRM&custom_key_item_type=Address&custom_key_value=123456&system_name=VCRM6

Response

responseStatus: The status of the response from Network.

Associate custom key to HCP license

Sample response

{
   "responseStatus": "SUCCESS"
}

This API enables you to submit external key identifiers when new HCP licenses are downloaded from Network without going through the full change request process. This API associates the external identifier you submit to the HCP license_key you provide.

Note: This API requires system administrator or API-only permissions.

Compatibility

This API uses the POST HTTP method and is available in the following:

Syntax

https://<DNS>/api/<version>/hcps/<vid_key>/licenses/<license_key>/custom_keys

where:

Parameters

custom_key_source_type (required): The source of the new key.

custom_key_item_type (required): The item type for the new key.

custom_key_value (required): The value for the new key.

system_name (optional): The name of the system for the new key.

Sample request

POST https://my.veevanetwork.com/api/v16.0/hcps/myveevanetwork:HCP:813873/licenses/Network:License:89412400/custom_keys?custom_key_source_type=VCRM&custom_key_item_type=License&custom_key_value=123456&system_name=VCRM6

Response

responseStatus: The status of the response from Network.

Associate custom key to HCP parent HCO

Sample response

{
   "responseStatus": "SUCCESS"
}

The Associate custom key to HCP parent HCO API enables you to submit external key identifiers when new HCP parent HCOs are downloaded from Network without going through the full change request process. This API associates the external identifier you submit to the HCP parenthco_key you provide.

Note: This API requires system administrator or API-only permissions.

Compatibility

This API uses the POST HTTP method and is available in the following:

Syntax

https://<DNS>/api/<version>/hcps/<vid_key>/parent_hcos/<parenthco_key>/custom_keys

where:

Parameters

custom_key_source_type (required): The source of the new key.

custom_key_item_type (required): The item type for the new key.

custom_key_value (required): The value for the new key.

system_name (optional): The name of the system for the new key.

Sample request

POST https://my.veevanetwork.com/api/v16.0/hcps/myveevanetwork:HCP:813873/parent_hcos/Network:ParentHCO:6044433/custom_keys?custom_key_source_type=VCRM&custom_key_item_type=ChildAccount&custom_key_value=123456&system_name=VCRM

Response

responseStatus: The status of the response from Network.

Metadata

Metadata enables you to retrieve summary and detailed information about fields, field groups. object types, and reference data. You can also retrieve summary information about each available Network API version.

Retrieve available API versions

Sample response

{
   "responseStatus": "SUCCESS",  
   "values": {
      "v1.0": "https://my.network.com/api/v1.0",
      "v2.0": "https://my.network.com/api/v2.0",
      "v3.0": "https://my.network.com/api/v3.0",
      "v4.0": "https://my.network.com/api/v4.0",
      "v5.0": "https://my.network.com/api/v5.0",
      "v6.0": "https://my.network.com/api/v6.0",
      "v7.0": "https://my.network.com/api/v7.0",
      "v8.0": "https://my.network.com/api/v8.0",
      "v9.0": "https://my.network.com/api/v9.0",
      "v10.0": "https://my.network.com/api/v10.0",
      "v11.0": "https://my.network.com/api/v11.0",
      "v12.0": "https://my.network.com/api/v12.0",
      "v13.0": "https://my.network.com/api/v13.0",
      "v14.0": "https://my.network.com/api/v14.0",
      "v15.0": "https://my.network.com/api/v15.0",
      "v16.0": "https://my.network.com/api/v16.0"
   }
}

This API enables you to retrieve summary information about each API version available in Network.

Compatibility

This API uses the GET HTTP method and is available in the following:

Syntax

https://<DNS>/api

where:

Parameters

None

Sample request

GET https://my.network.com/api

Response

responseStatus: The status of the response from Network.

values: An array of values containing each available version and the version-specific API URL information.

Notes

None

Retrieve object types metadata

Sample response

{
    "responseStatus": "SUCCESS",
    "objectTypes": [
        {
            "name": "HCP",
            "description": "Health Care Professional",
            "status": "ACTIVE",
            "type": "object",
            "customer_defined": false
        },
        {
            "name": "HCO",
            "description": "Health Care Organization",
            "status": "ACTIVE",
            "type": "object",
            "customer_defined": false
        },
        {
            "name": "ADDRESS",
            "description": "Address",
            "status": "ACTIVE",
            "type": "sub-object",
            "customer_defined": false
        },
        {
            "name": "LICENSE",
            "description": "License",
            "status": "ACTIVE",
            "type": "sub-object",
            "customer_defined": false
        },
        {
            "name": "PARENTHCO",
            "description": "Parent HCO",
            "status": "ACTIVE",
            "type": "relationship",
            "customer_defined": false
        },
        {
            "name": "EMPLOYEE_ACCOUNT_REL_REL__C",
            "description": "Employee Account",
            "status": "ACTIVE",
            "type": "relationship",
            "customer_defined": true
        },
        {
            "name": "CUSTOMKEY",
            "description": "Custom Key",
            "status": "ACTIVE",
            "type": "sub-object",
            "customer_defined": false
        },
        {
            "name": "EMPLOYEE__C",
            "description": "Employee",
            "status": "ACTIVE",
            "type": "object",
            "customer_defined": true
        },
        {
            "name": "SCHOOLS__C",
            "description": "School",
            "status": "ACTIVE",
            "type": "object",
            "customer_defined": true
        }
    ]
}

This API enables you to retrieve the list of object types available in Network.

Compatibility

This API uses the GET HTTP method and is available in the following:

Syntax

https://<DNS>/api/<version>/metadata/objectTypes

where:

Parameters

owner (optional): filter objects by customer or veeva owned

Sample request

GET https://my.network.com/api/v16.0/metadata/objectTypes GET https://my.network.com/api/v16.0/metadata/objectTypes?owner=customer

Response

responseStatus: The status of the response from Network.

objectTypes - An array of attribute information objects:

Notes

None

Retrieve fields metadata

Retrieve with no details

{
    "responseStatus": "SUCCESS",
    "attributes": [
        "birth_year__v",
        "specialty_5__v",
        "record_merged_vid__v",
        "birth_state__v",
        "email_2__v",
        "specialty_9__v",
        "last_name__v",
        "upin__v",
        "is_proprietary__v",
        "custom_keys__v",
        "birth_city__v",
        "parent_hcos__v",
        "medical_degree_2__v",
        "status_update_time__v",
        "years_in_progress__v",
        "licenses__v",
        "primary_country__v",
        "sha_id__v",
        "knipper_id__v",
        "specialty_7__v",
        "specialty_4__v",
        "is_externally_mastered__v",
        "hcp_type__v",
        "credentials_3__v",
        "hcp_status__v",
        "ams_id__v",
        "medical_degree_1__v",
        "specialty_2__v",
        "specialty_3__v",
        "grad_school__v",
        "email_4__v",
        "specialty_1__v",
        "specialty_8__v",
        "specialty_1_rank__v",
        "middle_name__v",
        "specialty_8_rank__v",
        "grad_trg_start_date__v",
        "gender__v",
        "first_name__v",
        "URL_2__v",
        "email_10__v",
        "type_of_practice__v",
        "aoa_id__v",
        "is_veeva_master__v",
        "modified_date__v",
        "URL_1__v",
        "specialty_10__v",
        "kaiser__v",
        "email_5__v",
        "specialty_4_rank__v",
        "addresses__v",
        "credentials_5__v",
        "grad_year__v",
        "specialty_2_rank__v",
        "suffix__v",
        "place_of_employment__v",
        "credentials_2__v",
        "ama_do_not_contact__v",
        "record_delta_id__v",
        "record_state__v",
        "specialty_3_rank__v",
        "credentials_4__v",
        "credentials_1__v",
        "mpa__v",
        "npi_num__v",
        "specialty_7_rank__v",
        "pdrp_optout_date__v",
        "fellow__v",
        "master_vid__v",
        "email_1__v",
        "email_6__v",
        "email_7__v",
        "formatted_name__v",
        "specialty_6_rank__v",
        "email_9__v",
        "created_date__v",
        "vid__v",
        "specialty_6__v",
        "prefix__v",
        "specialty_10_rank__v",
        "email_3__v",
        "me_id__v",
        "board_certification__v",
        "grad_trg_end_date__v",
        "pdrp_optout__v",
        "specialty_5_rank__v",
        "education_level__v",
        "email_8__v",
        "cri_id__v",
        "grad_training__v",
        "specialty_9_rank__v",
        "birth_country__v"
    ]
}

Retrieve with full details

{
   "responseStatus": "SUCCESS",
   "attributes": [
      {
         "fieldId": "academic_title__v",
         "type": {
            "dataType": "REFERENCE",
            "discriminator": "HCPAcademicTitle"
         },
         "labels": {
            "zh": "学术职称",
            "en": "Academic Title"
         },
         "customerOwned": false,
         "description": null,
         "readOnly": false,
         "ownerOnlyEdit": false,
         "status": "ACTIVE",
         "fieldGroup": null,
         "fieldSet": null,
         "sinceVersion": "1.0.0",
         "maximumLength": 100,
         "required": false,
         "blankAllowed": true,
         "defaultValue": null,
         "countries": {
            "US": {
               "country": "US",
               "available": false,
               "required": false,
               "readOnly": false,
               "defaultValue": null,
               "allowedObjectTypes": [
                  "HCP"
               ]
            },
            "CN": {
               "country": "CN",
               "available": true,
               "required": false,
               "readOnly": false,
               "defaultValue": null,
               "allowedObjectTypes": [
                  "HCP"
               ]
            }
         },
         "changeProcedure": {
            "defaultChangeProcedure": {
               "changeRequestFlags": {
                  "HCO": "DEFAULT",
                  "HCP": "DEFAULT"
               }
            },
            "regionalChangeProcedures": {
               "AD": {
                  "changeRequestFlags": {
                     "HCP": "ALWAYS_REVIEW"
                  }
               },
               "AT": {
                  "changeRequestFlags": {
                     "HCP": "ALWAYS_REVIEW"
                  }
               }
            }
         }
      },
      {
         "fieldId": "birth_city__v",
         "type": {
            "dataType": "STRING",
            "discriminator": null
         },
         "labels": {
            "en": "Birth City"
         },
         "customerOwned": false,
         "description": null,
         "readOnly": false,
         "ownerOnlyEdit": false,
         "status": "ACTIVE",
         "fieldGroup": null,
         "fieldSet": null,
         "sinceVersion": "1.0.0",
         "maximumLength": 200,
         "required": false,
         "blankAllowed": true,
         "defaultValue": null,
         "countries": {
            "US": {
               "country": "US",
               "available": true,
               "required": false,
               "readOnly": false,
               "defaultValue": null,
               "allowedObjectTypes": [
                  "HCP"
               ]
            },
            "CN": {
               "country": "CN",
               "available": false,
               "required": false,
               "readOnly": false,
               "defaultValue": null,
               "allowedObjectTypes": [
                  "HCP"
               ]
            }
         },
         "changeProcedure": {
            "defaultChangeProcedure": {
               "changeRequestFlags": {
                  "HCO": "DEFAULT",
                  "HCP": "DEFAULT"
               }
            },
            "regionalChangeProcedures": {
               "US": {
                  "changeRequestFlags": {
                     "HCP": "ALWAYS_ACCEPT_CHANGE"
                  }
               },
               "CN": {
                  "changeRequestFlags": {
                     "HCP": "ALWAYS_REVIEW"
                  }
               }
            }
         }
      }
   ]
}

This API enables you to retrieve detailed or summary information about the fields on each entity in Network.

Compatibility

This API uses the GET HTTP method and is available in the following:

Syntax

https://<DNS>/api/<version>/metadata/fields

where:

Parameters

objectTypes (optional). Filter fields to those applicable for certain object types:

owner (optional). Filter fields to those owned by the specified party:

details (optional). Include field details:

labels (optional). Include labels in field details:

fieldGroup (optional). Filter fields to those applicable for a certain field group:

fieldSet (optional). Filter fields to those applicable for a certain field set:

country (optional). Filter fields by country visibility:

countries (optional). Filter fields by country visibility:

Sample request

GET https://my.veevanetwork.com/api/v16.0/metadata/fields?objectTypes=LICENSE (with no details)

GET https://my.veevanetwork.com/api/v16.0/metadata/fields?objectTypes=LICENSE&details=full (with full details)

GET https://my.veevanetwork.com/api/v16.0/metadata/fields?objectTypes=LICENSE&details=full&country=GB (with full details on fields available in GB)

GET https://my.veevanetwork.com/api/v16.0/metadata/fields?objectTypes=LICENSE&details=full&countries=GB,US (with full details on fields available in GB and US)

Response

responseStatus: The status of the response from Network.

attributes - An array attribute of information objects:

Name Description
field_id The ID of the field, for example, first_name__v.
type dataType - The type object, containing two attributes:

  • VEEVAID - an ID used in the Network system
  • STRING - text
  • YEAR - year value (no month or day)
  • DATE - date (no time)
  • DATETIME - date + Time (timestamp)
  • NUMBER - integer number
  • DOUBLE - floating point number
  • BOOLEAN - True or False value
  • REFERENCE - reference code
  • SET - a collection of values

discriminator - For reference data type, include the reference data type name

labels Set of language to description pairs (unless labels is not equal to “true” or empty).
customerOwned True if this is a custom field, false otherwise.
description Non-localized text description of field.
readOnly True if this is a read-only attribute, false otherwise.
ownerOnlyEdit True if this attribute can only be edited when owned by the customer. Cannot modify these attributes in Veeva OpenData records.
status One of ACTIVE, DELETED, or DEACTIVATED.
fieldGroup Either null or the name of the group for this attribute.
fieldSet Either null or the name of the field set for this attribute.
sinceVersion The Network version of when the attribute was released, for example, 1.0.0 or 1.5.2.
maximumLength The recommended maximum length for this attribute.
required True if this is a required attribute, false otherwise.
blankAllowed True if this attribute can be blank, false otherwise.
defaultValue The default value of this attribute.
expression NEX (Network Expression) rule that is evaluated to determine the value of this attribute
expressionFlag Bitwise OR of flags that describe when the expression is evaluated (1=evaluate on any value change, 2=evaluate on any attribute value change, 4=evaluate only if current value is not set)
dataPrivacyFlag The value that will be included in fields when the HCP record is marked as opted out. Current values:

  • NONE - No data privacy is applied to the field.
  • MASK_WITH_BLANK - The field value is replaced with a blank or null.
  • MASK_WITH_LABEL - The field value is replaced with a localized label: “Data Privacy”/“Client Data Privacy”

countries The country code. Current values:

  • country - The country code name

  • available - a true/false value that indicates whether the field is available for a particular country

  • required - a true/false value that indicates whether the field is required when creating a new record for a particular country

  • readOnly - a true/false value that indicates whether the field is read-only for a particular country

  • defaultValue - a true/false value that indicates the default value if NULL is provided when creating a new record for a particular country

  • expression - NEX (Network Expression) rule that is evaluated to determine the value of this attribute

  • expressionFlags - bitwise OR of flags that describe when the expression is evaluated (1=evaluate on any value change, 2=evaluate on any attribute value change, 4=evaluate only if current value is not set)

  • allowedObjectTypes - an array of allowed types (from HCP, HCO, ADDRESS, LICENSE, PARENTHCO, CUSTOMKEY) for a particular country

  • changeProcedure This field replaces the deprecated changeRequest flag. This value can be configured per region and entity. For each of defaultChangeProcedure (default change procedure for the attribute) and regionalChangeProcedures (change procedures per region), the current values are as follows:

  • DEFAULT - let the system decide what to do

  • ALWAYS_ACCEPT_CHANGE - any changes will be automatically accepted without data steward review

  • ALWAYS_REVIEW - any changes to this field must be reviewed by a data steward

  • Notes

    Retrieve field details metadata

    Sample response

    {
       "responseStatus": "SUCCESS",
       "attributes": [
          {
             "fieldId": "academic_title__v",
             "type": {
                "dataType": "REFERENCE",
                "discriminator": "HCPAcademicTitle"
             },
             "labels": {
                "zh": "学术职称",
                "en": "Academic Title"
             },
             "customerOwned": false,
             "description": null,
             "readOnly": false,
             "ownerOnlyEdit": false,
             "status": "ACTIVE",
             "fieldGroup": null,
             "fieldSet": null,
             "sinceVersion": "1.0.0",
             "maximumLength": 100,
             "required": false,
             "blankAllowed": true,
             "defaultValue": null,
             "countries": {
                "US": {
                   "country": "US",
                   "available": false,
                   "required": false,
                   "readOnly": false,
                   "defaultValue": null,
                   "allowedObjectTypes": [
                      "HCP"
                   ]
                },
                "CN": {
                   "country": "CN",
                   "available": true,
                   "required": false,
                   "readOnly": false,
                   "defaultValue": null,
                   "allowedObjectTypes": [
                      "HCP"
                   ]
                }
             },
             "changeProcedure": {
                "defaultChangeProcedure": {
                   "changeRequestFlags": {   
                      "HCO": "DEFAULT",
                      "HCP": "DEFAULT"
                   }
                },
                "regionalChangeProcedures": {
                   "US": {
                      "changeRequestFlags": {
                         "HCP": "ALWAYS_ACCEPT_CHANGE"
                      }
                   },
                   "CN": {
                      "changeRequestFlags": {
                         "HCP": "ALWAYS_REVIEW"
                      }
                   }
                }
             }
          }
       ]
    }
    

    This API enables you to retrieve detailed information about the fields on each entity in Network.

    Compatibility

    This API uses the GET HTTP method and is available in the following:

    Syntax

    https://<DNS>/api/<version>/metadata/fields/<field_ids>

    where:

    Parameters

    labels (optional): Include labels in field details:

    countries (optional): Filter fields by country visibility:

    Sample request

    GET https://my.network.com/api/v16.0/metadata/fields/academic_title__v

    Response

    responseStatus: The status of the response from Network.

    objectTypes - An array of attribute information objects:

    attributes - An array attribute of information objects:

    Name Description
    field_id The ID of the field, for example, first_name__v.
    type dataType - The type object, containing two attributes:

    • VEEVAID - an ID used in the Network system
    • STRING - text
    • YEAR - year value (no month or day)
    • DATE - date (no time)
    • DATETIME - date + Time (timestamp)
    • NUMBER - integer number
    • DOUBLE - floating point number
    • BOOLEAN - True or False value
    • REFERENCE - reference code
    • SET - a collection of values

    discriminator - For reference data type, include the reference data type name

    labels Set of language to description pairs (unless labels is not equal to “true” or empty).
    customerOwned True if this is a custom field, false otherwise.
    description Non-localized text description of field.
    readOnly True if this is a read-only attribute, false otherwise.
    ownerOnlyEdit True if this attribute can only be edited when owned by the customer. Cannot modify these attributes in Veeva OpenData records.
    status One of ACTIVE, DELETED, or DEACTIVATED.
    fieldGroup Either null or the name of the group for this attribute.
    fieldSet Either null or the name of the field set for this attribute.
    sinceVersion The Network version of when the attribute was released, for example, 1.0.0 or 1.5.2.
    maximumLength The recommended maximum length for this attribute.
    required True if this is a required attribute, false otherwise.
    blankAllowed True if this attribute can be blank, false otherwise.
    defaultValue The default value of this attribute.
    expression NEX (Network Expression) rule that is evaluated to determine the value of this attribute
    expressionFlag Bitwise OR of flags that describe when the expression is evaluated (1=evaluate on any value change, 2=evaluate on any attribute value change, 4=evaluate only if current value is not set)
    dataPrivacyFlag The value that will be included in fields when the HCP record is marked as opted out. Current values:

    • NONE - No data privacy is applied to the field.
    • MASK_WITH_BLANK - The field value is replaced with a blank or null.
    • MASK_WITH_LABEL - The field value is replaced with a localized label: “Data Privacy”/“Client Data Privacy”

    countries The country code. Current values:

  • country - The country code name

  • available - a true/false value that indicates whether the field is available for a particular country

  • required - a true/false value that indicates whether the field is required when creating a new record for a particular country

  • readOnly - a true/false value that indicates whether the field is read-only for a particular country

  • defaultValue - a true/false value that indicates the default value if NULL is provided when creating a new record for a particular country

  • expression - NEX (Network Expression) rule that is evaluated to determine the value of this attribute

  • expressionFlags - bitwise OR of flags that describe when the expression is evaluated (1=evaluate on any value change, 2=evaluate on any attribute value change, 4=evaluate only if current value is not set)

  • allowedObjectTypes - an array of allowed types (from HCP, HCO, ADDRESS, LICENSE, PARENTHCO, CUSTOMKEY) for a particular country

  • changeProcedure This field replaces the deprecated changeRequest flag. This value can be configured per region and entity.

    For each of defaultChangeProcedure (default change procedure for the attribute) and regionalChangeProcedures (change procedures per region), the current values are as follows:

    • DEFAULT - let the system decide what to do
    • ALWAYS_ACCEPT_CHANGE - any changes will be automatically accepted without data steward review
    • ALWAYS_REVIEW - any changes to this field must be reviewed by a data steward

    Notes

    None

    Retrieve field groups metadata

    Sample response

    {
       "responseStatus": "SUCCESS",
       "fieldGroups": [
          "credentials",
          "medical_degree",
          "specialty"
       ]
    }
    

    This API enables you to retrieve detailed information about the field groups available in Network. These field groups are used by the CRM bridge when retrieving and displaying information from Network in CRM.

    Compatibility

    This API uses the GET HTTP method and is available in the following:

    Syntax

    https://<DNS>/api/<version>/metadata/fieldGroups

    where:

    Parameters

    None

    Sample request

    GET https://my.network.com/api/v16.0/metadata/fieldGroups

    Response

    responseStatus: The status of the response from Network.

    fieldGroups: An array of field groups.

    Notes

    None

    Retrieve reference data types metadata

    Sample response

    {
        "responseStatus": "SUCCESS",
        "reference_type_values": [
            {
                "type": "AddressAdminArea",
                "customerOwned": false,
                "inactive": false,
                "description": "AddressAdminArea"
            },
            {
                "type": "AddressCBSA",
                "customerOwned": false,
                "inactive": false,
                "description": "Core Based Statistical Area"
            },
            {
                "type": "AddressCountry",
                "customerOwned": false,
                "inactive": false,
                "description": "AddressCountry"
            },
            {
                "type": "AddressDPVConfIndicator",
                "customerOwned": false,
                "inactive": false,
                "description": "AddressDPVConfIndicator"
            },
            {
                "type": "AddressDPVFootnotes",
                "customerOwned": false,
                "inactive": false,
                "description": "AddressDPVFootnotes"
            },
            {
                "type": "AddressFootnotes",
                "customerOwned": false,
                "inactive": false,
                "description": "AddressFootnotes"
            },
            {
                "type": "AddressISO31663",
                "customerOwned": false,
                "inactive": false,
                "description": "AddressISO31663"
            },
            {
                "type": "AddressISO3166n",
                "customerOwned": false,
                "inactive": false,
                "description": "AddressISO3166n"
            },
            {
                "type": "AddressRecordType",
                "customerOwned": false,
                "inactive": false,
                "description": "AddressRecordType"
            },
            {
                "type": "AddressReturnCode",
                "customerOwned": false,
                "inactive": false,
                "description": "AddressReturnCode"
            },
            {
                "type": "AddressStatus",
                "customerOwned": false,
                "inactive": false,
                "description": "AddressStatus"
            },
            {
                "type": "AddressType",
                "customerOwned": false,
                "inactive": false,
                "description": "Is this a mail or professional address or both"
            },
            {
                "type": "AddressVerificationStatus",
                "customerOwned": false,
                "inactive": false,
                "description": "AddressVerificationStatus"
            },
            {
                "type": "BooleanReference",
                "customerOwned": false,
                "inactive": false,
                "description": "Boolean Values"
            },
            {
                "type": "Currency",
                "customerOwned": false,
                "inactive": false,
                "description": "Currency"
            },
            {
                "type": "EntityType",
                "customerOwned": false,
                "inactive": false,
                "description": "Type of entities in the system"
            },
            {
                "type": "HCOCLIAStatus",
                "customerOwned": false,
                "inactive": false,
                "description": "CLIA Status"
            },
            {
                "type": "HCOHospitalGrade",
                "customerOwned": false,
                "inactive": false
            },
            {
                "type": "HCOMedicaidPercentage",
                "customerOwned": false,
                "inactive": false,
                "description": "Percentage of medicaid patients in the practice"
            },
            {
                "type": "HCOMedicarePercentage",
                "customerOwned": false,
                "inactive": false,
                "description": "Percentage of medicare patients in the practice"
            },
            {
                "type": "HCOStatus",
                "customerOwned": false,
                "inactive": false,
                "description": "Status of HCO"
            },
            {
                "type": "HCOType",
                "customerOwned": false,
                "inactive": false,
                "description": "Type of HCO"
            },
            {
                "type": "HCPAcademicTitle",
                "customerOwned": false,
                "inactive": false
            },
            {
                "type": "HCPBoardCertification",
                "customerOwned": false,
                "inactive": false,
                "description": "Board Certification"
            },
            {
                "type": "HCPCredentials",
                "customerOwned": false,
                "inactive": false,
                "description": "Credentials for an HCP"
            },
            {
                "type": "HCPEducationLevel",
                "customerOwned": false,
                "inactive": false,
                "description": "Level of education for an HCP"
            },
            {
                "type": "HCPGender",
                "customerOwned": false,
                "inactive": false,
                "description": "Gender"
            },
            {
                "type": "HCPMajorAreaofStudy",
                "customerOwned": false,
                "inactive": false
            },
            {
                "type": "HCPMajorProfActivity",
                "customerOwned": false,
                "inactive": false,
                "description": "Major Professional Activity"
            },
            {
                "type": "HCPMedicalDegree",
                "customerOwned": false,
                "inactive": false,
                "description": "Degrees"
            },
            {
                "type": "HCPPlaceOfEmployment",
                "customerOwned": false,
                "inactive": false,
                "description": "Place of Employment"
            },
            {
                "type": "HCPPracticeType",
                "customerOwned": false,
                "inactive": false,
                "description": "Type of practice for an HCP"
            },
            {
                "type": "HCPPrefix",
                "customerOwned": false,
                "inactive": false,
                "description": "HCPPrefix"
            },
            {
                "type": "HCPProfessionalLevel",
                "customerOwned": false,
                "inactive": false
            },
            {
                "type": "HCPProfessionalTitle",
                "customerOwned": false,
                "inactive": false
            },
            {
                "type": "HCPStatus",
                "customerOwned": false,
                "inactive": false,
                "description": "HCP Statuses"
            },
            {
                "type": "HCPType",
                "customerOwned": false,
                "inactive": false,
                "description": "HCPType"
            },
            {
                "type": "KeyStatus",
                "customerOwned": false,
                "inactive": false,
                "description": "Key Statuses"
            },
            {
                "type": "LicenseDEACode",
                "customerOwned": false,
                "inactive": false,
                "description": "License DEA Business Activity Code"
            },
            {
                "type": "LicenseEligibility",
                "customerOwned": false,
                "inactive": false,
                "description": "License Eligibility"
            },
            {
                "type": "LicenseStatus",
                "customerOwned": false,
                "inactive": false,
                "description": "Status of a License"
            },
            {
                "type": "LicenseType",
                "customerOwned": false,
                "inactive": false,
                "description": "Type/Scope of license"
            },
            {
                "type": "LicensingBody",
                "customerOwned": false,
                "inactive": false
            },
            {
                "type": "MajorClassofTrade",
                "customerOwned": false,
                "inactive": false
            },
            {
                "type": "RecordState",
                "customerOwned": false,
                "inactive": false,
                "description": "State of the record in the Veeva system"
            },
            {
                "type": "RelationHierarchyType",
                "customerOwned": false,
                "inactive": false,
                "description": "RelationHierarchyType"
            },
            {
                "type": "RelationParentType",
                "customerOwned": false,
                "inactive": false,
                "description": "RelationParentType"
            },
            {
                "type": "RelationStatus",
                "customerOwned": false,
                "inactive": false,
                "description": "Relationship Statuses"
            },
            {
                "type": "RelationStatusReason",
                "customerOwned": false,
                "inactive": false
            },
            {
                "type": "RelationType",
                "customerOwned": false,
                "inactive": false,
                "description": "RelationType"
            },
            {
                "type": "Specialty",
                "customerOwned": false,
                "inactive": false,
                "description": "Specialties"
            }
        ]
    }
    

    This API enables you to retrieve information about reference data types in Network.

    Compatibility

    This API uses the GET HTTP method and is available in the following:

    Syntax

    https://<DNS>/api/<version>/metadata/reference_values

    where:

    Parameters

    owner (optional) - Filter reference types to those owned by the specified party:

    inactive (optional) - Include reference codes marked as inactive:

    includeCodes (optional):

    country (optional) - Filter codes by country, only if includeCodes is true:

    countries (optional) - Filter fields by country visibility:

    systemName (optional) - Return target alias values specified for reference value codes for this system:

    Sample request

    GET https://my.veevanetwork.com/api/v16.0/metadata/reference_values (without codes)

    GET https://my.veevanetwork.com/api/v16.0/metadata/reference_values?includeCodes=true&country=GB (with codes in particular country)

    GET https://my.veevanetwork.com/api/v16.0/metadata/reference_values?includeCodes=true&countries=GB,FR (with codes in GB and FR country)

    Response

    responseStatus: The status of the response from Network.

    reference_type_values - A single object containing information on the type and its codes:

    Name Description
    type The reference type name, for example, Country.
    customerOwned True if this is a customer created reference type, false otherwise.
    inactive True if this reference type has been inactivated.
    description Non-localized text description of the reference type.
    reference_type_codes Array of reference code objects if includeCodes is true:

    • type - the reference type value of the code, for example, Country
    • code - the reference code value
    • values - an array of language/value pairs. Each reference item has its textual value provided in a set of translations. This array can be used to determine which languages are supported and the value for each language.
      For example: [{“en”:“Canada”},{“zh”:“加拿大”},{“fr”:“Canada”},{“de”:“Kanada”}]. Language codes are IETF language tags.

    • customerOwned - true if this is a customer created reference code, false otherwise

    • inactive - true if this reference type has been inactivated

    • countries - list of countries for which the code is visible, for example, US or GB.

    Notes

    Retrieve reference data type details metadata

    Sample response

    {
      "responseStatus": "SUCCESS",
      "type": "Specialty",
      "customerOwned": false,
      "inactive": false,
      "description": "Specialties",
      "reference_type_codes": [
        {
          "type": "Specialty",
          "code": "AR",
          "values": {
            "en": "Abdominal Radiology"
          },
          "customerOwned": false,
          "inactive": false,
          "countries": [
            "US"
          ]
        },
        {
          "type": "Specialty",
          "code": "AS",
          "values": {
            "en": "Abdominal Surgery"
          },
          "customerOwned": false,
          "inactive": false,
          "countries": [
            "US"
          ]
        },
        {
          "type": "Specialty",
          "code": "ACU",
          "values": {
            "en": "Acupuncture"
          },
          "customerOwned": false,
          "inactive": false,
          "countries": [
            "US"
          ]
        },
        {
          "type": "Specialty",
          "code": "AC",
          "values": {
            "en": "Acute Care"
          },
          "customerOwned": false,
          "inactive": false,
          "countries": [
            "US"
          ]
        },
        {
          "type": "Specialty",
          "code": "ACP",
          "values": {
            "en": "Acute Care Pediatrics (APNs only)"
          },
          "customerOwned": false,
          "inactive": false,
          "countries": [
            "US"
          ]
        },
        {
          "type": "Specialty",
          "code": "ADM",
          "values": {
            "en": "Addiction Medicine"
          },
          "customerOwned": false,
          "inactive": false,
          "countries": [
            "US"
          ]
        },
        {
          "type": "Specialty",
          "code": "ADP",
          "values": {
            "en": "Addiction Psychiatry"
          },
          "customerOwned": false,
          "inactive": false,
          "countries": [
            "US"
          ]
        },
        {
          "type": "Specialty",
          "code": "PSU",
          "values": {
            "en": "Addiction Psychology &amp; Counseling"
          },
          "customerOwned": false,
          "inactive": false,
          "countries": [
            "US"
          ]
        },
        {
          "type": "Specialty",
          "code": "AMD",
          "values": {
            "en": "Administrative Medicine"
          },
          "customerOwned": false,
          "inactive": false,
          "countries": [
            "US"
          ]
        },
        {
          "type": "Specialty",
          "code": "AMF",
          "values": {
            "en": "Adolescent Medicine (Family Medicine)"
          },
          "customerOwned": false,
          "inactive": false,
          "countries": [
            "US"
          ]
        },
        {
          "type": "Specialty",
          "code": "AMI",
          "values": {
            "en": "Adolescent Medicine (Internal Medicine)"
          },
          "customerOwned": false,
          "inactive": false,
          "countries": [
            "US"
          ]
        },
        {
          "type": "Specialty",
          "code": "ADL",
          "values": {
            "en": "Adolescent Medicine (Pediatrics)"
          },
          "customerOwned": false,
          "inactive": false,
          "countries": [
            "US"
          ]
        },
        {
          "type": "Specialty",
          "code": "CHD",
          "values": {
            "en": "Adult Congenital Heart Disease (IM)"
          },
          "customerOwned": false,
          "inactive": false,
          "countries": [
            "US"
          ]
        },
        {
          "type": "Specialty",
          "code": "ADU",
          "values": {
            "en": "Adult Health (APNs)"
          },
          "customerOwned": false,
          "inactive": false,
          "countries": [
            "US"
          ]
        },
        {
          "type": "Specialty",
          "code": "OAR",
          "values": {
            "en": "Adult Reconstructive Orthopedics"
          },
          "customerOwned": false,
          "inactive": false,
          "countries": [
            "US"
          ]
        }
      ]
    }
    

    This API enables you to retrieve detailed information about reference data types in Network.

    Compatibility

    This API uses the GET HTTP method and is available in the following:

    Syntax

    https://<DNS>/api/<version>/metadata/reference_values/<type>

    where:

    Parameters

    owner (optional) - Filter reference types to those owned by the specified party:

    inactive (optional) - Include reference types marked as inactive:

    country (optional) - Filter codes by country, only if includeCodes is true:

    countries (optional) - Filter fields by country visibility:

    systemName (optional) - Return target alias values specified for reference value codes for this system.

    Sample request

    GET https://my.veevanetwork.com/api/v16.0/metadata/reference_values/Specialty

    GET https://my.veevanetwork.com/api/v16.0/metadata/reference_values/Specialty?country=GB

    GET https://my.veevanetwork.com/api/v16.0/metadata/reference_values/Specialty?countries=GB,US,FR

    Response

    responseStatus: The status of the response from Network.

    reference_type_values - A single object containing information on the type and its codes:

    Name Description
    type The reference type name, for example, Country.
    customerOwned True if this is a customer created reference type, false otherwise.
    inactive True if this reference type has been inactivated.
    description Non-localized text description of the reference type.
    reference_type_codes Array of reference code objects if includeCodes is true:

    • type - the reference type value of the code, for example, Country
    • code - the reference code value
    • values - an array of language/value pairs. Each reference item has its textual value provided in a set of translations. This array can be used to determine which languages are supported and the value for each language.
      For example: [{“en”:“Canada”},{“zh”:“加拿大”},{“fr”:“Canada”},{“de”:“Kanada”}]. Language codes are IETF language tags.

    • customerOwned - true if this is a customer created reference code, false otherwise

    • inactive - true if this reference type has been inactivated

    • countries - list of countries for which the code is visible, for example, US or GB.

    Notes

    Retrieve reference data type code details metadata

    Sample response

    {
        "responseStatus": "SUCCESS",
        "reference_type_codes": [
            {
                "type": "Specialty",
                "code": "A",
                "values": {
                    "en": "Allergy"
                },
                "customerOwned": false,
                "inactive": false,
                "countries": [
                    "US"
                ]
            }
        ]
    }
    

    This API enables you to retrieve detailed information about reference data type codes in Network.

    Compatibility

    This API uses the GET HTTP method and is available in the following:

    Syntax

    https://<DNS>/api/<version>/metadata/reference_values/<type>/<codes>

    where:

    Parameters

    country (optional) - Filter codes by country, only if includeCodes is true:

    countries (optional) - Filter fields by country visibility:

    systemName (optional) - Return target alias values specified for reference value codes for this system.

    Sample request

    GET https://my.veevanetwork.com/api/v16.0/metadata/reference_values/Specialty/A?country=US

    GET https://my.veevanetwork.com/api/v16.0/metadata/reference_values/Specialty/A?countries=US,GB,FR

    Response

    responseStatus: The status of the response from Network.

    reference_type_codes - A single object containing information on the type and its codes:

    Name Description
    code The reference code value.
    type The reference code name, for example, Country.
    values An array of language/value pairs.

    Each reference item has its textual value provided in a set of translations. This array can be used to determine which languages are supported and the value for each language.

    For example: [{“en”:“Canada”},{“zh”:“加拿大”},{“fr”:“Canada”},{“de”:“Kanada”}] Language codes are IETF language tags.

    customerOwned True if this is a customer created reference type, false otherwise.
    inactive True if this reference type has been inactivated.
    countries A list of countries for which the code is visible, for example, US or GB.

    Notes

    None

    Merge

    Compatibility: Network Customer Master

    Merge enables you to retrieve merges and unmerges for a specified date. This enables downstream systems to receive and process merges and unmerges very quickly after they occur. Previously, downstream systems typically received merges and unmerges using target subscriptions so there was a time lag for this data. The results from each call are limited to 100. If more results are available, you can run subsequent requests using the offset parameter to get additional pages of results.

    Retrieve Merges

    Sample response

    {
      "responseStatus":"SUCCESS",
      "totalCount":2,
      "offset":0,
      "limit":100,
      "sinceDate":"2016-12-31T19:00:00.000-05:00",
      "events":[{
          "type":"MERGE",
          "date":"2017-12-08T14:19:51.000-05:00",
          "entities":[{
              "type":"MERGE_SURVIVOR",
              "entityId":"931521762955172639",
              "entityType":"HCP"
            },
            {
              "type":"MERGE_NONSURVIVOR",
              "entityId":"931521742609390367",
              "entityType":"HCP"
            }
          ]
        },
        {
          "type":"MERGE",
          "date":"2017-12-11T17:09:45.000-05:00",
          "entities":[{
              "type":"MERGE_SURVIVOR",
              "entityId":"931539432462359327",
              "entityType":"HCP"
            },
            {
              "type":"MERGE_NONSURVIVOR",
              "entityId":"931539429690448671",
              "entityType":"HCP"
            }
          ]
        }
      ]
    }
    

    This API enables you to retrieve the results of merge events that occurred in your Network instance. Merges that were initiated by Veeva OpenData on a master instance are included if the surviving and losing record of the merge have been downloaded to your instance.

    Compatibility

    This API uses the GET and POST HTTP methods and is available in the following:

    Syntax

    https://<DNS>/api/<version>/event/merge

    where:

    Parameters

    sinceDate (optional Date type): Epoch time in milliseconds or a date in ISO 8601 format. If this parameter is not specified, the results are from the last hour.

    offset (optional Integer type): Return results from a position. The default is 0.

    limit (optional Integer type): The number of results to return. Results are sorted from earliest date to latest date. The default is 100. The maximum is 100.

    Sample request

    GET https://my.veevanetwork.com:8443/api/v14.0/event/merge?sinceDate=2017-01-01T00:00:00.000-00:00

    Response

    responseStatus: The status of the response from Network.

    totalCount: The number of results matching the request. When the total count exceeds the limit (100), run subsequent requests using the offset parameter to get additional page results.

    offset: The offset of this request. limit - The maximum number of results returned in this request.

    sinceDate: The requested start date is ISO 8601 format.

    events: A list of events.

    Notes

    None

    Retrieve Unmerges

    Sample response

    {
      "responseStatus":"SUCCESS",
      "totalCount":2,
      "offset":0,
      "limit":100,
      "sinceDate":"2016-12-31T19:00:00.000-05:00",
      "events":[{
          "type":"UNMERGE",
          "date":"2017-12-04T10:38:31.000-05:00",
          "entities":[{
              "type":"UNMERGE_ORIGINAL",
              "entityId":"931498177374133023",
              "entityType":"HCP"
            },
            {
              "type":"UNMERGE_NEW",
              "entityId":"931498286389467937",
              "entityType":"HCP"
            }
          ]
        },
        {
          "type":"UNMERGE",
          "date":"2017-12-11T11:43:40.000-05:00",
          "entities":[{
              "type":"UNMERGE_ORIGINAL",
              "entityId":"931521762955172639",
              "entityType":"HCP"
            },
            {
              "type":"UNMERGE_NEW",
              "entityId":"931538200903031583",
              "entityType":"HCP"
            }
          ]
        }
      ]
    }
    

    This API enables you to retrieve the results of unmerge events that occurred in your Network instance. Unmerges include events that occurred in your Network instance; only customer (gray) records are reported.

    Compatibility

    This API uses the GET and POST HTTP methods and is available in the following:

    Syntax

    https://<DNS>/api/<version>/event/unmerge

    where:

    Parameters

    sinceDate (optional Date type): Epoch time in milliseconds or a date in ISO 8601 format. If this parameter is not specified, the results are from the last hour.

    offset (optional Integer type): Return results from a position. The default is 0.

    limit (optional Integer type): The number of results to return. Results are sorted from earliest date to latest date. The default is 100. The maximum is 100.

    Sample request

    GET https://my.veevanetwork.com:8443/api/v14.0/event/unmerge?sinceDate=2017-01-01T00:00:00.000-00:00

    Response

    responseStatus: The status of the response from Network.

    totalCount: The number of results matching the request. When the total count exceeds the limit (100), run subsequent requests using the offset parameter to get additional page results.

    offset: The offset of this request. limit - The maximum number of results returned in this request.

    sinceDate: The requested start date is ISO 8601 format.

    events: A list of events.

    Notes

    None

    Search

    Search enables you to construct simple, yet powerful searches to retrieve data from Network. When a client application calls the Search API, it passes a query string in an expression that specifies the search text and specific parameters to get the intended set of entities from Network. Search results are ranked according to closeness to the search terms specified.

    Search Network data

    Sample response

    {
       "responseStatus": "SUCCESS",
       "entities": [
          {
             "entityId": "243035950412727300",
             "entityType": "HCP",
             "metaData": {
                "highlightTerms": [],
                "resultIsFromMaster": true,
                "vid__v": "243035950412727300",
                "relevance": 121.49423,
                "highlights": {}
             },
             "entity": {
                "record_state__v": "VALID",
                "is_externally_mastered__v": false,
                "birth_year__v": 1983,
                "hcp_type__v": "P",
                "formatted_name__v": "SMITHA JOHN",
                "last_name__v": "JOHN",
                "hcp_status__v": "A",
                "type_of_practice__v": "20",
                "medical_degree_1__v": "MD",
                "addresses__v": [
                   {
                      "record_state__v": "VALID",
                      "delivery_address_1__v": "720 Westview Dr Sw",
                      "thoroughfare_name__v": "Westview",
                      "premise_number__v": "720",
                      "phone_1__v": "4047521857",
                      "postal_code__v": "30310",
                      "administrative_area__v": "US-GA",
                      "ISO_3166_n__v": "840",
                      "latitude__v": 33.746575,
                      "thoroughfare_trailing_type__v": "Dr",
                      "delivery_address__v": "720 Westview Dr Sw",
                      "address_type__v": "P",
                      "is_veeva_master__v": true,
                      "sub_administrative_area__v": "Fulton",
                      "dpv_confirmed_indicator__v": "X",
                      "thoroughfare_post_direction__v": "Sw",
                      "premise__v": "720",
                      "entity_vid__v": "243035950412727300",
                      "ISO_3166_3__v": "USA",
                      "status_update_time__v": "2013-10-28T03:36:45.000-07:00",
                      "longitude__v": -84.415974,
                      "thoroughfare__v": "Westview Dr Sw",
                      "address_line_2__v": "Atlanta GA 30310",
                      "created_date__v": "2013-10-28T03:36:45.000-07:00",
                      "address_verification_status__v": "V",
                      "vid__v": "243283355829797903",
                      "postal_code_primary__v": "30310",
                      "cbsa__v": "12060",
                      "entity_type__v": "HCP",
                      "address_line_1__v": "720 Westview Dr Sw",
                      "country__v": "US",
                      "modified_date__v": "2013-10-28T03:36:45.000-07:00",
                      "address_ordinal__v": 1,
                      "locality__v": "Atlanta",
                      "address_status__v": "A",
                      "record_delta_id__v": "243283799612326926"
                   },
                   {
                      "record_state__v": "VALID",
                      "delivery_address_1__v": "1421 Peachtree St Ne Apt 201",
                      "thoroughfare_name__v": "Peachtree",
                      "premise_number__v": "1421",
                      "sub_building_type__v": "Apt",
                      "postal_code__v": "30309",
                      "administrative_area__v": "US-GA",
                      "ISO_3166_n__v": "840",
                      "latitude__v": 33.792927,
                      "thoroughfare_trailing_type__v": "St",
                      "delivery_address__v": "1421 Peachtree St Ne Apt 201",
                      "address_type__v": "P",
                      "is_veeva_master__v": true,
                      "sub_administrative_area__v": "Fulton",
                      "thoroughfare_post_direction__v": "Ne",
                      "dpv_confirmed_indicator__v": "X",
                      "premise__v": "1421",
                      "entity_vid__v": "243035950412727300",
                      "ISO_3166_3__v": "USA",
                      "status_update_time__v": "2013-10-28T03:36:45.000-07:00",
                      "longitude__v": -84.386469,
                      "thoroughfare__v": "Peachtree St Ne",
                      "address_line_2__v": "Atlanta GA 30309",
                      "sub_building_number__v": "201",
                      "created_date__v": "2013-10-28T03:36:45.000-07:00",
                      "vid__v": "243283355829797917",
                      "address_verification_status__v": "A",
                      "cbsa__v": "12060",
                      "postal_code_primary__v": "30309",
                      "entity_type__v": "HCP",
                      "address_line_1__v": "1421 Peachtree St Ne Apt 201",
                      "country__v": "US",
                      "modified_date__v": "2013-10-28T03:36:45.000-07:00",
                      "address_ordinal__v": 2,
                      "locality__v": "Atlanta",
                      "address_status__v": "I",
                      "sub_building__v": "Apt 201",
                      "record_delta_id__v": "243283799612326931"
                   },
                   {
                      "record_state__v": "VALID",
                      "delivery_address_1__v": "1005 Calibre Woods Dr Ne",
                      "thoroughfare_name__v": "Calibre Woods",
                      "premise_number__v": "1005",
                      "postal_code__v": "30329-3948",
                      "administrative_area__v": "US-GA",
                      "ISO_3166_n__v": "840",
                      "latitude__v": 33.6487,
                      "thoroughfare_trailing_type__v": "Dr",
                      "delivery_address__v": "1005 Calibre Woods Dr Ne",
                      "address_type__v": "M",
                      "is_veeva_master__v": true,
                      "sub_administrative_area__v": "Dekalb",
                      "thoroughfare_post_direction__v": "Ne",
                      "dpv_confirmed_indicator__v": "X",
                      "premise__v": "1005",
                      "entity_vid__v": "243035950412727300",
                      "ISO_3166_3__v": "USA",
                      "status_update_time__v": "2013-10-28T03:36:45.000-07:00",
                      "longitude__v": -84.3916,
                      "thoroughfare__v": "Calibre Woods Dr Ne",
                      "address_line_2__v": "Atlanta GA 30329-3948",
                      "created_date__v": "2013-10-28T03:36:45.000-07:00",
                      "vid__v": "243283355829797919",
                      "address_verification_status__v": "V",
                      "cbsa__v": "12060",
                      "postal_code_primary__v": "30329",
                      "entity_type__v": "HCP",
                      "postal_code_secondary__v": "3948",
                      "address_line_1__v": "1005 Calibre Woods Dr Ne",
                      "country__v": "US",
                      "modified_date__v": "2013-10-28T03:36:45.000-07:00",
                      "address_ordinal__v": 3,
                      "locality__v": "Atlanta",
                      "address_status__v": "A",
                      "record_delta_id__v": "243283799612326923"
                   }
                ],
                "me_id__v": "4958007003",
                "board_certification__v": "IM",
                "is_veeva_master__v": true,
                "grad_trg_end_date__v": "2013-07-31",
                "parent_hcos__v": [],
                "mpa__v": "20",
                "specialty_1__v": "IM",
                "status_update_time__v": "2013-10-28T03:36:45.000-07:00",
                "pdrp_optout__v": "N",
                "npi_num__v": "1972815777",
                "specialty_1_rank__v": 1,
                "licenses__v": [
                   {
                      "type_value__v": "GA",
                      "record_state__v": "VALID",
                      "body__v": "BOME",
                      "entity_vid__v": "243035950412727300",
                      "effective_date__v": "2013-05-03",
                      "status_update_time__v": "2013-10-28T03:36:45.000-07:00",
                      "expiration_date__v": "2014-05-31",
                      "license_eligibility__v": "E",
                      "created_date__v": "2013-10-28T03:36:45.000-07:00",
                      "vid__v": "243283355829797913",
                      "entity_type__v": "HCP",
                      "license_status__v": "A",
                      "modified_date__v": "2013-10-28T03:36:45.000-07:00",
                      "license_number__v": "069874",
                      "license_degree__v": "MD",
                      "type__v": "state",
                      "record_delta_id__v": "243283799612326935",
                      "is_veeva_master__v": true,
                      "initial_board_license_date__v": "2013-09-05"
                   },
                   {
                      "type_value__v": "GA",
                      "record_state__v": "VALID",
                      "body__v": "BOME",
                      "entity_vid__v": "243035950412727300",
                      "effective_date__v": "2010-06-23",
                      "status_update_time__v": "2013-10-28T03:36:45.000-07:00",
                      "expiration_date__v": "2012-06-30",
                      "license_eligibility__v": "I",
                      "created_date__v": "2013-10-28T03:36:45.000-07:00",
                      "vid__v": "243283355829797909",
                      "entity_type__v": "HCP",
                      "license_status__v": "I",
                      "modified_date__v": "2013-10-28T03:36:45.000-07:00",
                      "license_number__v": "004447",
                      "license_degree__v": "MD",
                      "type__v": "state",
                      "record_delta_id__v": "243283799612326948",
                      "is_veeva_master__v": true,
                      "initial_board_license_date__v": "2011-08-17"
                   },
                   {
                      "type_value__v": "GA",
                      "record_state__v": "VALID",
                      "body__v": "BOME",
                      "entity_vid__v": "243035950412727300",
                      "status_update_time__v": "2013-10-28T03:36:45.000-07:00",
                      "expiration_date__v": "2014-05-31",
                      "license_eligibility__v": "E",
                      "created_date__v": "2013-10-28T03:36:45.000-07:00",
                      "vid__v": "243283355829797911",
                      "entity_type__v": "HCP",
                      "license_status__v": "A",
                      "modified_date__v": "2013-10-28T03:36:45.000-07:00",
                      "license_number__v": "1104069874",
                      "license_degree__v": "MD",
                      "type__v": "state",
                      "record_delta_id__v": "243283799612326941",
                      "is_veeva_master__v": true,
                      "initial_board_license_date__v": "2013-08-26"
                   },
                   {
                      "type_value__v": "DEA",
                      "record_state__v": "VALID",
                      "entity_vid__v": "243035950412727300",
                      "status_update_time__v": "2013-10-28T03:36:45.000-07:00",
                      "expiration_date__v": "2015-12-31",
                      "created_date__v": "2013-10-28T03:36:45.000-07:00",
                      "vid__v": "243283355829797904",
                      "drug_schedule__v": "22N 33N 4 5",
                      "entity_type__v": "HCP",
                      "license_status__v": "X",
                      "modified_date__v": "2013-10-28T03:36:45.000-07:00",
                      "license_number__v": "FJ3845940",
                      "type__v": "address",
                      "address_vid__v": "243283355829797903",
                      "is_veeva_master__v": true,
                      "record_delta_id__v": "243283799612326938"
                   },
                   {
                      "type_value__v": "GA",
                      "record_state__v": "VALID",
                      "body__v": "BOME",
                      "entity_vid__v": "243035950412727300",
                      "status_update_time__v": "2013-10-28T03:36:45.000-07:00",
                      "expiration_date__v": "2013-06-30",
                      "license_eligibility__v": "I",
                      "created_date__v": "2013-10-28T03:36:45.000-07:00",
                      "vid__v": "243283355829797906",
                      "entity_type__v": "HCP",
                      "license_status__v": "I",
                      "modified_date__v": "2013-10-28T03:36:45.000-07:00",
                      "license_number__v": "1114004447",
                      "license_degree__v": "MD",
                      "type__v": "state",
                      "record_delta_id__v": "243283799612326945",
                      "is_veeva_master__v": true,
                      "initial_board_license_date__v": "2013-08-26"
                   }
                ],
                "primary_country__v": "US",
                "created_date__v": "2013-10-28T03:36:45.000-07:00",
                "middle_name__v": "MARY",
                "fellow__v": "N",
                "vid__v": "243035950412727300",
                "education_level__v": "RESIDENCY",
                "modified_date__v": "2013-10-28T03:36:45.000-07:00",
                "grad_trg_start_date__v": "2010-07-01",
                "master_vid__v": "243035950412727300",
                "gender__v": "F",
                "grad_training__v": "N",
                "birth_country__v": "IN",
                "place_of_employment__v": "30",
                "record_delta_id__v": "243283799612326921",
                "first_name__v": "SMITHA",
                "ama_do_not_contact__v": "N"
             }
          },
          {
             "entityId": "243056834875753472",
             "entityType": "HCP",
             "metaData": {
                "highlightTerms": [],
                "resultIsFromMaster": true,
                "vid__v": "243056834875753472",
                "relevance": 121.30947,
                "highlights": {}
             },
             "entity": {
                "record_state__v": "VALID",
                "is_externally_mastered__v": false,
                "hcp_type__v": "N",
                "formatted_name__v": "SMITHA JOHN",
                "last_name__v": "JOHN",
                "hcp_status__v": "A",
                "medical_degree_1__v": "RN",
                "specialty_2__v": "PM",
                "addresses__v": [
                   {
                      "record_state__v": "VALID",
                      "delivery_address_1__v": "1300 S Old Orchard Ln",
                      "thoroughfare_name__v": "Old Orchard",
                      "premise_number__v": "1300",
                      "thoroughfare_pre_direction__v": "S",
                      "postal_code__v": "75067-5067",
                      "administrative_area__v": "US-TX",
                      "ISO_3166_n__v": "840",
                      "latitude__v": 33.030261,
                      "thoroughfare_trailing_type__v": "Ln",
                      "delivery_address__v": "1300 S Old Orchard Ln",
                      "address_type__v": "P",
                      "is_veeva_master__v": true,
                      "sub_administrative_area__v": "Denton",
                      "dpv_confirmed_indicator__v": "X",
                      "premise__v": "1300",
                      "entity_vid__v": "243056834875753472",
                      "ISO_3166_3__v": "USA",
                      "status_update_time__v": "2013-10-28T03:57:01.000-07:00",
                      "longitude__v": -97.027682,
                      "thoroughfare__v": "S Old Orchard Ln",
                      "address_line_2__v": "Lewisville TX 75067-5067",
                      "created_date__v": "2013-10-28T03:57:01.000-07:00",
                      "vid__v": "243293877115552801",
                      "address_verification_status__v": "V",
                      "cbsa__v": "19100",
                      "postal_code_primary__v": "75067",
                      "entity_type__v": "HCP",
                      "postal_code_secondary__v": "5067",
                      "address_line_1__v": "1300 S Old Orchard Ln",
                      "country__v": "US",
                      "modified_date__v": "2013-10-28T03:57:01.000-07:00",
                      "address_ordinal__v": 2,
                      "locality__v": "Lewisville",
                      "address_status__v": "A",
                      "record_delta_id__v": "243294003129222183"
                   },
                   {
                      "record_state__v": "VALID",
                      "delivery_address_1__v": "1221 W Jeter Rd",
                      "thoroughfare_name__v": "Jeter",
                      "premise_number__v": "1221",
                      "thoroughfare_pre_direction__v": "W",
                      "postal_code__v": "76226-6867",
                      "administrative_area__v": "US-TX",
                      "ISO_3166_n__v": "840",
                      "latitude__v": 33.080454,
                      "thoroughfare_trailing_type__v": "Rd",
                      "delivery_address__v": "1221 W Jeter Rd",
                      "address_type__v": "U",
                      "is_veeva_master__v": true,
                      "sub_administrative_area__v": "Denton",
                      "dpv_confirmed_indicator__v": "X",
                      "premise__v": "1221",
                      "entity_vid__v": "243056834875753472",
                      "ISO_3166_3__v": "USA",
                      "status_update_time__v": "2013-10-28T03:57:01.000-07:00",
                      "longitude__v": -97.176939,
                      "thoroughfare__v": "W Jeter Rd",
                      "address_line_2__v": "Argyle TX 76226-6867",
                      "created_date__v": "2013-10-28T03:57:01.000-07:00",
                      "vid__v": "243293877115552803",
                      "address_verification_status__v": "V",
                      "cbsa__v": "19100",
                      "postal_code_primary__v": "76226",
                      "entity_type__v": "HCP",
                      "postal_code_secondary__v": "6867",
                      "address_line_1__v": "1221 W Jeter Rd",
                      "country__v": "US",
                      "modified_date__v": "2013-10-28T03:57:01.000-07:00",
                      "address_ordinal__v": 1,
                      "locality__v": "Argyle",
                      "address_status__v": "A",
                      "record_delta_id__v": "243294003129222180"
                   }
                ],
                "is_veeva_master__v": true,
                "parent_hcos__v": [],
                "medical_degree_2__v": "PVN",
                "specialty_1__v": "GS",
                "pdrp_optout__v": "N",
                "status_update_time__v": "2013-10-28T03:57:01.000-07:00",
                "specialty_1_rank__v": 1,
                "licenses__v": [
                   {
                      "type_value__v": "TX",
                      "record_state__v": "VALID",
                      "body__v": "BON",
                      "entity_vid__v": "243056834875753472",
                      "effective_date__v": "2009-03-06",
                      "status_update_time__v": "2013-10-28T03:57:01.000-07:00",
                      "expiration_date__v": "2014-02-28",
                      "license_eligibility__v": "I",
                      "created_date__v": "2013-10-28T03:57:01.000-07:00",
                      "vid__v": "243293877115552795",
                      "entity_type__v": "HCP",
                      "license_status__v": "A",
                      "modified_date__v": "2013-10-28T03:57:01.000-07:00",
                      "license_number__v": "766458",
                      "license_degree__v": "RN",
                      "type__v": "state",
                      "record_delta_id__v": "243294003129222177",
                      "is_veeva_master__v": true,
                      "initial_board_license_date__v": "2013-07-25"
                   },
                   {
                      "type_value__v": "CA",
                      "record_state__v": "VALID",
                      "body__v": "BON",
                      "entity_vid__v": "243056834875753472",
                      "effective_date__v": "2012-06-11",
                      "status_update_time__v": "2013-10-28T03:57:01.000-07:00",
                      "expiration_date__v": "2014-04-30",
                      "license_eligibility__v": "I",
                      "created_date__v": "2013-10-28T03:57:01.000-07:00",
                      "vid__v": "243293877115552799",
                      "entity_type__v": "HCP",
                      "license_status__v": "A",
                      "modified_date__v": "2013-10-28T03:57:01.000-07:00",
                      "license_number__v": "RN00821088",
                      "license_degree__v": "RN",
                      "type__v": "state",
                      "record_delta_id__v": "243294003129222171",
                      "is_veeva_master__v": true,
                      "initial_board_license_date__v": "2013-04-02"
                   },
                   {
                      "type_value__v": "TX",
                      "record_state__v": "VALID",
                      "body__v": "BON",
                      "entity_vid__v": "243056834875753472",
                      "effective_date__v": "2012-10-12",
                      "status_update_time__v": "2013-10-28T03:57:01.000-07:00",
                      "expiration_date__v": "2014-03-31",
                      "license_eligibility__v": "I",
                      "created_date__v": "2013-10-28T03:57:01.000-07:00",
                      "vid__v": "243293877115552797",
                      "entity_type__v": "HCP",
                      "license_status__v": "A",
                      "modified_date__v": "2013-10-28T03:57:01.000-07:00",
                      "license_number__v": "827233",
                      "license_degree__v": "RN",
                      "type__v": "state",
                      "record_delta_id__v": "243294003129222174",
                      "is_veeva_master__v": true,
                      "initial_board_license_date__v": "2013-07-25"
                   }
                ],
                "primary_country__v": "US",
                "created_date__v": "2013-10-28T03:57:01.000-07:00",
                "fellow__v": "N",
                "middle_name__v": "SUSAN",
                "vid__v": "243056834875753472",
                "specialty_2_rank__v": 2,
                "modified_date__v": "2013-10-28T03:57:01.000-07:00",
                "gender__v": "F",
                "master_vid__v": "243056834875753472",
                "grad_training__v": "N",
                "first_name__v": "SMITHA",
                "ama_do_not_contact__v": "N",
                "record_delta_id__v": "243294003129222168"
             }
          }
       ],
       "totalCount": 10011,
       "offset": 0,
       "limit": 2
    }
    

    Sample response (custom objects)

    {
        "responseStatus": "SUCCESS",
        "entities": [
            {
                "entityId": "242980123077248009",
                "entityType": "HCP",
                "metaData": {
                    "highlights": {
                        "hcp_first_name__v": [
                            "<em>Daniel</em>"
                        ],
                        "hcp_formatted_name__v": [
                            "<em>Daniel</em> Witcher"
                        ],
                        "parent_hco_corp_name__v": [
                            "Navy Medical Center <em>San Diego</em>",
                            "Navy Medical Center <em>San Diego</em>"
                        ]
                    },
                    "vid__v": "242980123077248009",
                    "canDownloadFromMaster": true,
                    "highlightTerms": [
                        "San Diego",
                        "Daniel"
                    ],
                    "resultIsFromMaster": true,
                    "fromMasterInstance": 2,
                    "relevance": 84.370964
                },
                "entity": {
                    "gender__v": "U",
                    "specialty_1__v": "US",
                    "hcp_type__v": "P",
                    "master_vid__v": "242980123077248009",
                    "first_name__v": "Daniel",
                    "grad_training__v": "N",
                    "record_delta_id__v": "931585269642919935",
                    "last_name__v": "Witcher",
                    "medical_degree_1__v": "DDS",
                    "fellow__v": "N",
                    "middle_name__v": "S",
                    "kaiser__v": "N",
                    "formatted_name__v": "Daniel Witcher",
                    "primary_country__v": "US",
                    "created_date__v": "2017-12-20T00:18:20.000Z",
                    "pdrp_optout__v": "N",
                    "is_veeva_master__v": true,
                    "hcp_status__v": "A",
                    "ama_do_not_contact__v": "N",
                    "status_update_time__v": "2017-12-20T00:18:19.000Z",
                    "ams_id__v": "15864629",
                    "modified_date__v": "2017-12-20T00:18:20.000Z",
                    "record_state__v": "VALID",
                    "record_version__v": 0,
                    "vid__v": "242980123077248009",
                    "entity_is_third_party_master_for_search_only__v": false,
                    "is_externally_mastered__v": false,
                    "specialty_1_rank__v": 1,
                    "licenses__v": [
                        {
                            "address_vid__v": "420505979138970626",
                            "license_number__v": "FW4591790",
                            "best_state_license__v": "N",
                            "license_eligibility__v": "U",
                            "status_update_time__v": "2017-12-20T00:18:20.000Z",
                            "record_delta_id__v": "931585265015816200",
                            "drug_schedule__v": "22N 33N 4 5",
                            "license_status__v": "X",
                            "entity_type__v": "HCP",
                            "expiration_date__v": "2017-05-31",
                            "modified_date__v": "2017-12-20T00:18:20.000Z",
                            "rxa_eligible__v": "U",
                            "record_state__v": "VALID",
                            "dea_business_activity_code__v": "C0",
                            "vid__v": "420505979180913670",
                            "entity_vid__v": "242980123077248009",
                            "created_date__v": "2017-12-20T00:18:20.000Z",
                            "type__v": "ADDRESS",
                            "is_veeva_master__v": true,
                            "type_value__v": "DEA"
                        },
                        {
                            "address_vid__v": "412146222338511876",
                            "license_number__v": "FW4197857",
                            "best_state_license__v": "N",
                            "license_eligibility__v": "U",
                            "status_update_time__v": "2017-12-20T00:18:20.000Z",
                            "record_delta_id__v": "931585265015816199",
                            "drug_schedule__v": "22N 33N 4 5",
                            "license_status__v": "I",
                            "entity_type__v": "HCP",
                            "expiration_date__v": "2016-05-31",
                            "modified_date__v": "2017-12-20T00:18:20.000Z",
                            "rxa_eligible__v": "U",
                            "record_state__v": "VALID",
                            "dea_business_activity_code__v": "C0",
                            "vid__v": "243244052365968391",
                            "entity_vid__v": "242980123077248009",
                            "created_date__v": "2017-12-20T00:18:20.000Z",
                            "type__v": "ADDRESS",
                            "is_veeva_master__v": true,
                            "type_value__v": "DEA"
                        }
                    ],
                    "addresses__v": [
                        {
                            "dpv_confirmed_indicator__v": "X",
                            "postal_code_primary__v": "92134",
                            "address_line_1__v": "34800 Bob Wilson Dr",
                            "premise__v": "34800",
                            "cbsa__v": "41740",
                            "record_delta_id__v": "931585265015816198",
                            "locality__v": "San Diego",
                            "delivery_address__v": "34800 Bob Wilson Dr",
                            "country__v": "US",
                            "created_date__v": "2017-12-20T00:18:20.000Z",
                            "premise_number__v": "34800",
                            "is_veeva_master__v": true,
                            "thoroughfare__v": "Bob Wilson Dr",
                            "status_update_time__v": "2017-12-20T00:18:20.000Z",
                            "address_type__v": "P",
                            "delivery_address_1__v": "34800 Bob Wilson Dr",
                            "sub_administrative_area__v": "San Diego",
                            "entity_type__v": "HCP",
                            "address_verification_status__v": "V",
                            "address_status__v": "I",
                            "modified_date__v": "2017-12-20T00:18:20.000Z",
                            "record_state__v": "VALID",
                            "vid__v": "243244052365968387",
                            "entity_vid__v": "242980123077248009",
                            "postal_code__v": "92134-1098",
                            "is_externally_mastered__v": false,
                            "administrative_area__v": "US-CA",
                            "formatted_address__v": "34800 Bob Wilson Dr San Diego CA 92134-1098",
                            "latitude__v": 32.726315,
                            "address_ordinal__v": 3,
                            "postal_code_secondary__v": "1098",
                            "longitude__v": -117.143865
                        },
                        {
                            "dpv_confirmed_indicator__v": "X",
                            "postal_code_primary__v": "92614",
                            "address_line_1__v": "17010 Red Hill Ave Ste D",
                            "premise__v": "17010",
                            "cbsa__v": "31100",
                            "record_delta_id__v": "931585265015816197",
                            "thoroughfare_trailing_type__v": "Ave",
                            "locality__v": "Irvine",
                            "delivery_address__v": "17010 Red Hill Ave Ste D",
                            "country__v": "US",
                            "sub_building_number__v": "D",
                            "created_date__v": "2017-12-20T00:18:20.000Z",
                            "premise_number__v": "17010",
                            "is_veeva_master__v": true,
                            "sub_building_type__v": "Ste",
                            "sub_building__v": "Ste D",
                            "thoroughfare__v": "Red Hill Ave",
                            "status_update_time__v": "2017-12-20T00:18:20.000Z",
                            "address_type__v": "P",
                            "delivery_address_1__v": "17010 Red Hill Ave Ste D",
                            "sub_administrative_area__v": "Orange",
                            "entity_type__v": "HCP",
                            "address_verification_status__v": "V",
                            "address_status__v": "A",
                            "modified_date__v": "2017-12-20T00:18:20.000Z",
                            "record_state__v": "VALID",
                            "vid__v": "412146222338511876",
                            "entity_vid__v": "242980123077248009",
                            "postal_code__v": "92614-5626",
                            "is_externally_mastered__v": false,
                            "administrative_area__v": "US-CA",
                            "formatted_address__v": "17010 Red Hill Ave Ste D Irvine CA 92614-5626",
                            "latitude__v": 33.699966,
                            "address_ordinal__v": 2,
                            "thoroughfare_name__v": "Red Hill",
                            "postal_code_secondary__v": "5626",
                            "longitude__v": -117.848743
                        },
                        {
                            "dpv_confirmed_indicator__v": "X",
                            "postal_code_primary__v": "92647",
                            "address_line_1__v": "16071 Goldenwest St",
                            "premise__v": "16071",
                            "cbsa__v": "31100",
                            "record_delta_id__v": "931585265015816196",
                            "thoroughfare_trailing_type__v": "St",
                            "locality__v": "Huntington Beach",
                            "delivery_address__v": "16071 Goldenwest St",
                            "country__v": "US",
                            "created_date__v": "2017-12-20T00:18:20.000Z",
                            "premise_number__v": "16071",
                            "is_veeva_master__v": true,
                            "thoroughfare__v": "Goldenwest St",
                            "status_update_time__v": "2017-12-20T00:18:20.000Z",
                            "address_type__v": "P",
                            "delivery_address_1__v": "16071 Goldenwest St",
                            "sub_administrative_area__v": "Orange",
                            "entity_type__v": "HCP",
                            "address_verification_status__v": "V",
                            "address_status__v": "A",
                            "modified_date__v": "2017-12-20T00:18:20.000Z",
                            "record_state__v": "VALID",
                            "vid__v": "420505979138970626",
                            "entity_vid__v": "242980123077248009",
                            "postal_code__v": "92647-3405",
                            "is_externally_mastered__v": false,
                            "administrative_area__v": "US-CA",
                            "formatted_address__v": "16071 Goldenwest St Huntington Beach CA 92647-3405",
                            "latitude__v": 33.728098,
                            "address_ordinal__v": 1,
                            "thoroughfare_name__v": "Goldenwest",
                            "postal_code_secondary__v": "3405",
                            "longitude__v": -118.006864
                        }
                    ],
                    "parent_hcos__v": [
                        {
                            "parent_hco_vid__v": "242976933049009153",
                            "related_entity_type__v": "HCO",
                            "relationship_type__v": "9",
                            "status_update_time__v": "2017-12-20T00:18:20.000Z",
                            "record_delta_id__v": "931585265015816194",
                            "entity_type__v": "HCP",
                            "hierarchy_type__v": "HCP_HCO",
                            "modified_date__v": "2017-12-20T00:18:20.000Z",
                            "parent_hco_corp_name__v": "Navy Medical Center San Diego",
                            "record_state__v": "VALID",
                            "parent_hco_status__v": "A",
                            "is_primary_relationship__v": "N",
                            "vid__v": "243244052365968393",
                            "entity_vid__v": "242980123077248009",
                            "created_date__v": "2017-12-20T00:18:20.000Z",
                            "is_veeva_master__v": true
                        },
                        {
                            "parent_hco_vid__v": "242976933049009153",
                            "related_entity_type__v": "HCO",
                            "relationship_type__v": "9",
                            "status_update_time__v": "2017-12-20T00:18:20.000Z",
                            "record_delta_id__v": "931585265015816195",
                            "entity_type__v": "HCP",
                            "hierarchy_type__v": "HCP_HCO",
                            "modified_date__v": "2017-12-20T00:18:20.000Z",
                            "parent_hco_corp_name__v": "Navy Medical Center San Diego",
                            "record_state__v": "VALID",
                            "parent_hco_status__v": "I",
                            "is_primary_relationship__v": "N",
                            "vid__v": "315989759472276482",
                            "entity_vid__v": "242980123077248009",
                            "created_date__v": "2017-12-20T00:18:20.000Z",
                            "end_date__v": "2014-06-17",
                            "is_veeva_master__v": true
                        }
                    ]
                }
            },
            {
                "entityId": "933580259012116863",
                "entityType": "EMPLOYEE__C",
                "metaData": {
                    "highlights": {
                        "employee_str_name__c": [
                            "<em>Daniel</em> Carter"
                        ]
                    },
                    "vid__v": "933580259012116863",
                    "highlightTerms": [
                        "San Diego",
                        "Daniel"
                    ],
                    "relevance": 30.439014
                },
                "entity": {
                    "employee_title__c": "Key Account Manager",
                    "record_owner_type__v": "LOCAL",
                    "employee_status__c": "A",
                    "employee_business_unit__c": "Sales",
                    "employee_number__c": "103",
                    "employee_last_name__c": "Carter",
                    "record_delta_id__v": "933580259060776959",
                    "record_owner_name__v": "Local",
                    "employee_name__c": "Daniel Carter",
                    "primary_country__v": "US",
                    "created_date__v": "2018-12-07T08:11:33.000Z",
                    "employee_first_name__c": "Daniel",
                    "employee_hire_date__c": "2018-12-01",
                    "is_veeva_master__v": false,
                    "status_update_time__v": "2018-12-07T08:11:33.000Z",
                    "modified_date__v": "2018-12-07T08:11:33.000Z",
                    "record_state__v": "VALID",
                    "candidate_record__v": false,
                    "record_version__v": 0,
                    "vid__v": "933580259012116863",
                    "is_externally_mastered__v": false,
                    "custom_keys__v": [
                        {
                            "custom_key_value__v": "933580259012116863",
                            "custom_key_vid_key__v": "CUSTOMER__v/3/change_request:EMPLOYEE__C:933580259012116863",
                            "custom_key_source_type__v": "CUSTOMER__v/3/change_request",
                            "custom_key_entity_type__v": "EMPLOYEE__C",
                            "custom_key_status__v": "A",
                            "status_update_time__v": "2018-12-07T08:11:33.000Z",
                            "custom_key_entity_id__v": "933580259012116863",
                            "custom_key_item_type__v": "EMPLOYEE__C",
                            "modified_date__v": "2018-12-07T08:11:33.000Z",
                            "vid__v": "933580259018867071",
                            "created_date__v": "2018-12-07T08:11:33.000Z"
                        },
                        {
                            "custom_key_value__v": "933580258951365023",
                            "custom_key_vid_key__v": "WORKFLOW__v:DCRID__v:933580258951365023",
                            "custom_key_source_type__v": "WORKFLOW__v",
                            "custom_key_entity_type__v": "EMPLOYEE__C",
                            "custom_key_status__v": "A",
                            "status_update_time__v": "2018-12-07T08:11:33.000Z",
                            "custom_key_entity_id__v": "933580259012116863",
                            "custom_key_item_type__v": "DCRID__v",
                            "modified_date__v": "2018-12-07T08:11:33.000Z",
                            "vid__v": "933580259019194751",
                            "created_date__v": "2018-12-07T08:11:33.000Z"
                        }
                    ],
                    "addresses__v": [
                        {
                            "nwk_primary_address__c": "Y",
                            "address_line_1__v": "200 Park Blvd.",
                            "record_owner_type__v": "LOCAL",
                            "record_delta_id__v": "933580259020275711",
                            "record_owner_name__v": "Local",
                            "locality__v": "San Diego",
                            "country__v": "US",
                            "created_date__v": "2018-12-07T08:11:33.000Z",
                            "is_veeva_master__v": false,
                            "status_update_time__v": "2018-12-07T08:11:33.000Z",
                            "address_type__v": "P",
                            "entity_type__v": "EMPLOYEE__C",
                            "address_verification_status__v": "DS",
                            "address_status__v": "A",
                            "modified_date__v": "2018-12-07T08:11:33.000Z",
                            "record_state__v": "VALID",
                            "vid__v": "933580259012116864",
                            "entity_vid__v": "933580259012116863",
                            "postal_code__v": "91915",
                            "administrative_area__v": "US-CA",
                            "formatted_address__v": "200 Park Blvd. San Diego US-CA 91915",
                            "address_ordinal__v": 1,
                            "custom_keys__v": []
                        }
                    ],
                    "employee_account_rel_rel_set__c": [
                        {
                            "employee_account_rel_rel_status__c": "A",
                            "record_owner_type__v": "LOCAL",
                            "status_update_time__v": "2018-12-07T08:11:33.000Z",
                            "related_entity_vid__v": "242976972248974337",
                            "related_entity_name__v": "Kindred Hospital San Diego",
                            "record_delta_id__v": "933580259020275712",
                            "entity_type__v": "EMPLOYEE__C",
                            "record_owner_name__v": "Local",
                            "modified_date__v": "2018-12-07T08:11:33.000Z",
                            "record_state__v": "VALID",
                            "is_primary_relationship__v": "N",
                            "vid__v": "933580259012116865",
                            "entity_vid__v": "933580259012116863",
                            "created_date__v": "2018-12-07T08:11:33.000Z",
                            "is_veeva_master__v": false,
                            "custom_keys__v": []
                        }
                    ]
                }
            }
        ],
        "totalCount": 2,
        "offset": 0,
        "limit": 10,
        "supplementalResults": [
            {
                "hco_type__v": "4:6",
                "master_vid__v": "242976933049009153",
                "lab_services__v": "U",
                "hco_status__v": "A",
                "accept_medicare__v": "U",
                "npi_num__v": "1508036112",
                "count_all_locn_medstaff__v": 4,
                "record_delta_id__v": "931585265542594570",
                "count_non_md_do__v": 0,
                "kaiser__v": "N",
                "primary_country__v": "US",
                "hin__v": "930600I",
                "created_date__v": "2017-12-20T00:18:28.000Z",
                "training_facility__v": "N",
                "is_veeva_master__v": true,
                "major_class_of_trade__v": "4",
                "count_medstaff__v": 4,
                "count_md_do__v": 4,
                "ama_do_not_contact__v": "N",
                "count_all_locn_md_do__v": 4,
                "corporate_name__v": "Navy Medical Center San Diego",
                "status_update_time__v": "2017-12-20T00:18:27.000Z",
                "ams_id__v": "1324471",
                "modified_date__v": "2017-12-20T00:18:28.000Z",
                "accept_medicaid__v": "U",
                "record_state__v": "VALID",
                "count_all_locn_non_md_do__v": 0,
                "record_version__v": 0,
                "vid__v": "242976933049009153",
                "is_externally_mastered__v": false,
                "xray_services__v": "U",
                "roster_date__v": "2005-06-30",
                "licenses__v": [],
                "addresses__v": [
                    {
                        "dpv_confirmed_indicator__v": "X",
                        "postal_code_primary__v": "92134",
                        "address_line_1__v": "34800 Bob Wilson Dr Ste 113",
                        "premise__v": "34800",
                        "cbsa__v": "41740",
                        "record_delta_id__v": "931585265542594574",
                        "thoroughfare_trailing_type__v": "Dr",
                        "locality__v": "San Diego",
                        "delivery_address__v": "34800 Bob Wilson Dr Ste 113",
                        "country__v": "US",
                        "sub_building_number__v": "113",
                        "created_date__v": "2017-12-20T00:18:28.000Z",
                        "premise_number__v": "34800",
                        "phone_1__v": "6195326397",
                        "is_veeva_master__v": true,
                        "sub_building_type__v": "Ste",
                        "sub_building__v": "Ste 113",
                        "fax_1__v": "6195326645",
                        "thoroughfare__v": "Bob Wilson Dr",
                        "status_update_time__v": "2017-12-20T00:18:28.000Z",
                        "address_type__v": "P",
                        "delivery_address_1__v": "34800 Bob Wilson Dr Ste 113",
                        "sub_administrative_area__v": "San Diego",
                        "entity_type__v": "HCO",
                        "address_verification_status__v": "V",
                        "address_status__v": "A",
                        "modified_date__v": "2017-12-20T00:18:28.000Z",
                        "record_state__v": "VALID",
                        "vid__v": "243244004894835806",
                        "entity_vid__v": "242976933049009153",
                        "postal_code__v": "92134-1113",
                        "is_externally_mastered__v": false,
                        "administrative_area__v": "US-CA",
                        "formatted_address__v": "34800 Bob Wilson Dr Ste 113 San Diego CA 92134-1113",
                        "latitude__v": 32.726315,
                        "address_ordinal__v": 1,
                        "thoroughfare_name__v": "Bob Wilson",
                        "postal_code_secondary__v": "1113",
                        "longitude__v": -117.143865
                    }
                ],
                "parent_hcos__v": [
                    {
                        "parent_hco_vid__v": "242977624605852672",
                        "related_entity_type__v": "HCO",
                        "relationship_type__v": "7341",
                        "status_update_time__v": "2017-12-20T00:18:28.000Z",
                        "record_delta_id__v": "931585265542594571",
                        "entity_type__v": "HCO",
                        "hierarchy_type__v": "HCO_HCO",
                        "modified_date__v": "2017-12-20T00:18:28.000Z",
                        "record_state__v": "VALID",
                        "parent_hco_status__v": "A",
                        "is_primary_relationship__v": "N",
                        "vid__v": "243244004894835805",
                        "entity_vid__v": "242976933049009153",
                        "created_date__v": "2017-12-20T00:18:28.000Z",
                        "is_veeva_master__v": true
                    },
                    {
                        "parent_hco_vid__v": "732072624842183680",
                        "related_entity_type__v": "HCO",
                        "relationship_type__v": "2",
                        "parent_type__v": "B",
                        "status_update_time__v": "2017-12-20T00:18:28.000Z",
                        "record_delta_id__v": "931585265542594573",
                        "entity_type__v": "HCO",
                        "hierarchy_type__v": "HCO_HCO",
                        "modified_date__v": "2017-12-20T00:18:28.000Z",
                        "record_state__v": "VALID",
                        "parent_hco_status__v": "A",
                        "is_primary_relationship__v": "N",
                        "vid__v": "738732591502431241",
                        "entity_vid__v": "242976933049009153",
                        "created_date__v": "2017-12-20T00:18:28.000Z",
                        "is_veeva_master__v": true
                    }
                ]
            }
        ]
    }
    

    This API enables you to retrieve the full set of entities and child objects matching the specified search criteria.

    Compatibility

    This API uses the GET HTTP method and is available in the following:

    Syntax

    https://<DNS>/api/<version>/search

    where:

    Parameters

    q (required): The query string (type text).

    types (optional): The entity type; ALL for all objects, HCO or HCP or a specific object value for custom objects (for example, STUDY__C).

    If not specified, the default is all types, and only Veeva objects are searched; custom objects will not be searched.

    offset (optional): The pagination number (type integer). The default is 0.

    limit (optional): The number to limit the results returned (type integer). The default is 10. The maximum is 100.

    sort (optional): The attribute to sort results by (type text). For example, first_name__v.

    sortOrder (optional): The sort order for the search. Value is asc for ascending or desc for descending.

    states (optional): A list of entity states to match on, including VALID, DELETED, UNDER_REVIEW, MERGED_INTO, MERGE_INACTIVATED, MERGE_ADDED, or INVALID.

    statuses (optional): A list of entity statuses to match on, including A (active), C (closed), D (deceased), I (inactive), R (retired), U (unknown), X (unknown license).

    returnFacets (optional): Include the facets in the response. The default is false.

    returnHighlights (optional): Include highlights in the response. The default is true.

    facetCount (optional): The maximum number of items to return for each facet (type integer). The default is 500.

    includeMasterResults (optional): Include results from Veeva OpenData with results of the customer data. The default uses the configuration of Veeva OpenData search.

    searchOnlyMaster (optional): Include results only from Veeva OpenData. The default is false. Veeva OpenData search must be enabled by configuration.

    filters (optional). The filters for refining the result, for example, Country, Region, or Specialty (type text). For child entity attributes, use the following aliases:

    Filters support scoped entity filters, which enable users to apply filters to a specific entity:

    Filters also support collection fields, which enable users to search an OR condition across a collection of fields during search. The fields must be enabled in the data model to be included in collection.

    fieldQueries (optional). The filters for refining the result (PARTIAL MATCH). For child entity attributes, use the following aliases:

    lang (optional): The language to run the query against. This is important when searching on reference values. For example, a search on “John Smith Pediatrics” will not return results for the specialty of pediatrics if the specified language is Chinese. If a language is not provided in the search query, the authenticated API user’s default language is used.

    systemName (optional): If provided, Network returns target alias values specified for reference value codes for this system. If not provided, Network returns default reference value codes.

    supplemental (optional): If provided, Network returns related parent HCOs of the entities found in the supplemental results.

    filterByLocation (optional). Search results are filtered by their proximity to the specified location. Results outside the specified distance are excluded. The parameter is a comma separated list of fields in the format of “latitude, longitude, distance, bottomRightLatitude, bottomRightLongitude, filterType”:

    sortByLocation (optional). Search results are sorted by their proximity to the specified location. The parameter is a geo coordinate pair in the form latitude,longitude (for example 38.889931,-77.009003). Sort by location cannot be combined with sort by other attributes.

    sortResultChildren (optional). For search results containing Addresses, Licenses or Parent HCOs, they will be sorted starting with the most relevant result. Default is false.

    The returnHighlights flag must also be true for this functionality.

    Address sort rules:

    License sort rules:

    Parent HCO sort rules:

    nestChildObjectFieldQueries (optional). Specifies whether or not to apply nesting to child object clauses. This will convert a requested field query into a fuzzy matching filter on the same field. The default is false.

    NOTES:

    parenthcofilters (optional). Specifies the filters for parent HCO results. Parent HCOs in the parent_hco__v and supplementalResults sections will be returned if they pass these filters. The format is identical to filters but does not support filtering by child entities of the HCO.

    Sample request

    GET https://my.veevanetwork.com/api/v16.0/search?q=bob&offset=0&limit=3&types=HCP&filters=birth_year_v:1958&filters=address.country__v:US&filters=primary_country_v:US

    Filter by location:

    Find records in a circle with center at 40.7,-74 and a radius of 1km.

    GET https://my.veevanetwork.com/api/v16.0/search?q=*&filterByLocation=40.7,-74,1km

    Find records in a circle with center at 40.7,-74 and a radius of 5km.

    GET https://my.veevanetwork.com/api/v16.0/search?q=*&sortByLocation=40.7,-74&filterByLocation=40.7,-74,5km,,,DISTANCE

    Find records in a box with center at 40.7,-74 and a distance of 5km from center to each edge.

    GET https://my.veevanetwork.com/api/v16.0/search?q=*&sortByLocation=40.7,-74&filterByLocation=40.7,-74,5km,,,BOUNDING_BOX

    Find records in a box with top left corner at 41.7,-75 and bottom right corner at 40.5,-74.

    GET https://my.veevanetwork.com/api/v16.0/search?q=*&filterByLocation=41.7,-75,,40.5,-74,BOUNDING_BOX

    Response

    On success, Network returns the response status confirming success of the reception and the set of entities in JSON format: HCPs and/or HCOs (including Addresses, Licenses, and ParentHCOs.

    responseStatus: The status of the response from Network.

    entities - An array of attribute information objects:

    Name Description
    entityId The Network ID of the entity.
    entityType The entity type, either HCP or HCO.
    metaData An array of attribute information objects:

    • highlightTerms - the extracted terms from the highlights
    • resultIsFromMaster - specifies whether the record is from Veeva OpenData when search against master is enabled
    • vid__v - the Network entity ID
    • relevance - the relevance score for the entity relative to other results
    • highlights - the exact results from the elastic search

    entity An array of attribute information objects containing all populated fields for the entities returned. An address child object may include the following fields:

  • geo_distance__u - A distance field. When sortByLocation is submitted, the addresses in the results return the distance in kilometers from the specified location.

  • totalCount: The total number of records hitting the search, regardless of limit.

    offset: The pagination number. The default is 0.

    limit: The number provided to limit the results.

    supplementalResults: An array of attribute information objects containing details of the parent HCOs returned on the results.

    Notes

    Managing subscriptions

    System interfaces represent the source and target systems and subscriptions for importing and exporting data to and from Network. These APIs enable you to retrieve information about the different systems and configured subscriptions, and about the jobs configured for each of them.

    Create a subscription job

    Sample response

    {
       "responseStatus": "SUCCESS",
       "job_id": 63259874100112525  
    }
    

    This API enables you to create a subscription job.

    Note: This API requires system administrator or API-only permissions.

    Compatibility

    This API uses the POST HTTP method and is available in the following:

    Syntax

    https://<DNS>/api/<version>/subscription/<subscription_name>/job

    where:

    Parameters

    The following parameters are supported for target subscriptions; other types do not use parameters:

    Sample request

    POST https://my.network.com/api/v11.0/subscription/CRM_Import/job

    Response

    responseStatus: The status of the response from Network.

    jobId: The unique ID of the job generated for the source subscription you specified.

    Notes

    None

    Cancel a subscription job

    Sample response

    {
       "responseStatus": "SUCCESS"
    }
    

    This API enables you to cancel a subscription job.

    Note: This API requires system administrator or API-only permissions.

    Compatibility

    This API uses the DELETE HTTP method and is available in the following:

    https://<DNS>/api/<version>/job/<job_id>

    where:

    Parameters

    None

    Sample request

    DELETE https://my.network.com/api/v11.0/job/63259874100112525

    Response

    responseStatus: The status of the response from Network.

    Notes

    This API will fail if:

    Since the request to cancel the job is asynchronous, there is no guarantee the request was successful. A status of Success is returned except for the cases listed above.

    Retrieve a subscription job status

    Sample response

    {
       "responseStatus": "SUCCESS",
       "job_status": "Pending"
    }
    

    This API enables you to retrieve the status of a source or target subscription job.

    Compatibility

    This API uses the GET HTTP method and is available in the following:

    Syntax

    https://<DNS>/api/<version>/job/<job_id>

    where:

    Parameters

    None

    Sample request

    GET https://my.network.com/api/v16.0/job/63259874100112525

    Response

    responseStatus: The status of the response from Network.

    job_status: The status of the job for the subscription that you specified. One of:

    Notes

    None

    Create a source subscription job

    Sample response

    {
       "responseStatus": "SUCCESS",
       "job_id": 63259874100112525  
    }
    

    This API enables you to create a source subscription job.

    Note: This API requires system administrator or API-only permissions.

    Compatibility

    This API uses the POST HTTP method and is available in the following:

    Syntax

    https://<DNS>/api/<version>/systems/<system_name>/source_subscriptions/<subscription_name>/job

    where:

    Parameters

    None

    Sample request

    POST https://my.network.com/api/v16.0/systems/CRM/source_subscriptions/CRM_Import/job

    Response

    responseStatus: The status of the response from Network.

    jobId: The unique ID of the job generated for the source subscription you specified.

    Notes

    None

    Cancel a source subscription job

    Sample response

    {
       "responseStatus": "SUCCESS"
    }
    

    This API enables you to cancel a source subscription job.

    Note: This API requires system administrator or API-only permissions.

    Compatibility

    This API uses the DELETE HTTP method and is available in the following:

    Syntax

    https://<DNS>/api/<version>/systems/<system_name>/source_subscriptions/<subscription_name>/job/<job_id>

    where:

    Parameters

    None

    Sample request

    DELETE https://my.network.com/api/v16.0/systems/CRM/source_subscriptions/CRM_Import/job/63259874100112525

    Response

    responseStatus: The status of the response from Network.

    Notes

    This API will fail if:

    Since the request to cancel the job is asynchronous, there is no guarantee the request was successful. A status of Success is returned except for the cases listed above.

    Retrieve source subscription job status

    Sample response

    {
       "responseStatus": "SUCCESS",
       "subscriptionId": 7,
       "subscriptionName": "master_data_ams",
       "durationInMilliseconds": 274000,
       "type": "MANUAL",
       "errorCount": 0,
       "badRecordCount": 0,
       "recordCount": 7826,
       "filesProcessed": 5,
       "dataLoadSummary": {
          "RELATIONSHIP": {
             "rowsRead": 315,
             "rowsParsed": 315
          },
          "HCO": {
             "rowsRead": 775,
             "rowsParsed": 775
          },
          "HCP": {
             "rowsRead": 1000,
             "rowsParsed": 1000
          },
          "ADDRESS": {
             "rowsRead": 1775,
             "rowsParsed": 1775
          },
          "LICENSE": {
             "rowsRead": 3961,
             "rowsParsed": 3961
          }
       },
       "processedDataSummary": {
          "HCP": 1000,
          "HCO": 775,
          "ADDRESS": 1775,
          "LICENSE": 3961,
          "PARENTHCO": 315,
          "CUSTOMKEYS": 0
       },
       "matchSummary": {
          "HCP": {
             "notMatched": 1000,
             "ACT": 0,
             "ASK": 0
          },
          "HCO": {
             "notMatched": 775,
             "ACT": 0,
             "ASK": 0
          }
       },
       "jobResultSummary": {
          "HCP": {
             "total": 1000,
             "newRecordsAdded": 1000,
             "recordsMerged": 0
          },
          "HCO": {
             "total": 775,
             "newRecordsAdded": 775,
             "recordsMerged": 0
          },
          "ADDRESS": {
             "total": 1775,
             "newRecordsAdded": 1775,
             "recordsMerged": 0
          },
          "LICENSE": {
             "total": 3961,
             "newRecordsAdded": 3961,
             "recordsMerged": 0
          },
          "PARENTHCO": {
             "total": 315,
             "newRecordsAdded": 315,
             "recordsMerged": 0
          }
       },
       "job_id": 7,
       "job_status": "COMPLETE",
       "created_date": "2014-11-25T12:11:21.000-08:00",
       "completed_date": "2014-11-25T12:15:55.000-08:00"
    }
    

    Sample response (custom objects)

    {
        "responseStatus": "SUCCESS",
        "job_id": 28596,
        "job_status": "COMPLETE",
        "created_date": "2018-11-25T13:41:51.000-08:00",
        "subscriptionId": 166,
        "subscriptionName": "Demo_Employee_Account",
        "completed_date": "2018-11-25T13:42:00.000-08:00",
        "durationInMilliseconds": 9000,
        "type": "MANUAL",
        "errorCount": 0,
        "badRecordCount": 0,
        "recordCount": 79,
        "filesProcessed": 3,
        "dataLoadSummary": {
            "HCP": {
                "rowsRead": 17,
                "rowsParsed": 17
            },
            "HCO": {
                "rowsRead": 16,
                "rowsParsed": 16
            },
            "EMPLOYEE_HCO_REL__C": {
                "rowsRead": 15,
                "rowsParsed": 15
            },
            "EMPLOYEE__C": {
                "rowsRead": 14,
                "rowsParsed": 14
            },
            "EMPLOYEE_HCP_REL__C": {
                "rowsRead": 17,
                "rowsParsed": 17
            }
        },
        "processedDataSummary": {
            "HCP": 17,
            "HCO": 16,
            "EMPLOYEE_ACCOUNT_REL__C": 32,
            "EMPLOYEE__C": 14
        },
        "matchSummary": {
            "PAYER": {
                "notMatched": 0,
                "ACT": 0,
                "ASK": 0
            },
            "HCP": {
                "notMatched": 0,
                "ACT": 17,
                "ASK": 0
            },
            "HCO": {
                "notMatched": 0,
                "ACT": 16,
                "ASK": 0
            },
            "EMPLOYEE__C": {
                "notMatched": 0,
                "ACT": 14,
                "ASK": 0
            },
            "PLAN": {
                "notMatched": 0,
                "ACT": 0,
                "ASK": 0
            }
        },
        "jobResultSummary": {
            "PARENTHCO": {
                "total": 47,
                "newRecordsAdded": 0,
                "recordsUpdated": 47,
                "recordsMerged": 0,
                "recordsInvalidated": 0,
                "recordsSkipped": 0
            },
            "HCP": {
                "total": 17,
                "newRecordsAdded": 0,
                "recordsUpdated": 16,
                "recordsMerged": 0,
                "recordsInvalidated": 0,
                "recordsSkipped": 1
            },
            "HCO": {
                "total": 16,
                "newRecordsAdded": 0,
                "recordsUpdated": 14,
                "recordsMerged": 0,
                "recordsInvalidated": 0,
                "recordsSkipped": 2
            },
            "EMPLOYEE_ACCOUNT_REL__C": {
                "total": 12,
                "newRecordsAdded": 12,
                "recordsUpdated": 0,
                "recordsMerged": 0,
                "recordsInvalidated": 0,
                "recordsSkipped": 0
            },
            "ADDRESS": {
                "total": 54,
                "newRecordsAdded": 0,
                "recordsUpdated": 54,
                "recordsMerged": 0,
                "recordsInvalidated": 0,
                "recordsSkipped": 0
            },
            "CUSTOMKEY": {
                "total": 12,
                "newRecordsAdded": 12,
                "recordsUpdated": 0,
                "recordsMerged": 0,
                "recordsInvalidated": 0,
                "recordsSkipped": 0
            },
            "EMPLOYEE__C": {
                "total": 14,
                "newRecordsAdded": 0,
                "recordsUpdated": 14,
                "recordsMerged": 0,
                "recordsInvalidated": 0,
                "recordsSkipped": 0
            },
            "LICENSE": {
                "total": 14,
                "newRecordsAdded": 0,
                "recordsUpdated": 14,
                "recordsMerged": 0,
                "recordsInvalidated": 0,
                "recordsSkipped": 0
            }
        }
    }
    

    This API enables you to retrieve the status of a source subscription job.

    Compatibility

    This API uses the GET HTTP method and is available in the following:

    Syntax

    https://<DNS>/api/<version>/systems/<system_name>/source_subscriptions/<subscription_name>/job/<job_id>

    where:

    Parameters

    None

    Sample request

    GET https://my.network.com/api/v16.0/systems/CRM/source_subscriptions/CRM_Import/job/63259874100112525

    Response

    responseStatus: The status of the response from Network.

    subscriptionId: The ID of the subscription.

    subscriptionName: The name of the subscription.

    durationInMilliseconds: The total duration of the job.

    type: The type of the job; for example, Manual for a manually run subscription.

    errorCount: The number of errors.

    badRecordCount: The number of bad records.

    recordCount: The total number of records.

    filesProcessed: The number of files processed.

    dataLoadSummary - For each object type:

    processedDataSummary: For each entity type type, the total number of rows processed.

    matchSummary - For each entity type the total match results:

    jobResultSummary: For each entity type, the total number of records processed, added, and merged:

    job_id: The ID of the job.

    job_status: The status of the job for the source subscription that you specified. One of:

    created_date: The date the job was created, in GMT.

    completed_date: The date and time the job completed.

    Notes

    None

    Create a target subscription job

    Sample response

    {
       "responseStatus": "SUCCESS",
       "job_id": 47  
    }
    

    This API enables you to create a target subscription job.

    Note: This API requires system administrator or API-only permissions.

    Compatibility

    This API uses the POST HTTP method and is available in the following:

    Syntax

    https://<DNS>/api/<version>/systems/<system_name>/target_subscriptions/<subscription_name>/job

    where:

    Parameters

    data_revision_first (optional): Start data revision for the job.

    data_revision_last (optional): End data revision for the job.

    apply_data_revisions_for_delta_export_only (optional): Apply start and end data revision parameters only if the target subscription is a delta export. If True and the start data revision parameter is specified, the target subscription will only run as a delta export if it is configured as a delta export. If False and the start data revision parameter is specified, the target subscription will run as a delta export. The default is False.

    Sample request

    POST https://my.veevanetwork.com/api/v16.0/systems/CRM/target_subscriptions/Export/job?data_revision_first=2363463216010373133

    Response

    responseStatus: The status of the response from Network.

    jobId: The unique ID of the job generated for the target subscription you specified.

    Notes

    Errors will occur in the following circumstances:

    Cancel a target subscription job

    Sample response

    {
       "responseStatus": "SUCCESS"
    }
    

    This API enables you to cancel a target subscription job.

    Note: This API requires system administrator or API-only permissions.

    Compatibility

    This API uses the DELETE HTTP method and is available in the following:

    Syntax

    https://<DNS>/api/<version>/systems/<system_name>/target_subscriptions/<subscription_name>/job/<job_id>

    where:

    Parameters

    None

    Sample request

    DELETE https://my.network.com/api/v16.0/systems/CRM/target_subscriptions/CRM_Import/job/63259874100112525

    Response

    responseStatus: The status of the response from Network.

    Notes

    This API will fail if:

    Since the request to cancel the job is asynchronous, there is no guarantee the request was successful. A status of Success is returned except for the cases listed above.

    Retrieve target subscription job status

    Sample response

    {
      "responseStatus":"SUCCESS",
      "subscriptionId":7,
      "subscriptionName":"test",
      "durationInMilliseconds":12000,
      "type":"MANUAL",
      "errorCount":4,
      "badRecordCount":4,
      "exportHCPCount":1183,
      "exportHCOCount":0,
      "exportAddrCount":0,
      "exportLicenseCount":0,
      "exportParentHCOCount":0,
      "exportCustomKeyCount":0,
      "exportReferenceCount":11772,
      "exportFull":true,
      "exportIncludeReference":true,
      "exportUpdatedChildOnly":false,
      "exportSetSubscriptionStateOnFull":false,
      "exportFormat":"CSV",
      "exportReferenceVersion":"2",
      "exportActiveOnly":true,
      "exportEncoding":"UTF-8",
      "exportPackageName":"test_${timestamp}",
      "job_id":408,
      "job_status":"COMPLETE",
      "created_date":"2015-02-12T15:53:51.000-05:00",
      "data_revision_first":"0",
      "data_revision_last":"581137545421652992",
      "export_package_path":"export/customer/test/exp_00000198.zip",
      "total_records_exported":"1183",
      "completed_date":"2015-02-12T15:54:03.000-05:00"
    }
    

    Sample response (custom objects)

    {
        "responseStatus": "SUCCESS",
        "job_id": 28588,
        "job_status": "COMPLETE",
        "created_date": "2018-11-25T11:56:31.000-08:00",
        "data_revision_first": "0",
        "data_revision_last": "933512084632993791",
        "export_package_path": "outbound/Demo/Employee_Export/exp_00006FAC.zip",
        "total_records_exported": "30216",
        "subscriptionId": 167,
        "subscriptionName": "Employee_Export",
        "completed_date": "2018-11-25T11:56:39.000-08:00",
        "durationInMilliseconds": 8000,
        "type": "MANUAL",
        "errorCount": 0,
        "badRecordCount": 0,
        "exportReferenceCount": 0,
        "exportFull": true,
        "exportIncludeReference": false,
        "exportUpdatedChildOnly": false,
        "exportSetSubscriptionStateOnFull": false,
        "exportFormat": "CSV",
        "exportReferenceVersion": "4",
        "exportActiveOnly": true,
        "jobExportCount": {
            "PARENTHCO": 1059,
            "HCP": 15280,
            "HCO": 14922,
            "ADDRESS": 31422,
            "EMPLOYEE_ACCOUNT_REL__C": 6,
            "CUSTOMKEY": 83179,
            "EMPLOYEE__C": 14,
            "LICENSE": 16266
        }
    }
    

    This API enables you to retrieve the status of a target subscription job.

    Compatibility

    This API uses the GET HTTP method and is available in the following:

    Syntax

    https://<DNS>/api/<version>/systems/<system_name>/target_subscriptions/<subscription_name>/job/<job_id>

    where:

    Parameters

    None

    Sample request

    GET https://my.network.com/api/v16.0/systems/CRM/target_subscriptions/CRM_Export/job/63259874100112525

    Response

    responseStatus: The status of the response from Network.

    subscriptionId: The ID of the subscription.

    subscriptionName: The name of the subscription.

    durationInMilliseconds: The total duration of the job.

    type: The type of the job; for example, Manual for a manually run subscription.

    errorCount: The number of errors.

    badRecordCount: The number of bad records.

    exportHCPCount: The number of HCPs exported.

    exportHCOCount: The number of HCOs exported.

    exportAddrCount: The number of addresses exported.

    exportLicenseCount: The number of licenses exported.

    exportParentHCOCount: The number of Parent HCOs exported.

    exportCustomKeyCount: The number of custom keys exported.

    exportReferenceCount: The number of reference data values exported.

    exportFull: Whether or not the job is a full data export.

    exportIncludeReference: Whether or not the export includes reference data files.

    exportUpdatedChildOnly: Whether or not the job is set to export only updated child objects.

    exportSetSubscriptionStateOnFull: Whether or not the subscription was set to save the delta state.

    exportFormat: The format of the export file (for example, CSV).

    exportReferenceVersion: The version for the reference data file.

    exportActiveOnly: Whether or not the subscription is set to export active records only.

    exportEncoding: The encoding of the export file (for example, UTF-8).

    job_id: The ID of the job.

    job_status: The status of the job for the target subscription that you specified. One of:

    created_date: The date the job was created, in GMT.

    data_revision_first: Start data revision for the job.

    data_revision_last: End data revision for the job.

    export_package_path: The export file location, including the file name.

    total_records_exported: The total number of records exported.

    completed_date: The date and time the job completed.

    jobExportCount - The list of exported entity and child counts. Replaces the following fields:

    Notes

    If no revisions exist in the provided range:

    Create a compliance subscription job

    Sample response

    {
       "responseStatus": "SUCCESS",
       "job_id": 63259874100112525  
    }
    

    This API enables you to create a compliance subscription job.

    Note: This API requires system administrator or API-only permissions.

    Compatibility

    This API uses the POST HTTP method and is available in the following:

    Syntax

    https://<DNS>/api/<version>/systems/compliance_subscriptions/<subscription_name>/job

    where:

    Parameters

    None

    Sample request

    POST https://my.veevanetwork.com/api/v16.0/systems/compliance_subscriptions/umd_us__v/job

    Response

    responseStatus: The status of the response from Network.

    jobId: The unique ID of the job generated for the compliance subscription you specified.

    Notes

    None

    Cancel a compliance subscription job

    Sample response

    {
       "responseStatus": "SUCCESS"
    }
    

    This API enables you to cancel a compliance subscription job.

    Note: This API requires system administrator or API-only permissions.

    Compatibility

    This API uses the DELETE HTTP method and is available in the following:

    Syntax

    https://<DNS>/api/<version>/systems/compliance_subscriptions/<subscription_name>/job/<job_id>

    where:

    Parameters

    None

    Sample request

    DELETE https://my.veevanetwork.com/api/v16.0/systems/compliance_subscriptions/umd_us__v/job/254

    Response

    responseStatus: The status of the response from Network.

    Notes

    This API will fail if:

    Since the request to cancel the job is asynchronous, there is no guarantee the request was successful. A status of Success is returned except for the cases listed above.

    Retrieve a compliance subscription job

    Sample response

    {
        "responseStatus": "SUCCESS",
        "subscriptionId": 12,
        "subscriptionName": "umd_us__v",
        "durationInMilliseconds": 2000,
        "type": "COMPLIANCE",
        "errorCount": 0,
        "badRecordCount": 0,
        "crossReferenceDetails": [
            {
                "object": "HCO",
                "source": "NPI",
                "count": 2819,
                "matched": false
            },
            {
                "object": "HCP",
                "source": "SLN",
                "count": 1835,
                "matched": false
            },
            {
                "object": "HCP",
                "source": "SLN",
                "count": 13881,
                "matched": false
            },
            {
                "object": "HCO",
                "source": "CMS_TEACHING_HOSPITAL",
                "count": 826,
                "matched": false
            },
            {
                "object": "HCO",
                "source": "DEA",
                "count": 30,
                "matched": false
            },
            {
                "object": "HCP",
                "source": "NPI",
                "count": 6578,
                "matched": false
            },
            {
                "object": "HCP",
                "source": "DEA",
                "count": 106,
                "matched": false
            },
            {
                "object": "HCP",
                "source": "DEA",
                "count": 6263,
                "matched": false
            },
            {
                "object": "HCO",
                "source": "CMS_TEACHING_HOSPITAL",
                "count": 5532,
                "matched": false
            },
            {
                "object": "HCO",
                "source": "NPI",
                "count": 5730,
                "matched": false
            },
            {
                "object": "HCP",
                "source": "NPI",
                "count": 494,
                "matched": false
            },
            {
                "object": "HCO",
                "source": "DEA",
                "count": 44,
                "matched": false
            }
        ],
        "job_id": 350,
        "job_status": "COMPLETE",
        "created_date": "2015-10-16T08:14:57.000-07:00",
        "export_package_path": "outbound/US_Compliance_Target_Subscription/source_data_150715T205219904_job_0000010C.zip",
        "completed_date": "2015-10-16T08:14:59.000-07:00"
    }
    

    This API enables you to retrieve the status of a source subscription job.

    Compatibility

    This API uses the GET HTTP method and is available in the following:

    Syntax

    https://<DNS>/api/<version>/systems/compliance_subscriptions/<subscription_name>/job/<job_id>

    where:

    Parameters

    None

    Sample request

    GET https://my.veevanetwork.com/api/v16.0/systems/compliance_subscriptions/umd_us__v/job/254

    Response

    responseStatus: The status of the response from Network.

    job_id: The ID of the job.

    job_status: The status of the job created for the compliance subscription provided in the URL.

    created_date: The date the job was created, in GMT.

    subscriptionId: The ID of the subscription.

    subscriptionName: The name of the subscription.

    completed_date: The date and time the job completed.

    durationInMilliseconds: The total duration of the job.

    type: The type of the job; for example, Manual for a manually run subscription.

    errorCount: The number of errors.

    badRecordCount: The number of bad records.

    export_package_path: The export file location, including the file name.

    crossReferenceDetails: An array of cross-reference counts:

    Notes

    None

    System settings

    The system settings API enable you to retrieve values for system settings. Currently, this API supports retrieval of the geo location setting.

    Retrieve system setting

    Sample response

    {
      "responseStatus":"SUCCESS",
      "configurationValue":"US,FR"
    }
    

    This API enables you to retrieve the value for a system setting.

    Compatibility

    This API uses the GET HTTP method and is available in the following:

    Syntax

    https://<DNS>/api/<version>/systemSettings/settingKey

    where:

    Parameters

    None

    Sample request

    GET https://my.veevanetwork.com/api/v16.0/systemSettings/api.search.geolocation.countries

    Response

    responseStatus: The status of the response from Network.

    configurationValue - The value for the system setting.

    errors - An array of errors:

    type - the error type

    message - a detailed message for the error type. This message is subject to change and is not contractual for error handling.

    About entity types

    Level Customer Master
    Top-level entity types HCP, HCO, CUSTOM OBJECTS (for example, TERRITORY__C, ROSTER_MEMBER__C, and so on)
    Sub-object entity types LICENSE, ADDRESS, RELATION (PARENT_HCOS), CHILD OBJECT (CUSTOM CHILD OBJECTS)

    About the vid_key

    The vid_key is a unique identifier for any record that comes from the client application. This special key enables you to uniquely specify a record in Network by using any of the key identifiers that were used to build that record. The vid_key format is composed of the following fields, separated by colons: * custom_key_source_type_v - The source type specified when the data is loaded (for example, Network, VCRM, IMS, HDS, SHA, AMA). * custom_key_item_typev - The type of item this key is for. This is used to discriminate between duplicate IDs that are meant for different objects. For example, a data source may have used tables with incrementing IDs for both addresses and license data, which means you could have two records with an ID of 1. * custom_key_value_v - The value of the key itself.

    The vid_key for an HCP that was loaded from an existing Veeva CRM system could look like this, for example:

    VCRM:HCP:001A000000pKagwIAC

    Network will support the vid_key as long as it has the proper format.

    However, for more efficient and faster processing, you should use the vid_key composed from Network when possible. The vid_key format for all the network entities is always as follows:

    Network:Entity:<vid__v> = specific_HCO_or_HCP_entity_key

    Network:Address:<vid__v> = specific_address_key

    Network:License:<vid__v> = specific_license_key

    Network:ParentHCO:<vid__v> = specific_ParentHCO_key

    Custom objects

    The vid_key for a custom object can be defined using the following methods:

    Finding the key

    The fields that make up the vid_key are concatenated in a single field called custom_key_vid_key__v. This field appears many times when a search API call is made. The correct one to use for HCP and HCOs is

    entities --> entity --> custom_keys__v --> custom_key_vid_key__v

    Errors

    Sample successful authentication request

    {
       "networkId": 3,
       "sessionId": "1BDDF2B9DB53279C105B0D534B630FDAF68655D68EAA23B65C404FE96E607C44",
       "networkIds": [
          {
             "url": "https://my.network.com/api",
             "name": "Example Network",
             "id": 3
          }
       ],
       "responseStatus": "SUCCESS"
    }
    

    Sample unsuccessful authentication request

    {
       "responseStatus": "FAILURE",
       "errors": [
          {
             "type": "NO_PASSWORD_PROVIDED",
             "message": "No password was provided for the login call."
          }
       ],
       "errorType": "AUTHENTICATION_FAILED"
    }
    

    Every API call response includes a property called responseStatus. Possible values are:

    For any status other than SUCCESS, API users can inspect the errors property called in the response for more information. This property lists any errors that occur while processing the request. For successful API calls, this property is omitted or has a null value.

    The errors property includes the following information:

    Error types

    Type Status code Description
    ATTRIBUTE_NOT_SUPPORTED 400 - Bad Request The specified resource does not recognize the attributes provided.
    CANNOT_ACCESS_INSTANCE 400 - Bad Request The system name is invalid.
    COUNTRY_NOT_ALLOWED 400 - Bad Request The API user does not have permissions to use records from the submitted country.
    COUNTRY_NOT_RECOGNIZED 400 - Bad Request The submitted country is not recognized in Network. Ensure that you use Network codes when sending country information.
    DUPLICATE_KEY 400 - Bad Request A change request has been submitted with the same external identifier (change_request_key that has already previously been submitted.
    INVALID_DATA 400 - Bad Request Invalid data was provided in the API call.
    INVALID_FILTER 400 - Bad Request A non-existent filter was provided to match HCPs or HCOs.
    INVALID_SYSTEM_NAME 400 - Bad Request There are no active instances in your domain.
    IP_RANGE 400 - Bad Request The IP range is invalid for this user.
    MISSING_REQUIRED_VALUE 400 - Bad Request A required value is missing.
    NO_ACTIVE_INSTANCES 400 - Bad Request There are no active instances in your domain.
    OPERATION_NOT_ALLOWED 400 - Bad Request Certain rules required for this operation have not been met.
    PARAMETER_REQUIRED 400 - Bad Request Required parameters are missing from the API call.
    SUBSCRIPTION_DISABLED 400 - Bad Request The subscription is disabled and cannot be run.
    UNSUPPORTED_TYPE 400 - Bad Request The object type is not supported.
    NO_PASSWORD_PROVIDED 401 - Unauthorized No password was provided for the login call.
    PASSWORD_CHANGE_REQUIRED 401 - Unauthorized A password change is required.
    USER_LOCKED_OUT 401 - Unauthorized The user is locked out.
    USERNAME_OR_PASSWORD_
    INCORRECT
    401 - Unauthorized Authentication failed because an invalid user name or password was provided.
    INSUFFICIENT_ACCESS 403 - Forbidden The user does not have sufficient privileges to perform the action.
    MALFORMED_URL 404 - Not Found The specified resource cannot be found.
    METHOD_NOT_SUPPORTED 405 - Method Not Allowed The specified resources does not support the method (POST, PUT, GET, DELETE) or the API request is not supported by this version of the API.
    INVALID_SESSION_ID 454 - Session Not Found An invalid session ID was provided.
    SERVER_NOT_AVAILABLE 500 - Internal Server Error The server is not available.
    SERVER_NOT_RESPONDING 500 - Internal Server Error The server accepted the request but is not responding.
    UNEXPECTED_ERROR 500 - Internal Server Error General error; occurs when there is no specific error or an unidentified error