InsType

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getInsType

post

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

InsTypeInsuranceTypeintegerRequired

Responses

200

Successful operation.

application/json

post/getInsType

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getInsType 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
      }
    }
  },
  "InsTypeInsuranceType": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "InsType": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getInsType"
}

getInsTypeSelectFields

post

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

InsTypeInsuranceTypeintegerOptional

Responses

200

Successful operation.

application/json

post/getInsTypeSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "InsTypeInsuranceType": 0,
  "SelectableFields": {
    "InsTypeFields": {
      "InsuranceType": true,
      "ShortDescription": true,
      "DefinedCode": true
    }
  }
}

200

Successful operation.

{
  "InsType": {
    "DefinedCode": 0,
    "InsuranceType": 0,
    "ShortDescription": null
  },
  "MessageId": "getInsTypeSelectFields"
}

getInsTypePagedList

post

Retrieve InsType 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/getInsTypePagedList

HTTPcURLJavaScriptPython

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

{
  "InsType": [],
  "Token": null,
  "MessageId": "getInsTypePagedList"
}

getInsTypeListSelectFields

post

Retrieve InsType 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/getInsTypeListSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getInsTypeListSelectFields 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": {
    "IncludeAllInsTypeFields": true
  }
}

200

Successful operation.

{
  "InsTypeList": [],
  "MessageId": "getInsTypeListSelectFields"
}

searchInsTypeSelectFields

post

Search InsType 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/searchInsTypeSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/searchInsTypeSelectFields 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": {
    "IncludeAllInsTypeFields": true
  },
  "SearchFilter": {
    "Query": "example-query"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "InsTypeList": [],
  "MessageId": "searchInsTypeSelectFields"
}

getInsTypePagedListSelectFields

post

Retrieve InsType 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/getInsTypePagedListSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "InsTypeFields": {
      "InsuranceType": true,
      "ShortDescription": true,
      "DefinedCode": true
    }
  }
}

200

Successful operation.

{
  "InsType": [
    {
      "DefinedCode": 0,
      "InsuranceType": 0,
      "ShortDescription": null
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getInsTypePagedListSelectFields"
}

searchInsTypePagedSelectFields

post

Search InsType 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/searchInsTypePagedSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "Query": "",
  "SelectableFields": {
    "InsTypeFields": {
      "InsuranceType": true,
      "ShortDescription": true,
      "DefinedCode": true
    }
  }
}

200

Successful operation.

{
  "InsType": [
    {
      "DefinedCode": 0,
      "InsuranceType": 0,
      "ShortDescription": null
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchInsTypePagedSelectFields"
}

updateInsTypeByID

post

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

InsTypeInsuranceTypeintegerOptional

Responses

200

Successful operation.

application/json

post/updateInsTypeByID

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

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