REST API response messages - CustomerID

Owned by Tomi Pelttari
2020-06-17

XML Schema

Ubisecure CustomerID REST API XML Schema

  • cid-2.1.xsd for https://HOSTNAME/customerid-rest/services/2.1/ endpoint.
  • cid-2.0.xsd for https://HOSTNAME/customerid-rest/services/2.0/ endpoint.
  • cid-1.2.xsd for https://HOSTNAME/eidm2/services/ and https://HOSTNAME/customerid-rest/services/ endpoints.

The <any> element in the response objects is an extension point for the future versions of the API. The server is not sending any un-documented elements.

Error Messages

Error Response Document

HTTP status code always indicates the success or failure of the operation. Additional information about the failure is provided in the response body which may or may not be utilized by the requester.

<error>
	<code>ERRORCODE</code>
	<message>MESSAGE</message>
</error>


Error Codes

  1. Invalid arguments
  2. Authentication failed
  3. Unauthorized
  4. Already exists
  5. Parent not found
  6. Internal server error
  7. Entity not found
  8. Parent not virtual
  9. Parent not non-virtual
  10. Invalid reference
  11. Partial success
  12. Size limit exceeded
  13. Method not allowed
  14. Client error

Success Messages

Success Messages for Create, Delete, and Modification Operations

1.2 Schema

<idlist>
 <Id>https://HOSTNAME/eidm2/services/org/example1/dep1</Id>
</idlist>

2.0 and 2.1 Schema

<COLLECTIONTYPE inResponseTo="customerid-rest/services/2.x/RESOURCE" method="METHODNAME">
 <Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</Id>
</COLLECTIONTYPE>

COLLECTIONTYPE can be: Users, Roles and Workflows. RESOURCE depends on the specific REST call that was made. METHODNAME can be in these cases one of the following: POST, PUT or DELETE.

Success Messages for Request-Operations

1.2 Schema

Collection Request (list of identifiers)

<idlist>
 <Id>https://HOSTNAME/eidm2/services/org/example1/dep1</Id>
 <Id>https://HOSTNAME/eidm2/services/org/example1/dep2/sub3</Id>
 <Id>https://HOSTNAME/eidm2/services/org/example1</Id>
</idlist>

Collection Request (list of entities)

<entitylist>
 <ENTITY_ELEMENT>
  <Id>https://HOSTNAME/eidm2/services/org/example1/dep1</Id>
  <entity specific...>
   .
  </...entity specific>
 </ENTITY_ELEMENT>
 <ENTITY_ELEMENT>
  <Id>https://HOSTNAME/eidm2/services/org/example1/dep2/sub3</Id>
  <entity specific...>
   .
  </...entity specific>
 </ENTITY_ELEMENT>
 <ENTITY_ELEMENT>
  <Id>https://HOSTNAME/eidm2/services/org/example1</Id>
  <entity specific...>
   .
  </...entity specific>
 </ENTITY_ELEMENT>
</entitylist>

Entity Request

<ENTITY_ELEMENT>
 <Id>https://HOSTNAME/eidm2/services/org/example1/dep1</Id>
 <entity specific...>
  .
  .
  .
 </...entity specific>
</ENTITY_ELEMENT>

2.0 and 2.1 Schema

Collection Request (list of identifiers)

Collections are returned as idlists. These result from requests resources base path (e.g. https://HOSTNAME/customerid-rest/services/2.x/users) or relational queries, such as roles or mandates associated with organization, user or mandate.

<COLLECTIONTYPE xmlns="http://schema.ubisecure.com/customerid/api" inResponseTo="https://HOSTNAME/customerid-rest/services/2.x/COLLECTIONTYPE" method="GET">
 <Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX1</Id>
 <Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX2</Id>
 <Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX3</Id>
</COLLECTIONTYPE>

Entity Request

Entity requests are typically performed to the collection path followed by a specific entity's id

<ENTITY_ELEMENT xmlns="http://schema.ubisecure.com/customerid/api" inResponseTo="https://HOSTNAME/customerid-rest/services/2.x/COLLECTIONTYPE/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" method="GET">
 <Attribute name="ATTRIBUTENAME">
  <Value>VALUE1 </Value>
  <Value>VALUE2 </Value>
 </Attribute>
</ENTITY_ELEMENT>

Ubisecure Privacy Policy & Cookie Statement