Blackboard Service Point Api

<back to all web services

GetAllInstitutions41Request

The following routes are available for this service:
GET, OPTIONS/api/system/v4.1/institutionsGets a list of all Institutions.

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/GetAllInstitutions41Request HTTP/1.1 
Host: bbspcloudserviceeast.transactcampus.com 
Content-Type: application/json
Content-Length: length

{"PageIndex":0,"PageSize":0,"Sort":"String","InstitutionName":"String","ShortName":"String","DomainName":"String","ClientId":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Institutions":[{"InstitutionId":"00000000000000000000000000000000","Name":"String","Description":"String","ShortName":"String","ClientId":0,"DomainName":"String","RedirectDomainName":"String","DatabaseName":"String","DatabaseServerName":"String","Datacenter":{"DatacenterId":"00000000000000000000000000000000","Name":"String","IsPciCompliant":false},"BbISLastServiceCallDateTime":"0001-01-01T00:00:00.0000000+00:00","MaintenanceMode":false,"Migrating":false,"InstitutionRoutes":[{"InstitutionRouteId":"00000000000000000000000000000000","InstitutionRouteSchemeType":{"Id":0,"ApiKey":"String","Name":"String","Description":"String"},"Value":"String","Enabled":false}],"IdentityProviders":{"LdapIdentityProviders":[{"LdapHost":"String","LdapPort":0,"LdapUseSsl":false,"LdapConnectionTimeoutInSeconds":0,"LdapAuthType":"String","UserBindPrefix":"String","UserBindSuffix":"String","ServicePrincipalUserName":"String","IsServicePrincipalRequired":false,"ServicePrincipalPassword":"String","UserSearchPrefix":"String","UserSearchSuffix":"String","IdentityProviderId":"00000000000000000000000000000000","AuthenticationRealm":"String","AuthenticationRealmFriendlyName":"String","AuthenticationRealmDescription":"String","AuthenticationUrl":"String","IdentityProviderTypeName":"String","InstitutionId":"00000000000000000000000000000000","ClaimProviders":{"LdapClaimProviders":[{"LdapHost":"String","LdapPort":0,"LdapUseSsl":false,"LdapConnectionTimeoutInSeconds":0,"LdapAuthType":"String","UserBindPrefix":"String","UserBindSuffix":"String","IsServicePrincipalRequired":false,"ServicePrincipalUserName":"String","ServicePrincipalPassword":"String","UserGroupSearchPrefix":"String","UserGroupSearchSuffix":"String","IsUserGroupSearchFQDNRequired":false,"UserSearchPrefix":"String","UserSearchSuffix":"String","ClaimProviderId":"00000000000000000000000000000000","ClaimProviderType":{"ClaimProviderTypeId":"00000000000000000000000000000000","ClaimProviderTypeName":"String","Description":"String"}}],"ApiClaimProviders":[{"ApiHostBaseUri":"String","Port":0,"ApiSegment":"String","HeaderKey":"String","HeaderValue":"String","ClaimProviderId":"00000000000000000000000000000000","ClaimProviderType":{"ClaimProviderTypeId":"00000000000000000000000000000000","ClaimProviderTypeName":"String","Description":"String"}}],"DatabaseClaimProviders":[{"ConnectionString":"String","AuthenticationSqlQuery":"String","DatabaseType":"String","ClaimProviderId":"00000000000000000000000000000000","ClaimProviderType":{"ClaimProviderTypeId":"00000000000000000000000000000000","ClaimProviderTypeName":"String","Description":"String"}}],"ActiveDirectoryClaimProviders":[{"Host":"String","Port":0,"ServerBindingOptions":"String","UserNamePrefix":"String","UserNameSuffix":"String","ServicePrincipalUserName":"String","ServicePrincipalPassword":"String","ClaimProviderId":"00000000000000000000000000000000","ClaimProviderType":{"ClaimProviderTypeId":"00000000000000000000000000000000","ClaimProviderTypeName":"String","Description":"String"}}],"LdapLegacyClaimProviders":[{"LdapHost":"String","LdapPort":0,"LdapUseSsl":false,"LdapConnectionTimeoutInSeconds":0,"LdapAuthType":"String","DirectorySearchFilterPrefix":"String","DirectorySearchFilterSuffix":"String","ClaimProviderId":"00000000000000000000000000000000","ClaimProviderType":{"ClaimProviderTypeId":"00000000000000000000000000000000","ClaimProviderTypeName":"String","Description":"String"}}]}}],"ApiIdentityProviders":[{"ApiHostBaseUri":"String","Port":0,"ApiSegment":"String","HeaderKey":"String","HeaderValue":"String","IdentityProviderId":"00000000000000000000000000000000","AuthenticationRealm":"String","AuthenticationRealmFriendlyName":"String","AuthenticationRealmDescription":"String","AuthenticationUrl":"String","IdentityProviderTypeName":"String","InstitutionId":"00000000000000000000000000000000","ClaimProviders":{"LdapClaimProviders":[{"LdapHost":"String","LdapPort":0,"LdapUseSsl":false,"LdapConnectionTimeoutInSeconds":0,"LdapAuthType":"String","UserBindPrefix":"String","UserBindSuffix":"String","IsServicePrincipalRequired":false,"ServicePrincipalUserName":"String","ServicePrincipalPassword":"String","UserGroupSearchPrefix":"String","UserGroupSearchSuffix":"String","IsUserGroupSearchFQDNRequired":false,"UserSearchPrefix":"String","UserSearchSuffix":"String","ClaimProviderId":"00000000000000000000000000000000","ClaimProviderType":{"ClaimProviderTypeId":"00000000000000000000000000000000","ClaimProviderTypeName":"String","Description":"String"}}],"ApiClaimProviders":[{"ApiHostBaseUri":"String","Port":0,"ApiSegment":"String","HeaderKey":"String","HeaderValue":"String","ClaimProviderId":"00000000000000000000000000000000","ClaimProviderType":{"ClaimProviderTypeId":"00000000000000000000000000000000","ClaimProviderTypeName":"String","Description":"String"}}],"DatabaseClaimProviders":[{"ConnectionString":"String","AuthenticationSqlQuery":"String","DatabaseType":"String","ClaimProviderId":"00000000000000000000000000000000","ClaimProviderType":{"ClaimProviderTypeId":"00000000000000000000000000000000","ClaimProviderTypeName":"String","Description":"String"}}],"ActiveDirectoryClaimProviders":[{"Host":"String","Port":0,"ServerBindingOptions":"String","UserNamePrefix":"String","UserNameSuffix":"String","ServicePrincipalUserName":"String","ServicePrincipalPassword":"String","ClaimProviderId":"00000000000000000000000000000000","ClaimProviderType":{"ClaimProviderTypeId":"00000000000000000000000000000000","ClaimProviderTypeName":"String","Description":"String"}}],"LdapLegacyClaimProviders":[{"LdapHost":"String","LdapPort":0,"LdapUseSsl":false,"LdapConnectionTimeoutInSeconds":0,"LdapAuthType":"String","DirectorySearchFilterPrefix":"String","DirectorySearchFilterSuffix":"String","ClaimProviderId":"00000000000000000000000000000000","ClaimProviderType":{"ClaimProviderTypeId":"00000000000000000000000000000000","ClaimProviderTypeName":"String","Description":"String"}}]}}],"DatabaseIdentityProviders":[{"ConnectionString":"String","AuthenticationSqlQuery":"String","DatabaseType":"String","IdentityProviderId":"00000000000000000000000000000000","AuthenticationRealm":"String","AuthenticationRealmFriendlyName":"String","AuthenticationRealmDescription":"String","AuthenticationUrl":"String","IdentityProviderTypeName":"String","InstitutionId":"00000000000000000000000000000000","ClaimProviders":{"LdapClaimProviders":[{"LdapHost":"String","LdapPort":0,"LdapUseSsl":false,"LdapConnectionTimeoutInSeconds":0,"LdapAuthType":"String","UserBindPrefix":"String","UserBindSuffix":"String","IsServicePrincipalRequired":false,"ServicePrincipalUserName":"String","ServicePrincipalPassword":"String","UserGroupSearchPrefix":"String","UserGroupSearchSuffix":"String","IsUserGroupSearchFQDNRequired":false,"UserSearchPrefix":"String","UserSearchSuffix":"String","ClaimProviderId":"00000000000000000000000000000000","ClaimProviderType":{"ClaimProviderTypeId":"00000000000000000000000000000000","ClaimProviderTypeName":"String","Description":"String"}}],"ApiClaimProviders":[{"ApiHostBaseUri":"String","Port":0,"ApiSegment":"String","HeaderKey":"String","HeaderValue":"String","ClaimProviderId":"00000000000000000000000000000000","ClaimProviderType":{"ClaimProviderTypeId":"00000000000000000000000000000000","ClaimProviderTypeName":"String","Description":"String"}}],"DatabaseClaimProviders":[{"ConnectionString":"String","AuthenticationSqlQuery":"String","DatabaseType":"String","ClaimProviderId":"00000000000000000000000000000000","ClaimProviderType":{"ClaimProviderTypeId":"00000000000000000000000000000000","ClaimProviderTypeName":"String","Description":"String"}}],"ActiveDirectoryClaimProviders":[{"Host":"String","Port":0,"ServerBindingOptions":"String","UserNamePrefix":"String","UserNameSuffix":"String","ServicePrincipalUserName":"String","ServicePrincipalPassword":"String","ClaimProviderId":"00000000000000000000000000000000","ClaimProviderType":{"ClaimProviderTypeId":"00000000000000000000000000000000","ClaimProviderTypeName":"String","Description":"String"}}],"LdapLegacyClaimProviders":[{"LdapHost":"String","LdapPort":0,"LdapUseSsl":false,"LdapConnectionTimeoutInSeconds":0,"LdapAuthType":"String","DirectorySearchFilterPrefix":"String","DirectorySearchFilterSuffix":"String","ClaimProviderId":"00000000000000000000000000000000","ClaimProviderType":{"ClaimProviderTypeId":"00000000000000000000000000000000","ClaimProviderTypeName":"String","Description":"String"}}]}}],"ActiveDirectoryIdentityProviders":[{"Host":"String","Port":0,"ServerBindingOptions":"String","UserNamePrefix":"String","UserNameSuffix":"String","ServicePrincipalUserName":"String","ServicePrincipalPassword":"String","IdentityProviderId":"00000000000000000000000000000000","AuthenticationRealm":"String","AuthenticationRealmFriendlyName":"String","AuthenticationRealmDescription":"String","AuthenticationUrl":"String","IdentityProviderTypeName":"String","InstitutionId":"00000000000000000000000000000000","ClaimProviders":{"LdapClaimProviders":[{"LdapHost":"String","LdapPort":0,"LdapUseSsl":false,"LdapConnectionTimeoutInSeconds":0,"LdapAuthType":"String","UserBindPrefix":"String","UserBindSuffix":"String","IsServicePrincipalRequired":false,"ServicePrincipalUserName":"String","ServicePrincipalPassword":"String","UserGroupSearchPrefix":"String","UserGroupSearchSuffix":"String","IsUserGroupSearchFQDNRequired":false,"UserSearchPrefix":"String","UserSearchSuffix":"String","ClaimProviderId":"00000000000000000000000000000000","ClaimProviderType":{"ClaimProviderTypeId":"00000000000000000000000000000000","ClaimProviderTypeName":"String","Description":"String"}}],"ApiClaimProviders":[{"ApiHostBaseUri":"String","Port":0,"ApiSegment":"String","HeaderKey":"String","HeaderValue":"String","ClaimProviderId":"00000000000000000000000000000000","ClaimProviderType":{"ClaimProviderTypeId":"00000000000000000000000000000000","ClaimProviderTypeName":"String","Description":"String"}}],"DatabaseClaimProviders":[{"ConnectionString":"String","AuthenticationSqlQuery":"String","DatabaseType":"String","ClaimProviderId":"00000000000000000000000000000000","ClaimProviderType":{"ClaimProviderTypeId":"00000000000000000000000000000000","ClaimProviderTypeName":"String","Description":"String"}}],"ActiveDirectoryClaimProviders":[{"Host":"String","Port":0,"ServerBindingOptions":"String","UserNamePrefix":"String","UserNameSuffix":"String","ServicePrincipalUserName":"String","ServicePrincipalPassword":"String","ClaimProviderId":"00000000000000000000000000000000","ClaimProviderType":{"ClaimProviderTypeId":"00000000000000000000000000000000","ClaimProviderTypeName":"String","Description":"String"}}],"LdapLegacyClaimProviders":[{"LdapHost":"String","LdapPort":0,"LdapUseSsl":false,"LdapConnectionTimeoutInSeconds":0,"LdapAuthType":"String","DirectorySearchFilterPrefix":"String","DirectorySearchFilterSuffix":"String","ClaimProviderId":"00000000000000000000000000000000","ClaimProviderType":{"ClaimProviderTypeId":"00000000000000000000000000000000","ClaimProviderTypeName":"String","Description":"String"}}]}}],"LdapLegacyIdentityProviders":[{"LdapHost":"String","LdapPort":0,"LdapUseSsl":false,"LdapConnectionTimeoutInSeconds":0,"LdapAuthType":"String","DirectorySearchFilterPrefix":"String","DirectorySearchFilterSuffix":"String","DirectorySearchFilter":"String","ServicePrincipalUserName":"String","ServicePrincipalPassword":"String","IdentityProviderId":"00000000000000000000000000000000","AuthenticationRealm":"String","AuthenticationRealmFriendlyName":"String","AuthenticationRealmDescription":"String","AuthenticationUrl":"String","IdentityProviderTypeName":"String","InstitutionId":"00000000000000000000000000000000","ClaimProviders":{"LdapClaimProviders":[{"LdapHost":"String","LdapPort":0,"LdapUseSsl":false,"LdapConnectionTimeoutInSeconds":0,"LdapAuthType":"String","UserBindPrefix":"String","UserBindSuffix":"String","IsServicePrincipalRequired":false,"ServicePrincipalUserName":"String","ServicePrincipalPassword":"String","UserGroupSearchPrefix":"String","UserGroupSearchSuffix":"String","IsUserGroupSearchFQDNRequired":false,"UserSearchPrefix":"String","UserSearchSuffix":"String","ClaimProviderId":"00000000000000000000000000000000","ClaimProviderType":{"ClaimProviderTypeId":"00000000000000000000000000000000","ClaimProviderTypeName":"String","Description":"String"}}],"ApiClaimProviders":[{"ApiHostBaseUri":"String","Port":0,"ApiSegment":"String","HeaderKey":"String","HeaderValue":"String","ClaimProviderId":"00000000000000000000000000000000","ClaimProviderType":{"ClaimProviderTypeId":"00000000000000000000000000000000","ClaimProviderTypeName":"String","Description":"String"}}],"DatabaseClaimProviders":[{"ConnectionString":"String","AuthenticationSqlQuery":"String","DatabaseType":"String","ClaimProviderId":"00000000000000000000000000000000","ClaimProviderType":{"ClaimProviderTypeId":"00000000000000000000000000000000","ClaimProviderTypeName":"String","Description":"String"}}],"ActiveDirectoryClaimProviders":[{"Host":"String","Port":0,"ServerBindingOptions":"String","UserNamePrefix":"String","UserNameSuffix":"String","ServicePrincipalUserName":"String","ServicePrincipalPassword":"String","ClaimProviderId":"00000000000000000000000000000000","ClaimProviderType":{"ClaimProviderTypeId":"00000000000000000000000000000000","ClaimProviderTypeName":"String","Description":"String"}}],"LdapLegacyClaimProviders":[{"LdapHost":"String","LdapPort":0,"LdapUseSsl":false,"LdapConnectionTimeoutInSeconds":0,"LdapAuthType":"String","DirectorySearchFilterPrefix":"String","DirectorySearchFilterSuffix":"String","ClaimProviderId":"00000000000000000000000000000000","ClaimProviderType":{"ClaimProviderTypeId":"00000000000000000000000000000000","ClaimProviderTypeName":"String","Description":"String"}}]}}]},"FileTransferProviders":{"SftpFileTransferProviders":[{"SshHostKeyFingerprint":"String","SshPrivateKeyPath":"String","SshPrivateKeyPassphrase":"String","FileTransferProviderId":"00000000000000000000000000000000","FileTransferProviderName":"String","HostName":"String","UserName":"String","EncryptedPassword":"String","PortNumber":0,"ServerResponseTimeoutSeconds":0,"FileTransferProviderTypeName":"String","InstitutionId":"00000000000000000000000000000000"}],"ScpFileTransferProviders":[{"SshHostKeyFingerprint":"String","SshPrivateKeyPath":"String","SshPrivateKeyPassphrase":"String","FileTransferProviderId":"00000000000000000000000000000000","FileTransferProviderName":"String","HostName":"String","UserName":"String","EncryptedPassword":"String","PortNumber":0,"ServerResponseTimeoutSeconds":0,"FileTransferProviderTypeName":"String","InstitutionId":"00000000000000000000000000000000"}],"FtpsFileTransferProviders":[{"TlsHostCertificateFingerprint":"String","FileTransferProviderId":"00000000000000000000000000000000","FileTransferProviderName":"String","HostName":"String","UserName":"String","EncryptedPassword":"String","PortNumber":0,"ServerResponseTimeoutSeconds":0,"FileTransferProviderTypeName":"String","InstitutionId":"00000000000000000000000000000000"}]},"Merchants":[{"MerchantId":"00000000000000000000000000000000","Name":"String","CompanyAddress":"String","ContactName":"String","ContactAddress":"String","ContactEmailAddress":"String","ContactPhone":"String"}]}],"PaginationInfo":{"PageIndex":0,"PageSize":0,"Total":0},"Errors":[{"ErrorId":0,"LocalizedMessage":"String","DomainObjectMetadataCanonicalName":"String","DomainObjectMetadataPropertyCanonicalName":"String"}]}