Retrieve JourneyDefinitionID

This action is used to retrieve the journey definitions. It accepts a channel type and returns the Journey definitions for the channel type.

Note: The authentication must be done using (area=”investigation”) before calling this action, for more information please refer to Authentication section.

[GET] http://serverURL/IDScanEnterpriseSvc/JourneyDefinition/GetAll

Request/Response format: JSON

URL Parameters

Parameter	Description	Format
ChannelType	Not mandatory, possible values are: CaptureStudio Web Mobile	String Results

Results

This is an array object

Key	Description	Format
JourneyDefinition	A unique formatted id of the journey definition.	GUID
Name	Name of the channel type/journey definition.	String
ChannelType	Index of the select channel type: CaptueStudio = 1 FileUpload = 2 WebCamera = 3 Camera = 4	Integer
ChannelMedia	Possible values: Scanner = 1 FileUpload = 2 WebCamera = 3 Camera = 4	Integer
LastUpdatedDateTime	Date and time of the journey definition in local format of the server PC	DateTime
IsActive	State of the journey definition	Boolean
EntryDefinitions	Entry definition of the journey definition	Object

EntryDefinitions Array Objects

Key	Description	Format
JourneyEntryDefinitionId	A unique formatted id of the journey entry definition	GUID
JourneyDefinitionId	A unique formatted id of the journey definition	GUID
Type	Possible values: FRONTSIDE = 1 BACKSIDE = 2 SELFIE = 3 ADDRESSDOCUMENT=4 CHIPPHOTOFACEMATCH = 5, LIVENESS = 6, NFC = 7, PASSIVE_LIVENESS = 8	Integer
Order	This field is currently not functional, so can be ignored
IsOptional	This field is currently not functional, so can be ignored

Example URL:

Request: https://serverURL/IDScanEnterpriseSvc/JourneyDefinition/GetAll?channeltype=web

Response

Note: The structure of the response will be the same regardless of the channel type but the entry definitions list in this example is for demonstration purposes only; possible list of entry definitions depends on the channel type and configuration type.

[
    {
      "JourneyDefinitionId": "ef644ffa-e2eb-49d3-b610-c827842b8eb5",
      "Name": "WJCS",
      "ChannelType": 2,
      "CapturingMedia": 2,
      "LastUpdatedDateTime": "2019-08-05T06:59:28.2378768",
      "IsActive": true,
      "EntryDefinitions": [
        {
          "JourneyEntryDefinitionId": "68a1ba6d-8f9e-4965-bfac-6b87f25cebc7",
          "JourneyDefinitionId": "ef644ffa-e2eb-49d3-b610-c827842b8eb5",
          "Type": 1,
          "Order": 0,
          "IsOptional": false
        },
        {
          "JourneyEntryDefinitionId": "ef7c8a4d-8a43-4436-ae1e-bc6a6b8c833e",
          "JourneyDefinitionId": "ef644ffa-e2eb-49d3-b610-c827842b8eb5",
          "Type": 3,
          "Order": 0,
          "IsOptional": false
        },
        {
          "JourneyEntryDefinitionId": "e87c9a1a-3bfd-4440-99f7-e179f14a993d",
          "JourneyDefinitionId": "ef644ffa-e2eb-49d3-b610-c827842b8eb5",
          "Type": 6,
          "Order": 0,
          "IsOptional": false
        }
      ]
    },
    {
      "JourneyDefinitionId": "9ddc0e50-b8cc-436c-b6c0-275e46412cd8",
      "Name": "wjcsscanner",
      "ChannelType": 2,
      "CapturingMedia": 1,
      "LastUpdatedDateTime": "2019-10-04T12:09:54.2237734",
      "IsActive": true,
      "EntryDefinitions": [
        {
          "JourneyEntryDefinitionId": "8ecef82b-432f-4a5a-9046-2c17c246e981",
          "JourneyDefinitionId": "9ddc0e50-b8cc-436c-b6c0-275e46412cd8",
          "Type": 1,
          "Order": 0,
          "IsOptional": false
        }
      ]
    }
  ]