Profile Web Service Subscription (TMC Guide)

Owned by Malissa Olofernes
Last updated: Sept 30, 2024 by Ellen Tieberg
6 min read

Deem offers the User Profile web service, designed for partners and third-party application providers to manage user profiles efficiently. This service allows you to create, update, disable, or retrieve user profiles, which are collections of personal data linked to individual users. The User Profile web service delivers the essential user data needed for various transactions and interactions within services. 

Proper management and security of profile data are crucial for maintaining data integrity and privacy. This document provides a comprehensive technical specification to guide partners in accessing and utilizing the User Profile web service from their web service clients. 

Need to Know 

  • The User Profile web service utilizes Extensible Markup Language (XML) messages and adheres to the  Simple Object Access Protocol (SOAP) standard, which facilitates the exchange of structured information. 

  • Partners and application providers can develop web service clients to interact with the User Profile web service using the Web Service Definition Language (WSDL) file and schema provided in this document. WSDL is an XML format that describes network services by defining endpoints, expected parameters, and data structures in a machine-readable format. 

  • With the User Profile web service, web service clients can retrieve and update user profile information. Clients must specify the desired profile details in each request to minimize latency and avoid the performance overhead of multiple API calls. User identification is managed through an ID (externalID) provided during single sign-on (SSO) via Security Assertion Markup Language (SAML) identity assertion. 

  • or technical specifications related to session management and SSO integration, refer to Implementing Single Sign-On (SSO) for Desktop. 

  • To configure this subscription at the super-domain level for multiple sites, submit a Deem Support case to receive the instructions for configuring the web service at the super-domain. 

  • The following instructions pertain to site-level configuration. Settings configured in your template site will automatically apply to any new sites created from that template. 

Configure Web Service Subscription (WSS) at the Site Level 

To configure Web Services for a single site, you must add the subscription to a subscription set and associate this set with a user group using a web service rule. Follow these steps: 

Create/Update Web Services Subscription (WSS)

  1. Navigate to the partner dashboard home page and select Settings link corresponding to the site you want to modify.   

  2. Go to the Settings tab and select Web Services. 

    image-20240820-190430.png

  3. Select Profile Pull Web Service.

    image-20240820-192118.png

  1. Select Profile Pull Web Service Subscriptions.

  1. From the Subscriptions list, either:

    • Select an existing subscription to edit the subscription.

    • Select Add A New Subscription to create a new subscription.

  1. Add or edit the General Settings.

    1. In Subscription Name, enter the name for the subscription. 

    2. In Contact Name, enter the TMC contact name. 

    3. In Contact Email, enter the TMC contact email. 

    4. In Contact Phone, enter the TMC contact phone number. 

    5. Select the Web Service Type arrow to choose User Profile. 

  1. Add or edit Inbound Messages.

    1. Select the Mode arrow to choose Live. 

    2. Select the Inbound Message Unique Key arrow to select User Name / Login. 

    3. In Username, enter an 8-12 character alphanumeric username. 

    4. In Password: Enter an 8-12 character password, excluding ambiguous characters, such as & and <. 
      Note: Use a secure password generator to create these credentials. For example:

    5. In Reenter Password, enter the password again.

  2. Add or edit Permissions.
    Customers have the option to update their profile either within Deem or through a third-party system. Permissions vary on whether or not Deem is your master profile system.

    • Deem is the Master Profile

      The profile management tool pulls any profile updates/changes and additions from Deem to their system and pushes to the GDS. Configure two WSSs:

      • A WSS for PUSH/ADD/UPDATE

      • A WSS for PULL/CHANGES/DEACTIVATED

    • Deem is NOT the Master Profile System

      The external profile system pushes data into Deem and the GDS. All updates are managed by the external profile tool, which synchronizes data with both Deem and the GDS. |  

  1. Select Save to finalize the changes. 

Update/Confirm Web Service Subscription Set 

  1. Select the Back to Profile Pull Web Services link at the top of the page. 

  2. Select Profile Pull Web Service Subscription Sets link.

  1. From the list, either:

    • Select the existing subscription set to edit the set.

    • Select Add A New Subscription Set to create a new set.

  2.  If creating a new set, enter Set Name.

  3. Select Add Subscr. to display the Search & Add Code to Set screen.

  1. Click the radio button next to the name of the subscription you want to add, then click OK to add multiple subscriptions, select Ok & Add Another. 

  1. Click OK to finalize the changes. 

Update Confirm Web Services Rules

  1. Navigate to the Rules tab. 

  2. Select Web Services Rules link.  

  1. Choose Edit or Add to either verify that the correct Web Service Subscription is applied and activated for the group or to add and activate a new Web Service Subscription. 

  • The Add link indicates that no web services are currently established for the group. 

  • The Edit link in green indicates that web services are established for the group and are active. 

  • The Edit link in yellow indicates that web services are established for the group but are inactive.

  1. Optional. Enter a Description for the rule that is easily recognizable. 

  2. Select Activate Rule. 

  3. Select Enable Web Services using the following configuration sets. 

  4. Select the desired Web Service Subscription from the list. 

  5. Select Save. 

  1. Select Save Priority Changes. 

  1. Select the changes not applied link in the top right corner of the page, to finalize all changes.

  1. Test the configuration to ensure that it operates as expected. 

Â