ExtLoan

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getExtLoan

post

Retrieve ExtLoan 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

ExtLoanProcessorintegerRequired

Responses

200

Successful operation.

application/json

post/getExtLoan

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "ExtLoan": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getExtLoan"
}

getExtLoanSelectFields

post

Retrieve ExtLoan 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

ExtLoanProcessorintegerOptional

Responses

200

Successful operation.

application/json

post/getExtLoanSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "ExtLoanProcessor": 1,
  "SelectableFields": {
    "ExtLoanFields": {
      "Processor": true,
      "ProcessorName": true,
      "ProcessorCode": true
    }
  }
}

200

Successful operation.

{
  "ExtLoan": {
    "Processor": 1,
    "ProcessorCode": 0,
    "ProcessorName": null
  },
  "MessageId": "getExtLoanSelectFields"
}

getExtLoanPagedList

post

Retrieve ExtLoan 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/getExtLoanPagedList

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getExtLoanPagedList 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.

{
  "ExtLoan": [],
  "Token": null,
  "MessageId": "getExtLoanPagedList"
}

getExtLoanListSelectFields

post

Retrieve ExtLoan 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/getExtLoanListSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "ExtLoanList": [],
  "MessageId": "getExtLoanListSelectFields"
}

searchExtLoanSelectFields

post

Search ExtLoan 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/searchExtLoanSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "ExtLoanList": [],
  "MessageId": "searchExtLoanSelectFields"
}

getExtLoanPagedListSelectFields

post

Retrieve ExtLoan 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/getExtLoanPagedListSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "ExtLoanFields": {
      "Processor": true,
      "ProcessorName": true,
      "ProcessorCode": true
    }
  }
}

200

Successful operation.

{
  "ExtLoan": [
    {
      "Processor": 1,
      "ProcessorCode": 0,
      "ProcessorName": null
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getExtLoanPagedListSelectFields"
}

searchExtLoanPagedSelectFields

post

Search ExtLoan 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/searchExtLoanPagedSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "Query": "",
  "SelectableFields": {
    "ExtLoanFields": {
      "Processor": true,
      "ProcessorName": true,
      "ProcessorCode": true
    }
  }
}

200

Successful operation.

{
  "ExtLoan": [
    {
      "Processor": 1,
      "ProcessorCode": 0,
      "ProcessorName": null
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchExtLoanPagedSelectFields"
}

updateExtLoanByID

post

Update ExtLoan 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

ExtLoanProcessorintegerOptional

Responses

200

Successful operation.

application/json

post/updateExtLoanByID

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

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