WestUnCommCode

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getWestUnCommCode

post

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

WestUnCommCodeSelectionintegerRequired

Responses

200

Successful operation.

application/json

post/getWestUnCommCode

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "WestUnCommCode": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getWestUnCommCode"
}

getWestUnCommCodeSelectFields

post

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

WestUnCommCodeSelectionintegerOptional

Responses

200

Successful operation.

application/json

post/getWestUnCommCodeSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "WestUnCommCode": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getWestUnCommCodeSelectFields"
}

getWestUnCommCodePagedList

post

Retrieve WestUnCommCode 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/getWestUnCommCodePagedList

HTTPcURLJavaScriptPython

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

{
  "WestUnCommCode": [],
  "Token": null,
  "MessageId": "getWestUnCommCodePagedList"
}

getWestUnCommCodeListSelectFields

post

Retrieve WestUnCommCode 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/getWestUnCommCodeListSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "WestUnCommCodeList": [],
  "MessageId": "getWestUnCommCodeListSelectFields"
}

searchWestUnCommCodeSelectFields

post

Search WestUnCommCode 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/searchWestUnCommCodeSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "WestUnCommCodeList": [],
  "MessageId": "searchWestUnCommCodeSelectFields"
}

getWestUnCommCodePagedListSelectFields

post

Retrieve WestUnCommCode 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/getWestUnCommCodePagedListSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "WestUnCommCode": [],
  "Token": null,
  "MessageId": "getWestUnCommCodePagedListSelectFields"
}

searchWestUnCommCodePagedSelectFields

post

Search WestUnCommCode 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/searchWestUnCommCodePagedSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "WestUnCommCode": [],
  "Token": null,
  "MessageId": "searchWestUnCommCodePagedSelectFields"
}

updateWestUnCommCodeByID

post

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

WestUnCommCodeSelectionintegerOptional

Responses

200

Successful operation.

application/json

post/updateWestUnCommCodeByID

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

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