InqDefinition

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getInqDefinition

post

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

InqDefinitionInquiryNumberintegerRequired

Responses

200

Successful operation.

application/json

post/getInqDefinition

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "InqDefinition": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getInqDefinition"
}

getInqDefinitionSelectFields

post

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

InqDefinitionInquiryNumberintegerOptional

Responses

200

Successful operation.

application/json

post/getInqDefinitionSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "InqDefinitionInquiryNumber": 0,
  "SelectableFields": {
    "InqDefinitionFields": {
      "InquiryNumber": true,
      "InquiryName": true,
      "Selection": true
    }
  }
}

200

Successful operation.

{
  "InqDefinition": {
    "CardNameRecord": [],
    "InqField": [],
    "InquiryName": null,
    "InquiryNumber": 0,
    "Selection": 0,
    "SubField": []
  },
  "MessageId": "getInqDefinitionSelectFields"
}

getInqDefinitionPagedList

post

Retrieve InqDefinition 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/getInqDefinitionPagedList

HTTPcURLJavaScriptPython

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

{
  "InqDefinition": [],
  "Token": null,
  "MessageId": "getInqDefinitionPagedList"
}

getInqDefinitionListSelectFields

post

Retrieve InqDefinition 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/getInqDefinitionListSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "InqDefinitionList": [],
  "MessageId": "getInqDefinitionListSelectFields"
}

searchInqDefinitionSelectFields

post

Search InqDefinition 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/searchInqDefinitionSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "InqDefinitionList": [],
  "MessageId": "searchInqDefinitionSelectFields"
}

getInqDefinitionPagedListSelectFields

post

Retrieve InqDefinition 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/getInqDefinitionPagedListSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "InqDefinitionFields": {
      "InquiryNumber": true,
      "InquiryName": true,
      "Selection": true
    }
  }
}

200

Successful operation.

{
  "InqDefinition": [
    {
      "CardNameRecord": [],
      "InqField": [],
      "InquiryName": null,
      "InquiryNumber": 0,
      "Selection": 0,
      "SubField": []
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getInqDefinitionPagedListSelectFields"
}

searchInqDefinitionPagedSelectFields

post

Search InqDefinition 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/searchInqDefinitionPagedSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "Query": "",
  "SelectableFields": {
    "InqDefinitionFields": {
      "InquiryNumber": true,
      "InquiryName": true,
      "Selection": true
    }
  }
}

200

Successful operation.

{
  "InqDefinition": [
    {
      "CardNameRecord": [],
      "InqField": [],
      "InquiryName": null,
      "InquiryNumber": 0,
      "Selection": 0,
      "SubField": []
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchInqDefinitionPagedSelectFields"
}

updateInqDefinitionByID

post

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

InqDefinitionInquiryNumberintegerOptional

Responses

200

Successful operation.

application/json

post/updateInqDefinitionByID

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "InqDefinitionInquiryNumber": "NEXW45",
  "InqDefinitionUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

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