Assessments API: Questions

Retrieves one specific bank

get

Authorizations

BearerstringRequired

Path parameters

bankstring · uuidRequired

Responses

200

OK

BankIdstring · uuidOptional

DepartmentIdstring · uuid · nullableOptional

FrameworkIdstring · uuid · nullableOptional

IsActivebooleanOptional

BankEditionstring · nullableOptional

BankLevelstring · nullableOptional

BankNamestring · nullableOptional

BankStatusstring · nullableOptional

BankTitlestring · nullableOptional

BankTypestring · nullableOptional

LastChangeTypestring · nullableOptional

LastChangeUserstring · nullableOptional

AssetNumberinteger · int32Optional

AttachmentCountinteger · int32Optional

BankSizeinteger · int32Optional

CommentCountinteger · int32Optional

FormCountinteger · int32Optional

OptionCountinteger · int32Optional

QuestionCountinteger · int32Optional

SetCountinteger · int32Optional

SpecCountinteger · int32Optional

LastChangeTimestring · date-timeOptional

404

Not Found

get/api/assessments/banks/{bank}

GET /v2/e01/api/assessments/banks/{bank} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

{
  "BankId": "123e4567-e89b-12d3-a456-426614174000",
  "DepartmentId": "123e4567-e89b-12d3-a456-426614174000",
  "FrameworkId": "123e4567-e89b-12d3-a456-426614174000",
  "IsActive": true,
  "BankEdition": "text",
  "BankLevel": "text",
  "BankName": "text",
  "BankStatus": "text",
  "BankTitle": "text",
  "BankType": "text",
  "LastChangeType": "text",
  "LastChangeUser": "text",
  "AssetNumber": 1,
  "AttachmentCount": 1,
  "BankSize": 1,
  "CommentCount": 1,
  "FormCount": 1,
  "OptionCount": 1,
  "QuestionCount": 1,
  "SetCount": 1,
  "SpecCount": 1,
  "LastChangeTime": "2026-01-01T00:00:00.000Z"
}

Checks for the existence of one specific bank

head

Authorizations

BearerstringRequired

Path parameters

bankstring · uuidRequired

Responses

200

OK

No content

404

Not Found

head/api/assessments/banks/{bank}

HEAD /v2/e01/api/assessments/banks/{bank} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

No content

Collects the list of banks that match specific criteria

post

Authorizations

BearerstringRequired

Body

LastChangeTimeSincestring · date-time · nullableOptional

LastChangeTimeBeforestring · date-time · nullableOptional

IsActiveboolean · nullableOptional

Responses

200

OK

BankIdstring · uuidOptional

DepartmentIdstring · uuid · nullableOptional

FrameworkIdstring · uuid · nullableOptional

IsActivebooleanOptional

BankEditionstring · nullableOptional

BankLevelstring · nullableOptional

BankNamestring · nullableOptional

BankStatusstring · nullableOptional

BankTitlestring · nullableOptional

BankTypestring · nullableOptional

LastChangeTypestring · nullableOptional

LastChangeUserstring · nullableOptional

AssetNumberinteger · int32Optional

AttachmentCountinteger · int32Optional

BankSizeinteger · int32Optional

CommentCountinteger · int32Optional

FormCountinteger · int32Optional

OptionCountinteger · int32Optional

QuestionCountinteger · int32Optional

SetCountinteger · int32Optional

SpecCountinteger · int32Optional

LastChangeTimestring · date-timeOptional

post/api/assessments/banks/collect

POST /v2/e01/api/assessments/banks/collect HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 116

{
  "LastChangeTimeSince": "2026-01-01T00:00:00.000Z",
  "LastChangeTimeBefore": "2026-01-01T00:00:00.000Z",
  "IsActive": true
}

200

OK

[
  {
    "BankId": "123e4567-e89b-12d3-a456-426614174000",
    "DepartmentId": "123e4567-e89b-12d3-a456-426614174000",
    "FrameworkId": "123e4567-e89b-12d3-a456-426614174000",
    "IsActive": true,
    "BankEdition": "text",
    "BankLevel": "text",
    "BankName": "text",
    "BankStatus": "text",
    "BankTitle": "text",
    "BankType": "text",
    "LastChangeType": "text",
    "LastChangeUser": "text",
    "AssetNumber": 1,
    "AttachmentCount": 1,
    "BankSize": 1,
    "CommentCount": 1,
    "FormCount": 1,
    "OptionCount": 1,
    "QuestionCount": 1,
    "SetCount": 1,
    "SpecCount": 1,
    "LastChangeTime": "2026-01-01T00:00:00.000Z"
  }
]

Counts the banks that match specific criteria

post

Authorizations

BearerstringRequired

Body

LastChangeTimeSincestring · date-time · nullableOptional

LastChangeTimeBeforestring · date-time · nullableOptional

IsActiveboolean · nullableOptional

Responses

200

OK

Countinteger · int32Optional

Summarystring · nullableOptional

post/api/assessments/banks/count

POST /v2/e01/api/assessments/banks/count HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 116

{
  "LastChangeTimeSince": "2026-01-01T00:00:00.000Z",
  "LastChangeTimeBefore": "2026-01-01T00:00:00.000Z",
  "IsActive": true
}

200

OK

{
  "Count": 1,
  "Summary": "text"
}

Downloads the list of banks that match specific criteria

post

Authorizations

BearerstringRequired

Body

LastChangeTimeSincestring · date-time · nullableOptional

LastChangeTimeBeforestring · date-time · nullableOptional

IsActiveboolean · nullableOptional

Responses

200

OK

No content

post/api/assessments/banks/download

POST /v2/e01/api/assessments/banks/download HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 116

{
  "LastChangeTimeSince": "2026-01-01T00:00:00.000Z",
  "LastChangeTimeBefore": "2026-01-01T00:00:00.000Z",
  "IsActive": true
}

200

OK

No content

Searches for the list of banks that match specific criteria

post

Authorizations

BearerstringRequired

Body

LastChangeTimeSincestring · date-time · nullableOptional

LastChangeTimeBeforestring · date-time · nullableOptional

IsActiveboolean · nullableOptional

Responses

200

OK

BankIdstring · uuidOptional

post/api/assessments/banks/search

POST /v2/e01/api/assessments/banks/search HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 116

{
  "LastChangeTimeSince": "2026-01-01T00:00:00.000Z",
  "LastChangeTimeBefore": "2026-01-01T00:00:00.000Z",
  "IsActive": true
}

200

OK

[
  {
    "BankId": "123e4567-e89b-12d3-a456-426614174000"
  }
]