Institution

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getInstitution

post

Get the getInstitution data.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

InstitutionBranchintegerRequired

Responses

200

Successful operation.

application/json

post

/getInstitution

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getInstitution HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 146

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "InstitutionBranch": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "Institution": {
    "Branch": 1,
    "CfpbWebAddress1": "text",
    "CfpbWebAddress2": "text",
    "City": "text",
    "CountryCode": "text",
    "CtrApprover": "text",
    "CtrApproverTitle": "text",
    "CtrContact": "text",
    "CtrContactPhone": "text",
    "CtrContactPhoneExt": "text",
    "CtrPreparer": "text",
    "Ein": "text",
    "ExtraAddress": "text",
    "FiEmail": "text",
    "FiPhone": "text",
    "HudPhone": "text",
    "HudWebAddress1": "text",
    "HudWebAddress2": "text",
    "Name": "text",
    "RoutingNumber": "text",
    "State": "text",
    "Street": "text",
    "Telephone": "text",
    "WebsiteAddr": "text",
    "ZipCode": "text"
  }
}

getInstitutionSelectFields

post

Get the getInstitutionSelectFields data.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

InstitutionBranchintegerOptional

Responses

200

Successful operation.

application/json

post

/getInstitutionSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getInstitutionSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 676

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "InstitutionBranch": 1,
  "SelectableFields": {
    "IncludeAllInstitutionFields": true,
    "InstitutionFields": {
      "Branch": true,
      "CfpbWebAddress1": true,
      "CfpbWebAddress2": true,
      "City": true,
      "CountryCode": true,
      "CtrApprover": true,
      "CtrApproverTitle": true,
      "CtrContact": true,
      "CtrContactPhone": true,
      "CtrContactPhoneExt": true,
      "CtrPreparer": true,
      "Ein": true,
      "ExtraAddress": true,
      "FiEmail": true,
      "FiPhone": true,
      "HudPhone": true,
      "HudWebAddress1": true,
      "HudWebAddress2": true,
      "Name": true,
      "RoutingNumber": true,
      "State": true,
      "Street": true,
      "Telephone": true,
      "WebsiteAddr": true,
      "ZipCode": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "Institution": {
    "Branch": 1,
    "CfpbWebAddress1": "text",
    "CfpbWebAddress2": "text",
    "City": "text",
    "CountryCode": "text",
    "CtrApprover": "text",
    "CtrApproverTitle": "text",
    "CtrContact": "text",
    "CtrContactPhone": "text",
    "CtrContactPhoneExt": "text",
    "CtrPreparer": "text",
    "Ein": "text",
    "ExtraAddress": "text",
    "FiEmail": "text",
    "FiPhone": "text",
    "HudPhone": "text",
    "HudWebAddress1": "text",
    "HudWebAddress2": "text",
    "Name": "text",
    "RoutingNumber": "text",
    "State": "text",
    "Street": "text",
    "Telephone": "text",
    "WebsiteAddr": "text",
    "ZipCode": "text"
  }
}

getInstitutionPagedList

post

Get the getInstitutionPagedList data.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post

/getInstitutionPagedList

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getInstitutionPagedList HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 218

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "Institution": [
    {
      "Branch": 1,
      "CfpbWebAddress1": "text",
      "CfpbWebAddress2": "text",
      "City": "text",
      "CountryCode": "text",
      "CtrApprover": "text",
      "CtrApproverTitle": "text",
      "CtrContact": "text",
      "CtrContactPhone": "text",
      "CtrContactPhoneExt": "text",
      "CtrPreparer": "text",
      "Ein": "text",
      "ExtraAddress": "text",
      "FiEmail": "text",
      "FiPhone": "text",
      "HudPhone": "text",
      "HudWebAddress1": "text",
      "HudWebAddress2": "text",
      "Name": "text",
      "RoutingNumber": "text",
      "State": "text",
      "Street": "text",
      "Telephone": "text",
      "WebsiteAddr": "text",
      "ZipCode": "text"
    }
  ],
  "Token": "text"
}

getInstitutionListSelectFields

post

Get the getInstitutionListSelectFields data.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post

/getInstitutionListSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getInstitutionListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 654

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllInstitutionFields": true,
    "InstitutionFields": {
      "Branch": true,
      "CfpbWebAddress1": true,
      "CfpbWebAddress2": true,
      "City": true,
      "CountryCode": true,
      "CtrApprover": true,
      "CtrApproverTitle": true,
      "CtrContact": true,
      "CtrContactPhone": true,
      "CtrContactPhoneExt": true,
      "CtrPreparer": true,
      "Ein": true,
      "ExtraAddress": true,
      "FiEmail": true,
      "FiPhone": true,
      "HudPhone": true,
      "HudWebAddress1": true,
      "HudWebAddress2": true,
      "Name": true,
      "RoutingNumber": true,
      "State": true,
      "Street": true,
      "Telephone": true,
      "WebsiteAddr": true,
      "ZipCode": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "InstitutionList": {
    "hasReachedMaximumListSize": true,
    "Institution": [
      {
        "Branch": 1,
        "CfpbWebAddress1": "text",
        "CfpbWebAddress2": "text",
        "City": "text",
        "CountryCode": "text",
        "CtrApprover": "text",
        "CtrApproverTitle": "text",
        "CtrContact": "text",
        "CtrContactPhone": "text",
        "CtrContactPhoneExt": "text",
        "CtrPreparer": "text",
        "Ein": "text",
        "ExtraAddress": "text",
        "FiEmail": "text",
        "FiPhone": "text",
        "HudPhone": "text",
        "HudWebAddress1": "text",
        "HudWebAddress2": "text",
        "Name": "text",
        "RoutingNumber": "text",
        "State": "text",
        "Street": "text",
        "Telephone": "text",
        "WebsiteAddr": "text",
        "ZipCode": "text"
      }
    ]
  }
}

searchInstitutionSelectFields

post

Field for selecting various options related to searchinstitutionselectfields

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post

/searchInstitutionSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/searchInstitutionSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 686

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllInstitutionFields": true,
    "InstitutionFields": {
      "Branch": true,
      "CfpbWebAddress1": true,
      "CfpbWebAddress2": true,
      "City": true,
      "CountryCode": true,
      "CtrApprover": true,
      "CtrApproverTitle": true,
      "CtrContact": true,
      "CtrContactPhone": true,
      "CtrContactPhoneExt": true,
      "CtrPreparer": true,
      "Ein": true,
      "ExtraAddress": true,
      "FiEmail": true,
      "FiPhone": true,
      "HudPhone": true,
      "HudWebAddress1": true,
      "HudWebAddress2": true,
      "Name": true,
      "RoutingNumber": true,
      "State": true,
      "Street": true,
      "Telephone": true,
      "WebsiteAddr": true,
      "ZipCode": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "InstitutionList": {
    "hasReachedMaximumListSize": true,
    "Institution": [
      {
        "Branch": 1,
        "CfpbWebAddress1": "text",
        "CfpbWebAddress2": "text",
        "City": "text",
        "CountryCode": "text",
        "CtrApprover": "text",
        "CtrApproverTitle": "text",
        "CtrContact": "text",
        "CtrContactPhone": "text",
        "CtrContactPhoneExt": "text",
        "CtrPreparer": "text",
        "Ein": "text",
        "ExtraAddress": "text",
        "FiEmail": "text",
        "FiPhone": "text",
        "HudPhone": "text",
        "HudWebAddress1": "text",
        "HudWebAddress2": "text",
        "Name": "text",
        "RoutingNumber": "text",
        "State": "text",
        "Street": "text",
        "Telephone": "text",
        "WebsiteAddr": "text",
        "ZipCode": "text"
      }
    ]
  }
}

getInstitutionPagedListSelectFields

post

Get the getInstitutionPagedListSelectFields data.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post

/getInstitutionPagedListSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getInstitutionPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 748

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllInstitutionFields": true,
    "InstitutionFields": {
      "Branch": true,
      "CfpbWebAddress1": true,
      "CfpbWebAddress2": true,
      "City": true,
      "CountryCode": true,
      "CtrApprover": true,
      "CtrApproverTitle": true,
      "CtrContact": true,
      "CtrContactPhone": true,
      "CtrContactPhoneExt": true,
      "CtrPreparer": true,
      "Ein": true,
      "ExtraAddress": true,
      "FiEmail": true,
      "FiPhone": true,
      "HudPhone": true,
      "HudWebAddress1": true,
      "HudWebAddress2": true,
      "Name": true,
      "RoutingNumber": true,
      "State": true,
      "Street": true,
      "Telephone": true,
      "WebsiteAddr": true,
      "ZipCode": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "Institution": [
    {
      "Branch": 1,
      "CfpbWebAddress1": "text",
      "CfpbWebAddress2": "text",
      "City": "text",
      "CountryCode": "text",
      "CtrApprover": "text",
      "CtrApproverTitle": "text",
      "CtrContact": "text",
      "CtrContactPhone": "text",
      "CtrContactPhoneExt": "text",
      "CtrPreparer": "text",
      "Ein": "text",
      "ExtraAddress": "text",
      "FiEmail": "text",
      "FiPhone": "text",
      "HudPhone": "text",
      "HudWebAddress1": "text",
      "HudWebAddress2": "text",
      "Name": "text",
      "RoutingNumber": "text",
      "State": "text",
      "Street": "text",
      "Telephone": "text",
      "WebsiteAddr": "text",
      "ZipCode": "text"
    }
  ],
  "Token": "text"
}

searchInstitutionPagedSelectFields

post

Field for selecting various options related to searchinstitutionpagedselectfields

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

QuerystringOptional

Responses

200

Successful operation.

application/json

post

/searchInstitutionPagedSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/searchInstitutionPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 763

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllInstitutionFields": true,
    "InstitutionFields": {
      "Branch": true,
      "CfpbWebAddress1": true,
      "CfpbWebAddress2": true,
      "City": true,
      "CountryCode": true,
      "CtrApprover": true,
      "CtrApproverTitle": true,
      "CtrContact": true,
      "CtrContactPhone": true,
      "CtrContactPhoneExt": true,
      "CtrPreparer": true,
      "Ein": true,
      "ExtraAddress": true,
      "FiEmail": true,
      "FiPhone": true,
      "HudPhone": true,
      "HudWebAddress1": true,
      "HudWebAddress2": true,
      "Name": true,
      "RoutingNumber": true,
      "State": true,
      "Street": true,
      "Telephone": true,
      "WebsiteAddr": true,
      "ZipCode": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "Institution": [
    {
      "Branch": 1,
      "CfpbWebAddress1": "text",
      "CfpbWebAddress2": "text",
      "City": "text",
      "CountryCode": "text",
      "CtrApprover": "text",
      "CtrApproverTitle": "text",
      "CtrContact": "text",
      "CtrContactPhone": "text",
      "CtrContactPhoneExt": "text",
      "CtrPreparer": "text",
      "Ein": "text",
      "ExtraAddress": "text",
      "FiEmail": "text",
      "FiPhone": "text",
      "HudPhone": "text",
      "HudWebAddress1": "text",
      "HudWebAddress2": "text",
      "Name": "text",
      "RoutingNumber": "text",
      "State": "text",
      "Street": "text",
      "Telephone": "text",
      "WebsiteAddr": "text",
      "ZipCode": "text"
    }
  ],
  "Token": "text"
}

updateInstitutionByID

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

InstitutionBranchintegerOptional

Responses

200

Successful operation.

application/json

post

/updateInstitutionByID

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/updateInstitutionByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 663

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "InstitutionBranch": 1,
  "InstitutionUpdatableFields": {
    "CfpbWebAddress1": "text",
    "CfpbWebAddress2": "text",
    "City": "text",
    "CountryCode": "text",
    "CtrApprover": "text",
    "CtrApproverTitle": "text",
    "CtrContact": "text",
    "CtrContactPhone": "text",
    "CtrContactPhoneExt": "text",
    "CtrPreparer": "text",
    "Ein": "text",
    "ExtraAddress": "text",
    "FiEmail": "text",
    "FiPhone": "text",
    "HudPhone": "text",
    "HudWebAddress1": "text",
    "HudWebAddress2": "text",
    "Name": "text",
    "RoutingNumber": "text",
    "State": "text",
    "Street": "text",
    "Telephone": "text",
    "WebsiteAddr": "text",
    "ZipCode": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": [
      {
        "Record": "text",
        "ErrorCode": "text",
        "ErrorMessage": "text",
        "PrimaryKeyField": [
          {
            "Name": "text",
            "Value": "text"
          }
        ]
      }
    ]
  }
}