Cdm

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getCdm

post

Retrieve Cdm parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

CdmCdmintegerRequired

Responses

200

Successful operation.

application/json

post/getCdm

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CdmCdm": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "Cdm": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getCdm"
}

getCdmSelectFields

post

Retrieve Cdm parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

CdmCdmintegerOptional

Responses

200

Successful operation.

application/json

post/getCdmSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "CdmCdm": 0,
  "SelectableFields": {
    "IncludeAllCdmFields": true
  }
}

200

Successful operation.

{
  "Cdm": {
    "Cdm": 0,
    "CdmDuressDispAmt": "0.00",
    "CdmDuressSilentAlarm": false,
    "ConsoleFileName": "host/cdm0:12300",
    "LeftCoinDispenser": true,
    "MachineType": 0,
    "Recycler": false
  },
  "MessageId": "getCdmSelectFields"
}

getCdmPagedList

post

Retrieve Cdm parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getCdmPagedList

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0,
    "Token": "example-token"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "Cdm": [],
  "Token": null,
  "MessageId": "getCdmPagedList"
}

getCdmListSelectFields

post

Retrieve Cdm parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

post/getCdmListSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "SelectableFields": {
    "IncludeAllCdmFields": true
  }
}

200

Successful operation.

{
  "CdmList": [],
  "MessageId": "getCdmListSelectFields"
}

searchCdmSelectFields

post

Search Cdm parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

post/searchCdmSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllCdmFields": true
  },
  "SearchFilter": {
    "Query": "example-query"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "CdmList": [],
  "MessageId": "searchCdmSelectFields"
}

getCdmPagedListSelectFields

post

Retrieve Cdm parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getCdmPagedListSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "IncludeAllCdmFields": true
  }
}

200

Successful operation.

{
  "Cdm": [
    {
      "Cdm": 0,
      "CdmDuressDispAmt": "0.00",
      "CdmDuressSilentAlarm": false,
      "ConsoleFileName": "host/cdm0:12300",
      "LeftCoinDispenser": true,
      "MachineType": 0,
      "Recycler": false
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getCdmPagedListSelectFields"
}

searchCdmPagedSelectFields

post

Search Cdm parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

QuerystringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/searchCdmPagedSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "Query": "",
  "SelectableFields": {
    "IncludeAllCdmFields": true
  }
}

200

Successful operation.

{
  "Cdm": [
    {
      "Cdm": 0,
      "CdmDuressDispAmt": "0.00",
      "CdmDuressSilentAlarm": false,
      "ConsoleFileName": "host/cdm0:12300",
      "LeftCoinDispenser": true,
      "MachineType": 0,
      "Recycler": false
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchCdmPagedSelectFields"
}

getCdmCommon

post

Retrieve CdmCommon parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

post/getCdmCommon

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "CdmCommon": {
    "CdmDuressAutoMixDescr": [
      {
        "EntryId": 1,
        "CdmDuressAutoMixDescr": "Automix 1"
      }
    ],
    "LowCassetteAutoDispCash": false,
    "MaximumCdmAmount": "5000.00",
    "TcrDuressDispAmt": "0.00",
    "CashMachineRelease": 0
  },
  "MessageId": "getCdmCommon"
}

getCdmCommonSelectFields

post

Retrieve CdmCommon parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

post/getCdmCommonSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "SelectableFields": {
    "IncludeAllCdmCommonFields": true
  }
}

200

Successful operation.

{
  "CdmCommon": {
    "CdmDuressAutoMixDescr": [
      {
        "EntryId": 1,
        "CdmDuressAutoMixDescr": "Automix 1"
      }
    ],
    "ExternalHostName": null,
    "LowCassetteAutoDispCash": false,
    "MaximumCdmAmount": "5000.00",
    "TcrDuressDispAmt": "0.00",
    "CashMachineRelease": 0
  },
  "MessageId": "getCdmCommonSelectFields"
}

updateCdmByID

post

Update Cdm parameter configuration. Parameter updates can change institution behavior and should be tested in a controlled environment before use.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

CdmCdmintegerOptional

Responses

200

Successful operation.

application/json

post/updateCdmByID

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CdmCdm": 1,
  "CdmUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

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

updateCdmCommonByID

post

Update CdmCommon parameter configuration. Parameter updates can change institution behavior and should be tested in a controlled environment before use.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

post/updateCdmCommonByID

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CdmCommonUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

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