EscrowType

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getEscrowType

post

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

EscrowTypeEscrowTypeintegerRequired

Responses

200

Successful operation.

application/json

post/getEscrowType

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "EscrowType": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getEscrowType"
}

getEscrowTypeSelectFields

post

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

EscrowTypeEscrowTypeintegerOptional

Responses

200

Successful operation.

application/json

post/getEscrowTypeSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "EscrowTypeEscrowType": 0,
  "SelectableFields": {
    "EscrowTypeFields": {
      "EscrowType": true,
      "Description": true,
      "DefinedCode": true
    }
  }
}

200

Successful operation.

{
  "EscrowType": {
    "DefinedCode": 0,
    "Description": null,
    "EscrowType": 0
  },
  "MessageId": "getEscrowTypeSelectFields"
}

getEscrowTypePagedList

post

Retrieve EscrowType 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/getEscrowTypePagedList

HTTPcURLJavaScriptPython

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

{
  "EscrowType": [],
  "Token": null,
  "MessageId": "getEscrowTypePagedList"
}

getEscrowTypeListSelectFields

post

Retrieve EscrowType 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/getEscrowTypeListSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "EscrowTypeList": [],
  "MessageId": "getEscrowTypeListSelectFields"
}

searchEscrowTypeSelectFields

post

Search EscrowType 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/searchEscrowTypeSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "EscrowTypeList": [],
  "MessageId": "searchEscrowTypeSelectFields"
}

getEscrowTypePagedListSelectFields

post

Retrieve EscrowType 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/getEscrowTypePagedListSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getEscrowTypePagedListSelectFields 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": {
    "EscrowTypeFields": {
      "EscrowType": true,
      "Description": true,
      "DefinedCode": true
    }
  }
}

200

Successful operation.

{
  "EscrowType": [
    {
      "DefinedCode": 0,
      "Description": null,
      "EscrowType": 0
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getEscrowTypePagedListSelectFields"
}

searchEscrowTypePagedSelectFields

post

Search EscrowType 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/searchEscrowTypePagedSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/searchEscrowTypePagedSelectFields 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": {
    "EscrowTypeFields": {
      "EscrowType": true,
      "Description": true,
      "DefinedCode": true
    }
  }
}

200

Successful operation.

{
  "EscrowType": [
    {
      "DefinedCode": 0,
      "Description": null,
      "EscrowType": 0
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchEscrowTypePagedSelectFields"
}

updateEscrowTypeByID

post

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

EscrowTypeEscrowTypeintegerOptional

Responses

200

Successful operation.

application/json

post/updateEscrowTypeByID

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

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