Federated Hermes User API

The Federated Hermes User API is a RESTful API that can be used to retrieve information about Federated Hermes' user centric data.

The API has typical RESTful characteristics and uses JSON or XML for the output.

For more information on usage and how to get started Contact Us.


Special Case Data Type Syntax
data type context for syntax
Integer / Long
  • "?parameter=123": parameter equals "123"
  • "?parameter=-123": parameter not equals "123"
String (number)
  • "?parameter={"eq": 123}": parameter equals "123"
  • "?parameter={"ne": 123}": parameter not equals "123"
  • "?parameter={"gt": 100, "lt": 200}": parameter is greater than "100" and less than "200"
  • "?parameter={"gte": 100, "lte": 200}": parameter is greater than or equal to "100" and less than or equal to "200"
  • "?parameter={"gte": 100, "lte": 200, "ne": 150}": parameter is greater than or equal to "100" and less than or equal to "200" and not equal to "150"
  • Integer / Long syntax will also work with these fields.
String (text)
  • "?parameter=abc": parameter case sensitive equals "abc"
  • "?parameter=-abc": parameter case sensitive not equals "abc"
  • "?parameter=:abc": parameter case insensitive equals "abc"
  • "?parameter=!abc": parameter case insensitive not equals "abc"
  • "?parameter=*abc": parameter case sensitive like "*abc", where * is a wildcard
  • "?parameter=abc*": parameter case sensitive like "abc*", where * is a wildcard
  • "?parameter=*abc*": parameter case sensitive like "*abc*", where * is a wildcard
  • "?parameter=`abc": parameter case sensitive not like "*abc", where * is a wildcard
  • "?parameter=abc`": parameter case sensitive not like "abc*", where * is a wildcard
  • "?parameter=`abc`": parameter case sensitive not like "*abc*", where * is a wildcard
  • "?parameter=~abc": parameter case insensitive like "*abc", where * is a wildcard
  • "?parameter=abc~": parameter case insensitive like "abc*", where * is a wildcard
  • "?parameter=~abc~": parameter case insensitive like "*abc*", where * is a wildcard
  • "?parameter=|abc": parameter case insensitive not like "*abc", where * is a wildcard
  • "?parameter=abc|": parameter case insensitive not like "abc*", where * is a wildcard
  • "?parameter=|abc|": parameter case insensitive not like "*abc*", where * is a wildcard
String (orderBy)
  • "?orderBy=name": order the results by name in ascending order
  • "?orderBy=-name": order the results by name in descending order
  • "?orderBy=name,date": order the results by name in ascending order and then order the results by date in ascending order
  • "?orderBy=name,-date": order the results by name in ascending order and then order the results by date in descending order
String (date / date range)
  • "?parameter=2018-01-01": parameter=2018-01-01
  • "?parameter={2018-01-01,2018-04-08}": (parameter >= 2018-01-01 and parameter <= 2018-04-08)
  • "?parameter={2018-01-01,}": (parameter >= 2018-01-01)
  • "?parameter={,2018-04-08}": (parameter <= 2018-04-08)
  • "?parameter={2018-01-01;2018-04-08}": (parameter > 2018-01-01 and parameter < 2018-04-08)
  • "?parameter={2018-01-01;}": (parameter > 2018-01-01)
  • "?parameter={;2018-04-08}": (parameter < 2018-04-08)
  • "?parameter={2018-01-01>2018-04-08}": (parameter >= 2018-01-01 and parameter < 2018-04-08)
  • "?parameter={2018-01-01>}": (parameter >= 2018-01-01)
  • "?parameter={>2018-04-08}": (parameter < 2018-04-08)
  • "?parameter={2018-01-01<2018-04-08}": (parameter > 2018-01-01 and parameter <= 2018-04-08)
  • "?parameter={2018-01-01<}": (parameter > 2018-01-01)
  • "?parameter={<2018-04-08}": (parameter <= 2018-04-08)

Resources

name path methods description
Authenticate
  • /user-service/v2/authenticate
  • POST
Authenticates a specified user to allow access to non-public_anonymous API calls. API calls within this web service have 3 different levels of authorization which are described below.
  1. "PUBLIC_ANONYMOUS": These API's do not require any authentication to use.
  2. "PUBLIC_AUTHENTICATED": These API's require authentication with a public role to use. Users with this role may also access PUBLIC_ANONYMOUS API's.
  3. "PRIVATE_AUTHENTICATED": These API's require authentication with a private role to use. Users with this role may also access PUBLIC_ANONYMOUS and PUBLIC_AUTHENTICATED API's.
Attempting to use a non-public_anonymous API call may result in the following HTTP status codes.
  1. 401: The token contains an invalid claim or the token has expired.
  2. 403: The Authorization header is missing, the Authorization header is invalid, or the token in the Authorization header contains insufficient privileges for this API call.
ContentCollectionItems
  • /user-service/v2/contentCollectionItems
  • /user-service/v2/contentCollectionItems/bulk
  • /user-service/v2/contentCollectionItems/bulkdelete
  • /user-service/v2/contentCollectionItems/shiftorder
  • /user-service/v2/contentCollectionItems/swaporder
  • /user-service/v2/contentCollectionItems/{id}
  • GET POST PUT
  • POST
  • POST
  • PUT
  • PUT
  • DELETE GET
Provides content collection items.
ContentCollectionViewItems
  • /user-service/v2/contentCollectionViewItems
  • /user-service/v2/contentCollectionViewItems/{id}
  • GET
  • GET
Provides content collection view items.
ContentCollections
  • /user-service/v2/contentCollections
  • /user-service/v2/contentCollections/{id}
  • /user-service/v2/contentCollections/{id}/items
  • GET POST PUT
  • DELETE GET POST
  • GET
Provides content collections.
EmailSpecificationProperties
  • /user-service/v2/emailSpecificationProperties
  • /user-service/v2/emailSpecificationProperties/bulk
  • /user-service/v2/emailSpecificationProperties/{id}
  • GET POST PUT
  • DELETE POST
  • DELETE GET
Provides email specification properties.
EmailSpecifications
  • /user-service/v2/emailSpecifications
  • /user-service/v2/emailSpecifications/bulk
  • /user-service/v2/emailSpecifications/{id}
  • /user-service/v2/emailSpecifications/{id}/properties
  • GET POST PUT
  • POST
  • DELETE GET
  • GET
Provides email specifications.
ExternalAuths
  • /user-service/v2/externalAuths
  • /user-service/v2/externalAuths/{id}
  • GET POST PUT
  • GET
Provides external authentications.
ExternalSites
  • /user-service/v2/externalSites
  • /user-service/v2/externalSites/{id}
  • GET
  • GET
Provides external sites.
FilterAttributes
  • /user-service/v2/filterAttributes
  • /user-service/v2/filterAttributes/{id}
  • GET POST PUT
  • DELETE GET
Provides filter attributes.
Filters
  • /user-service/v2/filters
  • /user-service/v2/filters/{id}
  • /user-service/v2/filters/{id}/filterAttributes
  • GET POST PUT
  • DELETE GET
  • GET
Provides filters.
OnetimeAuthTokens
  • /user-service/v2/onetimeAuthTokens
  • /user-service/v2/onetimeAuthTokens/{id}
  • GET POST PUT
  • DELETE GET
Provides one time authentication tokens.
RegistrationSources
  • /user-service/v2/registrationSources
  • /user-service/v2/registrationSources/{id}
  • GET
  • GET
Provides the registration sources.
RememberMeTokens
  • /user-service/v2/rememberMeTokens
  • /user-service/v2/rememberMeTokens/{id}
  • GET POST PUT
  • DELETE GET
Provides the remember me tokens.
Roles
  • /user-service/v2/roles
  • /user-service/v2/roles/{id}
  • GET
  • GET
Provides the roles.
SubscriptionItems
  • /user-service/v2/subscriptionItems
  • /user-service/v2/subscriptionItems/bulk
  • /user-service/v2/subscriptionItems/bulkdelete
  • /user-service/v2/subscriptionItems/{id}
  • GET POST PUT
  • POST
  • POST
  • DELETE GET
Provides subscription items.
SubscriptionViewItems
  • /user-service/v2/subscriptionViewItems
  • /user-service/v2/subscriptionViewItems/{id}
  • GET
  • GET
Provides subscription view items.
WatchListItems
  • /user-service/v2/watchListItems
  • /user-service/v2/watchListItems/bulk
  • /user-service/v2/watchListItems/bulkdelete
  • /user-service/v2/watchListItems/count
  • /user-service/v2/watchListItems/{id}
  • GET POST
  • POST
  • POST
  • GET
  • DELETE GET
Provides the watch list items.
WatchListViewItems
  • /user-service/v2/watchListViewItems
  • /user-service/v2/watchListViewItems/{id}
  • GET
  • GET
Provides watch list view items.
WebUserAttributes
  • /user-service/v2/webUserAttributes
  • GET POST PUT
Provides web user attributes.
WebUsers
  • /user-service/v2/webUsers
  • /user-service/v2/webUsers/count
  • /user-service/v2/webUsers/{id}
  • /user-service/v2/webUsers/{email}/unsubscribe
  • GET POST PUT
  • GET
  • DELETE GET
  • PUT
Provides web users.

Data Types

XML

Default Namespace
type description
collectionItemShiftOrderType
itemContentType
collectionItemShiftOrderRequest
collectionItemSwapOrderRequest
contentCollection
contentCollectionItem
contentCollectionViewItem
emailSpecification
emailSpecificationProperty
externalAuth
externalSite
filter
filterAttribute
itemCount
onetimeAuthToken
registrationSource
rememberMeToken
role
subscriptionItem
subscriptionViewItem
watchListItem
watchListViewItem
webUser
webUserAttribute
abstractResource
id
link