Page tree
Skip to end of metadata
Go to start of metadata

Overview

Version

There is one version (V1) of the Catalyst API. By default, all requests will receive the stable version.

Environments

All development/test access should use the sandbox environment. The production environment should only be used once the integration has been completed. Below are the “Fully Qualified Domain Names”.

 

Client Errors

  1. Sending invalid JSON will result in a 400 Bad Request response.
  2. Sending invalid fields will result in a 422 Unprocessable Entity response.

HTTP Verbs

GET

Used for retrieving resources

POST

Used for creating resources, or performing custom actions (add security group to user)

PUT

Used for replacing resources

DELETE

Used for deleting resources

Authentication

There is one way to authenticate to the Catalyst API. Requests that require authentication will return 401 Unauthorized when authentication is not valid.

 

Basic Authenication

The base64 encode username:password string must be passed in the authentication header. The username is the requesting OrganizationId. The organization will be able to create a random token that is used as the password. These passwords can be regenerated or revoked at anytime.

Pagination

Requests that return multiple items will be paginated to 20 items by default. You can specify further pages with the ?page parameter. You can also set a custom page size up to 100 with the ?size parameter.

User Agent Required

All API request MUST include a valid User-Agent header. Request with no User-Agent will be rejected. We request that you use the name of your application.

 

Example

User-Agent: Best-Billing-Application

 

If you provide an invalid User-Agent header, you will receive a 403 Forbidden response.

 

Content Type Required

All API request MUST include a valid Content-Type header. We only support application/json at this time.

 Example

Content-Type: application/json

Resource Types

If a requested resource is not available, you will receive a 404 Not Found response.

 

Security Groups Resource

List Security Groups

GET /api/groups

 

Response

Status 200 Ok

List Security Groups Response
{[
  {
    "GroupId":"894f0234-0b22-21ea-be4f-1b523b1af39f",
    "Name":"Administrators",
    "Description":"Built-In Group for Administration"
  },
  {
    "GroupId":"52de418b-2320-26be-aae5-aebf14270575",
    "Name":"Parents",
    "Description":"Group for Parents"
  }
]}

 

User Resource

List Users

GET /api/users

Optional Request Parameters

Any of the following can be included in the request and will limit your results

Key

Value

ActiveTrue|False
Email

Valid email address

ExternalId

Unique external id for a user

 

If a user has "AccessAllStudents": false, they will return an array named AvailableStudents which contains the StudentId of assigned students.

If the user has "AccessAllStudents": true, however, the array AvailableStudents will be null.  This is to lower the size of the response.  If these StudentIds are needed, we suggest a call to List Students.

 

Response

Status: 200 Ok

User Response
{[
  {
    "Active": true,
    "UserId": "2647b5ca-950b-4060-838e-f6c3b846b551",
    "Email": "test@datafinch.com",
	"AvailableStudents": [
      "e28a147b-d05e-4b75-8aff-4f5314eb70fa"
    ],
    "IpadPin": "123123",
    "Title": "PhD, BCBA",
    "Username": "john",
    "LastName": "Doe",
    "FirstName": "John",
    "Groups": ["894f0234-0b22-21ea-be4f-1b523b1af39f"],
    "Sites": ["7696a2b1-931e-46bc-bd0b-dc08eb69ecdc"],
    "AccessAllStudents": false,
    "ExternalId": "1",
    "NeedsReset": false
  }
]}

 

User By Id

GET /api/users/:userId

 

Response

Status: 200 Ok

 

{
  "Active": true,
  "UserId": "2647b5ca-950b-4060-838e-f6c3b846b551",
  "Email": "test@datafinch.com",
  "AvailableStudents": [
    "e28a147b-d05e-4b75-8aff-4f5314eb70fa"
  ],
  "IpadPin": "123",
  "Title": "PhD, BCBA",
  "Username": "john",
  "LastName": "Doe",
  "FirstName": "John",
  "Groups": ["894f0234-0b22-21ea-be4f-1b523b1af39f"],
  "Sites": ["7696a2b1-931e-46bc-bd0b-dc08eb69ecdc"],
  "AccessAllStudents": false,
  "ExternalId": "1",
  "NeedsReset": false
}

 

 

Update User

PUT /api/users/:userId

NOTE: As of August 2016, the ExternalId may now be edited via the API. Previously, including "ExternalId" in the request body had no effect. Now, including the ExternalId in the request body will update the user's ExternalId, as long as no other user is already assigned that ExternalId number. For example, in the below request, John Doe's ExternalId would be changed to 1 if his previous ExternalId was assigned some other number and no other users have an ExternalId of 1.

Request

 

{
"Email": "test@datafinch.com",
"Username": "john",
"LastName": "Doe",
"FirstName": "John",
"Title": "PhD, BCBA",
"AccessAllStudents": false,
"Password": "Test123",
"IpadPin": "123123",
"Groups": ["894f0234-0b22-21ea-be4f-1b523b1af39f"],
"Sites": ["7696a2b1-931e-46bc-bd0b-dc08eb69ecdc"],
"ExternalId": "1"
}

 

 

Response

Status: 200 Ok

 

{
  "Active": true,
  "UserId": "2647b5ca-950b-4060-838e-f6c3b846b551",
  "Email": "test@datafinch.com",
  "AvailableStudents": [
    "e28a147b-d05e-4b75-8aff-4f5314eb70fa"
  ],
  "IpadPin": "123123",
  "Title": "PhD, BCBA",
  "Username": "john",
  "LastName": "Doe",
  "FirstName": "John",
  "Groups": ["894f0234-0b22-21ea-be4f-1b523b1af39f"],
  "Sites": ["7696a2b1-931e-46bc-bd0b-dc08eb69ecdc"],
  "AccessAllStudents": false,
  "ExternalId": "1",
  "NeedsReset": false
}

 

Create User

POST /api/users

Request (NOTE: At Minimum, you must include: Email, Password, IpadPin, Username, LastName, FirstName, Groups, and Sites.)

 

{
  "Email": "test@datafinch.com",
  "Username": "john",
  "LastName": "Doe",
  "FirstName": "John",
  "Title": "PhD, BCBA",
  "AccessAllStudents": false,
  "Password": "Test123",
  "IpadPin": "123123",
  "Groups": ["894f0234-0b22-21ea-be4f-1b523b1af39f"],
  "Sites": ["7696a2b1-931e-46bc-bd0b-dc08eb69ecdc"],
  "ExternalId": "1"
}

 

Response

Status: 201 Created

{
  "Active": true,
  "UserId": "2647b5ca-950b-4060-838e-f6c3b846b551",
  "Email": "test@datafinch.com",
  "IpadPin": "123123",
  "Title": "PhD, BCBA",
  "AvailableStudents": [
    "e28a147b-d05e-4b75-8aff-4f5314eb70fa"
  ],
  "Username": "john",
  "LastName": "Doe",
  "FirstName": "John",
  "Groups": ["894f0234-0b22-21ea-be4f-1b523b1af39f"],
  "Sites": ["7696a2b1-931e-46bc-bd0b-dc08eb69ecdc"],
  "AccessAllStudents": false,
  "ExternalId": "1",
  "NeedsReset": false
}
Create Login Token (BETA)

POST /api/users/:userId/token

Two different user ids are available. You can use the DataFinch id by prefixing the id with DF.{userId} or pass the external ID set for that user

Response

Status: 201 Created

 

{
  "Token": "7696a2b1-931e-46bc-bd0b-dc08eb69ecdc",
  "Expires": "2014-03-26T10:05:44"
}

 

Assign Student

POST /api/users/:userId/students/:studentId

Response

Status: 201 Created

 

Remove Student User Assignment

DELETE /api/users/:userId/students/:studentId

Response

Status: 204 No Content

 

Deactivate User

DELETE /api/users/:userId

Response

Status: 204 No Content

 

Activate User

POST /api/users/:userId

Response

Status: 204 No Content

 

Add To Security Group

POST /api/users/:userId/groups/:groupId

Response

Status: 201 Created

 

 

Remove From Security Group

DELETE /api/users/:userId/groups/:groupId

Response

Status: 204 No Content

 

 

List User Security Groups

GET /api/users/:userId/groups

Response

Status: 200 Ok

 

Student Resource

 

List Students

GET /api/students

Response

Status: 200 Ok

 

{[
  {
    "BCBA": "acebddea-eb7e-4dac-99ff-b778f075c14b",
    "LeadTherapistId": "13961e32-a2bc-47ff-bc83-ff746012f3db",
    "StudentId": "5ff0a201-46e1-4ce9-9a82-81286c3141a7",
    "FirstName": "Example",
    "LastName": "Student",
    "SiteId": "7696a2b1-931e-46bc-bd0b-dc08eb69ecdc",
    "DateOfBirth": "2014-11-05T14:05:12",
    "EntryDate": "2014-11-05T14:05:12",
    "Gender": "m",
    "Active": true,
    "FatherFirstName": null,
    "FatherLastName": null,
    "FatherPrimaryPhone": "",
    "FatherAlternatePhone": "",
    "MotherFirstName": null,
    "MotherPrimaryPhone": "",
    "MotherLastName": null,
    "MotherAlternatePhone": "",
    "DateLastUpdated": "2014-11-05T19:05:12",
    "ExternalId": null,
    "StudentCode": "Student, Example",
    "Diagnosis": "Autism Spectrum Disorder",
    "BaselineCriteria": {
      "CorrectRequired": 2,
      "TrialsRequired": 3,
      "Sequential": false,
      "TrialsPerDay": 1
    },
    "MasteryCriteria": {
      "Consecutive": 3,
      "FirstTrial": true,
      "IndependentResponsePercentage": 80,
      "MinimumNumberOfTrials": 3,
      "MinimumNumberOfTherapists": 1,
      "ColdProbe": false,
      "HourToCheck1": 10,
      "HourToCheck2": 16,
      "HourToCheck3": 23
    },
    "TimeZone": "America/New_York",
	"IsUsingTeachingSessions": false
  }
]}

 

 

 

Student By ID

GET /api/students/:studentId

Two different student ids are available. You can use the DataFinch id by prefixing the id with DF.{StudentId} or pass the external ID set for that entity.

Response

Status: 200 Ok

 

{
  "BCBA": "acebddea-eb7e-4dac-99ff-b778f075c14b",
  "LeadTherapistId": "13961e32-a2bc-47ff-bc83-ff746012f3db",
  "StudentId": "5ff0a201-46e1-4ce9-9a82-81286c3141a7",
  "FirstName": "Example",
  "LastName": "Student",
  "SiteId": "7696a2b1-931e-46bc-bd0b-dc08eb69ecdc",
  "DateOfBirth": "2014-11-05T14:05:12",
  "EntryDate": "2014-11-05T14:05:12",
  "Gender": "m",
  "Active": true,
  "FatherFirstName": null,
  "FatherLastName": null,
  "FatherPrimaryPhone": "",
  "FatherAlternatePhone": "",
  "MotherFirstName": null,
  "MotherPrimaryPhone": "",
  "MotherLastName": null,
  "MotherAlternatePhone": "",
  "DateLastUpdated": "2014-11-05T19:05:12",
  "ExternalId": null,
  "StudentCode": "Student, Example",
  "Diagnosis": "Autism Spectrum Disorder",
  "BaselineCriteria": {
    "CorrectRequired": 2,
    "TrialsRequired": 3,
    "Sequential": false,
    "TrialsPerDay": 1,
    "ContinueBaseline": false
  },
  "MasteryCriteria": {
    "Consecutive": 3,
    "FirstTrial": true,
    "IndependentResponsePercentage": 80,
    "MinimumNumberOfTrials": 3,
    "MinimumNumberOfTherapists": 1,
    "ColdProbe": false,{
  "BCBA": "acebddea-eb7e-4dac-99ff-b778f075c14b",
  "LeadTherapistId": "acebddea-eb7e-4dac-99ff-b778f075c14b",
  "StudentId": "5ff0a201-46e1-4ce9-9a82-81286c3141a7",
  "FirstName": "Austin",
  "LastName": "Michaels",
  "SiteId": "421a889e-9494-4242-bcc4-f7d683129cce",
  "DateOfBirth": "2014-11-05T14:05:12",
  "EntryDate": "2014-11-05T14:05:12",
  "Gender": "m",
  "Active": true,
  "FatherFirstName": null,
  "FatherLastName": null,
  "FatherPrimaryPhone": "",
  "FatherAlternatePhone": "",
  "MotherFirstName": null,
  "MotherPrimaryPhone": "",
  "MotherLastName": null,
  "MotherAlternatePhone": "",
  "DateLastUpdated": "2014-11-05T19:05:12",
  "ExternalId": null,
  "StudentCode": "Michaels, Austin",
  "Diagnosis": "Autism Spectrum Disorder",
  "BaselineCriteria": {
    "CorrectRequired": 2,
    "TrialsRequired": 3,
    "Sequential": false,
    "TrialsPerDay": 1
  },
  "MasteryCriteria": {
    "Consecutive": 3,
    "FirstTrial": true,
    "IndependentResponsePercentage": 80,
    "MinimumNumberOfTrials": 3,
    "MinimumNumberOfTherapists": 1,
    "ColdProbe": false,    
    "HourToCheck1": 10,
    "HourToCheck2": 16,
    "HourToCheck3": 23
  },
  "TimeZone": "America/New_York",
  "IsUsingTeachingSessions": false
 }
  
}

 

 

Update Student

PUT /api/students/:studentId

  • SiteId can use the DF id or site abbreviation ( "DF.4676e2c4-ef41-484b-bf54-42fa3dc16201" or  "ABBR")

Two different student ids are available. You can use the DataFinch id by prefixing the id with DF.{StudentId} or pass the external ID set for that entity.

Optional Request Parameters

  • BaselineCriteria can be null (Uses system defaults)
  • MasteryCriteria can be null (Uses system defaults)

Note

Time zones must be in ISO8601 format. You can see a complete list at the bottom of this page


Request

{
  "FirstName": "Example",
  "LastName": "Student",
  "SiteId": "90353413-6F2D-4B43-BADA-3C181204B49C",
  "DateOfBirth": "2014-03-26T10:05:44",
  "EntryDate": "2014-03-26T10:05:44",
  "Gender": "m",
  "FatherFirstName": null,
  "FatherLastName": null,
  "FatherPrimaryPhone": "",
  "FatherAlternatePhone": "",
  "MotherFirstName": null,
  "MotherPrimaryPhone": "",
  "MotherLastName": null,
  "MotherAlternatePhone": "",
  "ExternalId": null,
  "StudentCode": "Student, Example",
  "Diagnosis": "Autism Spectrum Disorder",
  "TimeZone": "America/New_York",
  "BCBA": "AD7FF614-3DF6-4175-B0B8-1C0451940E50",
  "LeadTherapistId": "AD7FF614-3DF6-4175-B0B8-1C0451940E50",
  "MasteryCriteria": {
    "Consecutive": 3,
    "FirstTrial": true,
    "IndependentResponsePercentage": 80,
    "MinimumNumberOfTrials": 3,
    "MinimumNumberOfTherapists": 1,
    "ColdProbe": false,
    "HourToCheck1": 10,
    "HourToCheck2": 16,
    "HourToCheck3": 23
  }
}

 

 

Response

Status: 200 Ok

 

{
  "BCBA": "ad7ff614-3df6-4175-b0b8-1c0451940e50",
  "LeadTherapistId": "ad7ff614-3df6-4175-b0b8-1c0451940e50",
  "StudentId": "3f7e015b-94a9-45f1-bb41-009987fd5222",
  "FirstName": "Example",
  "LastName": "Student",
  "SiteId": "90353413-6F2D-4B43-BADA-3C181204B49C",
  "DateOfBirth": "2014-03-26T10:05:44",
  "EntryDate": "2014-03-26T10:05:44",
  "Gender": "m",
  "Active": false,
  "FatherFirstName": null,
  "FatherLastName": null,
  "FatherPrimaryPhone": "",
  "FatherAlternatePhone": "",
  "MotherFirstName": null,
  "MotherPrimaryPhone": "",
  "MotherLastName": null,
  "MotherAlternatePhone": "",
  "DateLastUpdated": null,
  "ExternalId": null,
  "StudentCode": "Student, Example",
  "Diagnosis": "Autism Spectrum Disorder",
  "BaselineCriteria": {
    "CorrectRequired": 2,
    "TrialsRequired": 3,
    "Sequential": false,
    "TrialsPerDay": 1,
    "ContinueBaseline": false
  },
  "MasteryCriteria": {
    "Consecutive": 3,
    "FirstTrial": true,
    "IndependentResponsePercentage": 80,
    "MinimumNumberOfTrials": 3,
    "MinimumNumberOfTherapists": 1,
    "ColdProbe": false,
    "HourToCheck1": 10,
    "HourToCheck2": 16,
    "HourToCheck3": 23
  },
  "TimeZone": "America/New_York",
  "IsUsingTeachingSessions": true
}

 

 

Create Student

POST /api/students/

  • SiteId can use the DF id or site abbreviation ( "DF.4676e2c4-ef41-484b-bf54-42fa3dc16201" or  "ABBR")

Optional Request Parameters

  • BaselineCriteria can be null (Uses system defaults)
  • MasteryCriteria can be null (Uses system defaults)

Note

Time zones must be in ISO8601 format. You can see a complete list at the bottom of this page

Request

{
  "BCBA": "ad7ff614-3df6-4175-b0b8-1c0451940e50",
  "LeadTherapistId": "ad7ff614-3df6-4175-b0b8-1c0451940e50",
  "StudentId": "d867abbb-438a-4797-8024-1a507e6323c1",
  "FirstName": "Example",
  "LastName": "Student",
  "SiteId": "90353413-6F2D-4B43-BADA-3C181204B49C",
  "DateOfBirth": "2014-03-26T10:05:44",
  "EntryDate": "2014-03-26T10:05:44",
  "Gender": "m",
  "Active": true,
  "FatherFirstName": null,
  "FatherLastName": null,
  "FatherPrimaryPhone": "",
  "FatherAlternatePhone": "",
  "MotherFirstName": null,
  "MotherPrimaryPhone": "",
  "MotherLastName": null,
  "MotherAlternatePhone": "",
  "DateLastUpdated": "2014-11-05T19:05:12",
  "ExternalId": null,
  "StudentCode": "Student, Example",
  "Diagnosis": "Autism Spectrum Disorder",
  "BaselineCriteria": {
    "CorrectRequired": 1,
    "TrialsRequired": 1,
    "Sequential": true,
    "TrialsPerDay": 1,
    "ContinueBaseline": false
  },
  "MasteryCriteria": {
    "Consecutive": 1,
    "FirstTrial": true,
    "IndependentResponsePercentage": 50,
    "MinimumNumberOfTrials": 1,
    "MinimumNumberOfTherapists": 1,
    "ColdProbe": true,
    "HourToCheck1": 10,
    "HourToCheck2": 16,
    "HourToCheck3": 23
  },
  "TimeZone": "America/New_York"
}

 

 

Response

Status: 201 Created

 

{
  "BCBA": "ad7ff614-3df6-4175-b0b8-1c0451940e50",
  "LeadTherapistId": "ad7ff614-3df6-4175-b0b8-1c0451940e50",
  "StudentId": "d867abbb-438a-4797-8024-1a507e6323c1",
  "FirstName": "Example",
  "LastName": "Student",
  "SiteId": "90353413-6F2D-4B43-BADA-3C181204B49C",
  "DateOfBirth": "2014-03-26T10:05:44",
  "EntryDate": "2014-03-26T10:05:44",
  "Gender": "m",
  "Active": true,
  "FatherFirstName": null,
  "FatherLastName": null,
  "FatherPrimaryPhone": "",
  "FatherAlternatePhone": "",
  "MotherFirstName": null,
  "MotherPrimaryPhone": "",
  "MotherLastName": null,
  "MotherAlternatePhone": "",
  "DateLastUpdated": "2014-11-05T19:05:12",
  "ExternalId": null,
  "StudentCode": "Student, Example",
  "Diagnosis": "Autism Spectrum Disorder",
  "BaselineCriteria": {
    "CorrectRequired": 1,
    "TrialsRequired": 1,
    "Sequential": true,
    "TrialsPerDay": 1,
    "ContinueBaseline": false
  },
  "MasteryCriteria": {
    "Consecutive": 1,
    "FirstTrial": true,
    "IndependentResponsePercentage": 50,
    "MinimumNumberOfTrials": 1,
    "MinimumNumberOfTherapists": 1,
    "ColdProbe": true,
    "HourToCheck1": 10,
    "HourToCheck2": 16,
    "HourToCheck3": 23
  },
  "TimeZone": "America/New_York",
  "IsUsingTeachingSessions": true
}

 

 

 

Deactivate Student

DELETE /api/students/:studentId

Two different student ids are available. You can use the DataFinch id by prefixing the id with DF.{StudentId} or pass the external ID set for that entity.

Response

Status: 204 No Content

Activate Student

POST /api/students/:studentId

Two different student ids are available. You can use the DataFinch id by prefixing the id with DF.{StudentId} or pass the external ID set for that entity.

Response

Status: 204 No Content

 

List Users Assigned to Student

GET /api/students/:studentId/users/:userAccessType

  • StudentId: Two different student ids are available. You can use the DataFinch id by prefixing the id with DF.{StudentId} or pass the external ID set for that entity.
  • UserAccessType:
    • AllAssignedUsers: All users assigned to a student regardless of whether or not they are assigned the "Access All Students" permission
    • OnlySpecificallyAssignedUsers: Only those users without "Access All Students" permission that have been specifically assigned to that student
    • OnlyAccessAllStudentsUsers: Only those users with the "Access All Students" permission

    Note: If you incorrectly enter one of the three UserAccessTypes, the method will return AllAssignedUsers by default.

 

Response

Status: 200 OK

{[
  {
    "Active": true,
    "UserId": "2647b5ca-950b-4060-838e-f6c3b846b551",
    "Email": "test@datafinch.com",
	"AvailableStudents": [
      "e28a147b-d05e-4b75-8aff-4f5314eb70fa"
    ],
    "IpadPin": "123123",
    "Title": "PhD, BCBA",
    "Username": "john",
    "LastName": "Doe",
    "FirstName": "John",
    "Groups": ["894f0234-0b22-21ea-be4f-1b523b1af39f"],
    "Sites": ["7696a2b1-931e-46bc-bd0b-dc08eb69ecdc"],
    "AccessAllStudents": false,
    "ExternalId": "1",
    "NeedsReset": false
  },
  {
    "Active": true,
    "UserId": "0c7ec6c1-db01-4144-81a3-26b3fd2a9adc",
    "AvailableStudents": null,
    "Groups": [],
    "Sites": [
      "72fd3c24-bcd9-4518-b937-eab578261903"
    ],
    "Email": "test@datafinch.com",
    "IpadPin": "123321",
    "Title": "PhD, BCBA",
    "Username": "george",
    "LastName": "Burdell",
    "FirstName": "George",
    "AccessAllStudents": true,
    "SelectedSites": [
      "72fd3c24-bcd9-4518-b937-eab578261903"
    ],
    "ExternalId": null,
    "NeedsReset": false
  }
]}

Sites Resource

List Sites

GET /api/sites

{[
  {
     "SiteId": "4676e2c4-ef41-484b-bf54-42fa3dc16201",
     "Name": "Default Site",
     "Abbreviation": "DFLT",
     "TimeZone": "America/New_York"
  }
]}

 

Custom Reports

Report By Id

GET /api/reports?:reportId&:param1=:value
Response
Status: 200 OK
Example of a successful result:

{[
     {
        “Name” : “Scratching" ,
        “ Sum” :  400.00,
        “Average” : 4.00,
        “Measurement” : “count"      
     }
]}


Example URL (With Parameters)

api/reports?reportId=263cc357-ea00-497c-b7ee-916dacd58383&endDate=2016-08-09&startDate=2013-06-01&studentId=362c71d8-d2f1-47e0-9dcb-52484a918050


Parameters Formats 
Parameter
Format
Date
yyyy-mm-dd  Example 2012-07-23
Report ID
GUID  Example: CF07F56C-AD98-49FA-8EDC-4F21A0DCD1FB  
Program
GUID  Example: CF07F56C-AD98-49FA-8EAC-4F21A0DCD1C
User 
GUID  Example: CF07F56C-AD98-49FA-8ERC-4F21A0DCD1D
Student

GUID Example: CF07F56C-AD98-49FA-8ECT-4F21A0DCD1D


 If you specify a specific student you would need to know the internal student id. External ID's are not currently supported


Error Messages
Number
Reason
Message
404
The report does not exist
Report ID Not Found
400
The format of the id is invalid
You must specify a valid report id
400
The parameter sent is not a valid parameter
The [Date] parameter is not a valid parameter
400 Example string value where integer is required Parameter is not the correct data type
404 The student does not existNot student was found with [ n ] id
400 Week ending date must be on a Sunday

 

Single Sign-On

Authorized partner sites can enable single sign-on between their site and Catalyst. This allows users to freely move from their site to ours without requiring a second login challenge. Partner sites must generate a short lived token using the Create Login Token (BETA) API. Once a token has been received, a user should be redirected to the token login endpoint. Below is the required request.

GET /login/authenticate?userid={userId}&token={token}

Two different user ids are available. You can use the DataFinch id by prefixing the id with DF.{userId} or pass the external ID set for that user

Request

  • The userid parameter can either be an external Id assigned by the partner site or their Catalyst Id. 
  • The token parameter is the value returned from the Create Login Token (BETA) API.

 

Most Common Timezones

IDName
America/Halifax(UTC-04:00) Atlantic Time (Canada)
America/New_York(UTC-05:00) Eastern Time (US & Canada)
America/Chicago(UTC-06:00) Central Time (US & Canada)
America/Indiana/Indianapolis(UTC-05:00) Indiana (East)
America/Denver(UTC-07:00) Mountain Time (US & Canada)
America/Phoenix(UTC-07:00) Arizona
America/Los_Angeles(UTC-08:00) Pacific Time (US & Canada)

 

Other Timezones

IDName
Africa/Cairo(UTC+02:00) Cairo
Africa/Casablanca(UTC) Casablanca
Africa/Johannesburg(UTC+02:00) Harare, Pretoria
Africa/Lagos(UTC+01:00) West Central Africa
Africa/Nairobi(UTC+03:00) Nairobi
Africa/Tripoli(UTC+02:00) Tripoli
Africa/Windhoek(UTC+01:00) Windhoek
America/Anchorage(UTC-09:00) Alaska
America/Argentina/Buenos_Aires(UTC-03:00) Buenos Aires
America/Asuncion(UTC-04:00) Asuncion
America/Bahia(UTC-03:00) Salvador
America/Bogota(UTC-05:00) Bogota, Lima, Quito, Rio Branco
America/Caracas(UTC-04:30) Caracas
America/Cayenne(UTC-03:00) Cayenne, Fortaleza
America/Chihuahua(UTC-07:00) Chihuahua, La Paz, Mazatlan
America/Cuiaba(UTC-04:00) Cuiaba
America/Godthab(UTC-03:00) Greenland
America/Guatemala(UTC-06:00) Central America
America/La_Paz(UTC-04:00) Georgetown, La Paz, Manaus, San Juan
America/Mexico_City(UTC-06:00) Guadalajara, Mexico City, Monterrey
America/Montevideo(UTC-03:00) Montevideo
America/Regina(UTC-06:00) Saskatchewan
America/Santa_Isabel(UTC-08:00) Baja California
America/Santiago(UTC-04:00) Santiago
America/Sao_Paulo(UTC-03:00) Brasilia
America/St_Johns(UTC-03:30) Newfoundland
Asia/Almaty(UTC+06:00) Astana
Asia/Amman(UTC+02:00) Amman
Asia/Baghdad(UTC+03:00) Baghdad
Asia/Baku(UTC+04:00) Baku
Asia/Bangkok(UTC+07:00) Bangkok, Hanoi, Jakarta
Asia/Beirut(UTC+02:00) Beirut
Asia/Colombo(UTC+05:30) Sri Jayawardenepura
Asia/Damascus(UTC+02:00) Damascus
Asia/Dhaka(UTC+06:00) Dhaka
Asia/Dubai(UTC+04:00) Abu Dhabi, Muscat
Asia/Irkutsk(UTC+09:00) Irkutsk
Asia/Jerusalem(UTC+02:00) Jerusalem
Asia/Kabul(UTC+04:30) Kabul
Asia/Karachi(UTC+05:00) Islamabad, Karachi
Asia/Kathmandu(UTC+05:45) Kathmandu
Asia/Kolkata(UTC+05:30) Chennai, Kolkata, Mumbai, New Delhi
Asia/Krasnoyarsk(UTC+08:00) Krasnoyarsk
Asia/Magadan(UTC+12:00) Magadan
Asia/Novosibirsk(UTC+07:00) Novosibirsk
Asia/Rangoon(UTC+06:30) Yangon (Rangoon)
Asia/Riyadh(UTC+03:00) Kuwait, Riyadh
Asia/Seoul(UTC+09:00) Seoul
Asia/Shanghai(UTC+08:00) Beijing, Chongqing, Hong Kong, Urumqi
Asia/Singapore(UTC+08:00) Kuala Lumpur, Singapore
Asia/Taipei(UTC+08:00) Taipei
Asia/Tashkent(UTC+05:00) Ashgabat, Tashkent
Asia/Tbilisi(UTC+04:00) Tbilisi
Asia/Tehran(UTC+03:30) Tehran
Asia/Tokyo(UTC+09:00) Osaka, Sapporo, Tokyo
Asia/Ulaanbaatar(UTC+08:00) Ulaanbaatar
Asia/Vladivostok(UTC+11:00) Vladivostok
Asia/Yakutsk(UTC+10:00) Yakutsk
Asia/Yekaterinburg(UTC+06:00) Ekaterinburg
Asia/Yerevan(UTC+04:00) Yerevan
Atlantic/Azores(UTC-01:00) Azores
Atlantic/Cape_Verde(UTC-01:00) Cape Verde Is.
Atlantic/Reykjavik(UTC) Monrovia, Reykjavik
Australia/Adelaide(UTC+09:30) Adelaide
Australia/Brisbane(UTC+10:00) Brisbane
Australia/Darwin(UTC+09:30) Darwin
Australia/Hobart(UTC+10:00) Hobart
Australia/Perth(UTC+08:00) Perth
Australia/Sydney(UTC+10:00) Canberra, Melbourne, Sydney
Etc/GMT+11(UTC-11:00) Coordinated Universal Time-11
Etc/GMT+12(UTC-12:00) International Date Line West
Etc/GMT+2(UTC-02:00) Coordinated Universal Time-02
Etc/GMT-12(UTC+12:00) Coordinated Universal Time+12
Etc/UTC(UTC) Coordinated Universal Time
Europe/Berlin(UTC+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna
Europe/Bucharest(UTC+02:00) Athens, Bucharest
Europe/Budapest(UTC+01:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague
Europe/Istanbul(UTC+02:00) Istanbul
Europe/Kaliningrad(UTC+03:00) Kaliningrad, Minsk
Europe/Kiev(UTC+02:00) Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius
Europe/London(UTC) Dublin, Edinburgh, Lisbon, London
Europe/Moscow(UTC+04:00) Moscow, St. Petersburg, Volgograd
Europe/Paris(UTC+01:00) Brussels, Copenhagen, Madrid, Paris
Europe/Warsaw(UTC+01:00) Sarajevo, Skopje, Warsaw, Zagreb
Indian/Mauritius(UTC+04:00) Port Louis
Pacific/Apia(UTC+13:00) Samoa
Pacific/Auckland(UTC+12:00) Auckland, Wellington
Pacific/Fiji(UTC+12:00) Fiji
Pacific/Guadalcanal(UTC+11:00) Solomon Is., New Caledonia
Pacific/Honolulu(UTC-10:00) Hawaii
Pacific/Port_Moresby(UTC+10:00) Guam, Port Moresby
Pacific/Tongatapu(UTC+13:00) Nuku'alofa
  • No labels