Agency One: Store Unique Identifiers from Other Vertafore Products

Note: This update represents only a portion of the AMS360 24R1 release. Please navigate to AMS360 2024 R1 Release Notes to review other enhancements and fixes that were part of this release.

Four new endpoints have been added to EMS to allow external Vertafore applications to align entities in their applications (e.g., customers) with entities in AMS360. These entities are linked via their identifiers.

These four endpoints are as follows:

  • POST /external-entity

    • Creates a new association between an external entity and an AMS360 entity

  • GET /external-entity/external-keys

    • Gets the external entity key(s) associated to an AMS360 entity

  • GET /external-entity/ams-key

    • Gets the AMS360 entity key associated to an external entity

  • PUT /external-entity

    • Modifies an association between an external entity and an AMS360 entity

  • DELETE /external-entity

  • Removes an association between an external entity and an AMS360 entity.

 

NOTE: Only customer entities are supported in this release; however, future enhancements will add additional entities.

Adding a New Entity Association

  • To associate an external entity to an AMS360 entity, the POST / external-entity EMS endpoint should be used.

  • Given the type of the entity, the identifier for the external entity, the unique identifier for the AMS360 entity, and an external application, this endpoint creates a new “external entity” resource that represents a new entity association.

Viewing External Entity Keys

  • To view the external entity keys associated to an AMS360 entity, the GET / external-entity/external-keys endpoint should be used.

  • There are two workflows for this endpoint:

    • Given an entity type and an AMS360 entity key, it returns all associated external entity keys.

    • Given an entity type, an AMS360 entity key, and an external application, it returns the external entity key associated with the external application.

Viewing AMS360 Entity Keys

  • To view an AMS360 entity key associated with an external entity, the GET / external-entity/ams-key endpoint should be used.

  • Given the type of entity, the identifier for the external entity, and the external application, this endpoint returns the associated AMS360 entity key.

Modifying an Entity Association

  • To modify the association between an external entity and an AMS360 entity, the PUT / external-entity EMS endpoint should be used.

  • Given the type of the entity, a new identifier for the external entity, the unique identifier an AMS360 entity, and an external application, this endpoint updates an existing “external entity” resource with the new external entity key.

Removing an Entity Association

  • To remove the association between an external entity and an AMS360 entity, the DELETE / external-entity EMS endpoint should be used.

  • Given the type of the entity, the identifier for the external entity, and the unique identifier for the AMS360 entity, this endpoint deletes the matching “external entity" resource.