Institution

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getInstitution

post

Retrieve Institution parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

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: 179

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "InstitutionBranch": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "Institution": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getInstitution"
}

getInstitutionSelectFields

post

Retrieve Institution parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

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: 276

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "InstitutionBranch": 0,
  "SelectableFields": {
    "InstitutionFields": {
      "Branch": true,
      "Name": true,
      "City": true,
      "State": true
    }
  }
}

200

Successful operation.

{
  "Institution": {
    "Branch": 0,
    "City": "San Diego",
    "Name": "Symitar General Ledger",
    "State": "CA"
  },
  "MessageId": "getInstitutionSelectFields"
}

getInstitutionPagedList

post

Retrieve Institution parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

TokenstringOptional

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: 260

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0,
    "Token": "example-token"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "Institution": [],
  "Token": null,
  "MessageId": "getInstitutionPagedList"
}

getInstitutionListSelectFields

post

Retrieve Institution parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

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: 216

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "SelectableFields": {
    "IncludeAllInstitutionFields": true
  }
}

200

Successful operation.

{
  "InstitutionList": [],
  "MessageId": "getInstitutionListSelectFields"
}

searchInstitutionSelectFields

post

Search Institution parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

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: 254

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "SelectableFields": {
    "IncludeAllInstitutionFields": true
  },
  "SearchFilter": {
    "Query": "example-query"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "InstitutionList": [],
  "MessageId": "searchInstitutionSelectFields"
}

getInstitutionPagedListSelectFields

post

Retrieve Institution parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

TokenstringOptional

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: 333

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "InstitutionFields": {
      "Branch": true,
      "Name": true,
      "City": true,
      "State": true
    }
  }
}

200

Successful operation.

{
  "Institution": [
    {
      "Branch": 0,
      "City": "San Diego",
      "Name": "Symitar General Ledger",
      "State": "CA"
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getInstitutionPagedListSelectFields"
}

searchInstitutionPagedSelectFields

post

Search Institution parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

QuerystringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

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: 344

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "Query": "",
  "SelectableFields": {
    "InstitutionFields": {
      "Branch": true,
      "Name": true,
      "City": true,
      "State": true
    }
  }
}

200

Successful operation.

{
  "Institution": [
    {
      "Branch": 0,
      "City": "San Diego",
      "Name": "Symitar General Ledger",
      "State": "CA"
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchInstitutionPagedSelectFields"
}

updateInstitutionByID

post

Update Institution parameter configuration. Parameter updates can change institution behavior and should be tested in a controlled environment before use.

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: 249

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "InstitutionBranch": 1,
  "InstitutionUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": []
  },
  "MessageId": "updateInstitutionByID"
}