Cdm

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getCdm

post

Authorizations

Body

CdmCdmintegerRequired

Responses

200

Successful operation.

application/json

post

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CdmCdm": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "Cdm": {
    "CassDenom6DuressAuto1Notes": [
      {
        "EntryId": 1,
        "CassDenom6DuressAuto1Notes": 1
      }
    ],
    "CassDenom6DuressAuto2Notes": [
      {
        "EntryId": 1,
        "CassDenom6DuressAuto2Notes": 1
      }
    ],
    "CassDenom6DuressAuto3Notes": [
      {
        "EntryId": 1,
        "CassDenom6DuressAuto3Notes": 1
      }
    ],
    "CassetteDenomAutomixNotes": [
      {
        "EntryId": 1,
        "CassetteDenomAutomixNotes": 1
      }
    ],
    "CassetteDenomination": [
      {
        "EntryId": 1,
        "CassetteDenomination": 1
      }
    ],
    "Cdm": 1,
    "CdmDuressDispAmt": 1,
    "CdmDuressSilentAlarm": true,
    "ConsoleFileName": "text",
    "ConsoleFileNameExt": "text",
    "LeftCoinDispenser": true,
    "MachineType": 1,
    "Recycler": true,
    "RemoteDevice": true,
    "RightCoinDispenser": true
  }
}

getCdmSelectFields

post

Authorizations

Body

CdmCdmintegerOptional

Responses

200

Successful operation.

application/json

post

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CdmCdm": 1,
  "SelectableFields": {
    "IncludeAllCdmFields": true,
    "CdmFields": {
      "CassDenom6DuressAuto1Notes": [
        1
      ],
      "CassDenom6DuressAuto2Notes": [
        1
      ],
      "CassDenom6DuressAuto3Notes": [
        1
      ],
      "CassetteDenomAutomixNotes": [
        1
      ],
      "CassetteDenomination": [
        1
      ],
      "Cdm": true,
      "CdmDuressDispAmt": true,
      "CdmDuressSilentAlarm": true,
      "ConsoleFileName": true,
      "ConsoleFileNameExt": true,
      "LeftCoinDispenser": true,
      "MachineType": true,
      "Recycler": true,
      "RemoteDevice": true,
      "RightCoinDispenser": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "Cdm": {
    "CassDenom6DuressAuto1Notes": [
      {
        "EntryId": 1,
        "CassDenom6DuressAuto1Notes": 1
      }
    ],
    "CassDenom6DuressAuto2Notes": [
      {
        "EntryId": 1,
        "CassDenom6DuressAuto2Notes": 1
      }
    ],
    "CassDenom6DuressAuto3Notes": [
      {
        "EntryId": 1,
        "CassDenom6DuressAuto3Notes": 1
      }
    ],
    "CassetteDenomAutomixNotes": [
      {
        "EntryId": 1,
        "CassetteDenomAutomixNotes": 1
      }
    ],
    "CassetteDenomination": [
      {
        "EntryId": 1,
        "CassetteDenomination": 1
      }
    ],
    "Cdm": 1,
    "CdmDuressDispAmt": 1,
    "CdmDuressSilentAlarm": true,
    "ConsoleFileName": "text",
    "ConsoleFileNameExt": "text",
    "LeftCoinDispenser": true,
    "MachineType": 1,
    "Recycler": true,
    "RemoteDevice": true,
    "RightCoinDispenser": true
  }
}

getCdmPagedList

post

Authorizations

Body

Responses

200

Successful operation.

application/json

post

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "Cdm": [
    {
      "CassDenom6DuressAuto1Notes": [
        {
          "EntryId": 1,
          "CassDenom6DuressAuto1Notes": 1
        }
      ],
      "CassDenom6DuressAuto2Notes": [
        {
          "EntryId": 1,
          "CassDenom6DuressAuto2Notes": 1
        }
      ],
      "CassDenom6DuressAuto3Notes": [
        {
          "EntryId": 1,
          "CassDenom6DuressAuto3Notes": 1
        }
      ],
      "CassetteDenomAutomixNotes": [
        {
          "EntryId": 1,
          "CassetteDenomAutomixNotes": 1
        }
      ],
      "CassetteDenomination": [
        {
          "EntryId": 1,
          "CassetteDenomination": 1
        }
      ],
      "Cdm": 1,
      "CdmDuressDispAmt": 1,
      "CdmDuressSilentAlarm": true,
      "ConsoleFileName": "text",
      "ConsoleFileNameExt": "text",
      "LeftCoinDispenser": true,
      "MachineType": 1,
      "Recycler": true,
      "RemoteDevice": true,
      "RightCoinDispenser": true
    }
  ],
  "Token": "text"
}

getCdmListSelectFields

post

Authorizations

Body

Responses

200

Successful operation.

application/json

post

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllCdmFields": true,
    "CdmFields": {
      "CassDenom6DuressAuto1Notes": [
        1
      ],
      "CassDenom6DuressAuto2Notes": [
        1
      ],
      "CassDenom6DuressAuto3Notes": [
        1
      ],
      "CassetteDenomAutomixNotes": [
        1
      ],
      "CassetteDenomination": [
        1
      ],
      "Cdm": true,
      "CdmDuressDispAmt": true,
      "CdmDuressSilentAlarm": true,
      "ConsoleFileName": true,
      "ConsoleFileNameExt": true,
      "LeftCoinDispenser": true,
      "MachineType": true,
      "Recycler": true,
      "RemoteDevice": true,
      "RightCoinDispenser": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "CdmList": {
    "hasReachedMaximumListSize": true,
    "Cdm": [
      {
        "CassDenom6DuressAuto1Notes": [
          {
            "EntryId": 1,
            "CassDenom6DuressAuto1Notes": 1
          }
        ],
        "CassDenom6DuressAuto2Notes": [
          {
            "EntryId": 1,
            "CassDenom6DuressAuto2Notes": 1
          }
        ],
        "CassDenom6DuressAuto3Notes": [
          {
            "EntryId": 1,
            "CassDenom6DuressAuto3Notes": 1
          }
        ],
        "CassetteDenomAutomixNotes": [
          {
            "EntryId": 1,
            "CassetteDenomAutomixNotes": 1
          }
        ],
        "CassetteDenomination": [
          {
            "EntryId": 1,
            "CassetteDenomination": 1
          }
        ],
        "Cdm": 1,
        "CdmDuressDispAmt": 1,
        "CdmDuressSilentAlarm": true,
        "ConsoleFileName": "text",
        "ConsoleFileNameExt": "text",
        "LeftCoinDispenser": true,
        "MachineType": 1,
        "Recycler": true,
        "RemoteDevice": true,
        "RightCoinDispenser": true
      }
    ]
  }
}

searchCdmSelectFields

post

Search CDM select fields

Authorizations

Body

Responses

200

Successful operation.

application/json

post

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllCdmFields": true,
    "CdmFields": {
      "CassDenom6DuressAuto1Notes": [
        1
      ],
      "CassDenom6DuressAuto2Notes": [
        1
      ],
      "CassDenom6DuressAuto3Notes": [
        1
      ],
      "CassetteDenomAutomixNotes": [
        1
      ],
      "CassetteDenomination": [
        1
      ],
      "Cdm": true,
      "CdmDuressDispAmt": true,
      "CdmDuressSilentAlarm": true,
      "ConsoleFileName": true,
      "ConsoleFileNameExt": true,
      "LeftCoinDispenser": true,
      "MachineType": true,
      "Recycler": true,
      "RemoteDevice": true,
      "RightCoinDispenser": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "CdmList": {
    "hasReachedMaximumListSize": true,
    "Cdm": [
      {
        "CassDenom6DuressAuto1Notes": [
          {
            "EntryId": 1,
            "CassDenom6DuressAuto1Notes": 1
          }
        ],
        "CassDenom6DuressAuto2Notes": [
          {
            "EntryId": 1,
            "CassDenom6DuressAuto2Notes": 1
          }
        ],
        "CassDenom6DuressAuto3Notes": [
          {
            "EntryId": 1,
            "CassDenom6DuressAuto3Notes": 1
          }
        ],
        "CassetteDenomAutomixNotes": [
          {
            "EntryId": 1,
            "CassetteDenomAutomixNotes": 1
          }
        ],
        "CassetteDenomination": [
          {
            "EntryId": 1,
            "CassetteDenomination": 1
          }
        ],
        "Cdm": 1,
        "CdmDuressDispAmt": 1,
        "CdmDuressSilentAlarm": true,
        "ConsoleFileName": "text",
        "ConsoleFileNameExt": "text",
        "LeftCoinDispenser": true,
        "MachineType": 1,
        "Recycler": true,
        "RemoteDevice": true,
        "RightCoinDispenser": true
      }
    ]
  }
}

getCdmPagedListSelectFields

post

Authorizations

Body

Responses

200

Successful operation.

application/json

post

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllCdmFields": true,
    "CdmFields": {
      "CassDenom6DuressAuto1Notes": [
        1
      ],
      "CassDenom6DuressAuto2Notes": [
        1
      ],
      "CassDenom6DuressAuto3Notes": [
        1
      ],
      "CassetteDenomAutomixNotes": [
        1
      ],
      "CassetteDenomination": [
        1
      ],
      "Cdm": true,
      "CdmDuressDispAmt": true,
      "CdmDuressSilentAlarm": true,
      "ConsoleFileName": true,
      "ConsoleFileNameExt": true,
      "LeftCoinDispenser": true,
      "MachineType": true,
      "Recycler": true,
      "RemoteDevice": true,
      "RightCoinDispenser": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "Cdm": [
    {
      "CassDenom6DuressAuto1Notes": [
        {
          "EntryId": 1,
          "CassDenom6DuressAuto1Notes": 1
        }
      ],
      "CassDenom6DuressAuto2Notes": [
        {
          "EntryId": 1,
          "CassDenom6DuressAuto2Notes": 1
        }
      ],
      "CassDenom6DuressAuto3Notes": [
        {
          "EntryId": 1,
          "CassDenom6DuressAuto3Notes": 1
        }
      ],
      "CassetteDenomAutomixNotes": [
        {
          "EntryId": 1,
          "CassetteDenomAutomixNotes": 1
        }
      ],
      "CassetteDenomination": [
        {
          "EntryId": 1,
          "CassetteDenomination": 1
        }
      ],
      "Cdm": 1,
      "CdmDuressDispAmt": 1,
      "CdmDuressSilentAlarm": true,
      "ConsoleFileName": "text",
      "ConsoleFileNameExt": "text",
      "LeftCoinDispenser": true,
      "MachineType": 1,
      "Recycler": true,
      "RemoteDevice": true,
      "RightCoinDispenser": true
    }
  ],
  "Token": "text"
}

searchCdmPagedSelectFields

post

Search CDM paged select fields

Authorizations

Body

QuerystringOptional

Responses

200

Successful operation.

application/json

post

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllCdmFields": true,
    "CdmFields": {
      "CassDenom6DuressAuto1Notes": [
        1
      ],
      "CassDenom6DuressAuto2Notes": [
        1
      ],
      "CassDenom6DuressAuto3Notes": [
        1
      ],
      "CassetteDenomAutomixNotes": [
        1
      ],
      "CassetteDenomination": [
        1
      ],
      "Cdm": true,
      "CdmDuressDispAmt": true,
      "CdmDuressSilentAlarm": true,
      "ConsoleFileName": true,
      "ConsoleFileNameExt": true,
      "LeftCoinDispenser": true,
      "MachineType": true,
      "Recycler": true,
      "RemoteDevice": true,
      "RightCoinDispenser": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "Cdm": [
    {
      "CassDenom6DuressAuto1Notes": [
        {
          "EntryId": 1,
          "CassDenom6DuressAuto1Notes": 1
        }
      ],
      "CassDenom6DuressAuto2Notes": [
        {
          "EntryId": 1,
          "CassDenom6DuressAuto2Notes": 1
        }
      ],
      "CassDenom6DuressAuto3Notes": [
        {
          "EntryId": 1,
          "CassDenom6DuressAuto3Notes": 1
        }
      ],
      "CassetteDenomAutomixNotes": [
        {
          "EntryId": 1,
          "CassetteDenomAutomixNotes": 1
        }
      ],
      "CassetteDenomination": [
        {
          "EntryId": 1,
          "CassetteDenomination": 1
        }
      ],
      "Cdm": 1,
      "CdmDuressDispAmt": 1,
      "CdmDuressSilentAlarm": true,
      "ConsoleFileName": "text",
      "ConsoleFileNameExt": "text",
      "LeftCoinDispenser": true,
      "MachineType": 1,
      "Recycler": true,
      "RemoteDevice": true,
      "RightCoinDispenser": true
    }
  ],
  "Token": "text"
}

getCdmCommon

post

Authorizations

Body

Responses

200

Successful operation.

application/json

post

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "CdmCommon": {
    "CdmDuressAutoMixDescr": [
      {
        "EntryId": 1,
        "CdmDuressAutoMixDescr": "text"
      }
    ],
    "ExternalHostName": "text",
    "ExternalHostNameExt": "text",
    "ExternalKeystorePassword": "text",
    "ExternalUserName": "text",
    "ExternalUserPassword": "text",
    "LowCassetteAutoDispCash": true,
    "MaximumCdmAmount": 1,
    "TcrDuressDispAmt": 1,
    "TwinSafeGlobalUserId": "text",
    "CashMachineRelease": 1
  }
}

getCdmCommonSelectFields

post

Authorizations

Body

Responses

200

Successful operation.

application/json

post

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllCdmCommonFields": true,
    "CdmCommonFields": {
      "CashMachineRelease": true,
      "CdmDuressAutoMixDescr": [
        1
      ],
      "ExternalHostName": true,
      "ExternalHostNameExt": true,
      "ExternalKeystorePassword": true,
      "ExternalUserName": true,
      "ExternalUserPassword": true,
      "LowCassetteAutoDispCash": true,
      "MaximumCdmAmount": true,
      "TcrDuressDispAmt": true,
      "TwinSafeGlobalUserId": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "CdmCommon": {
    "CdmDuressAutoMixDescr": [
      {
        "EntryId": 1,
        "CdmDuressAutoMixDescr": "text"
      }
    ],
    "ExternalHostName": "text",
    "ExternalHostNameExt": "text",
    "ExternalKeystorePassword": "text",
    "ExternalUserName": "text",
    "ExternalUserPassword": "text",
    "LowCassetteAutoDispCash": true,
    "MaximumCdmAmount": 1,
    "TcrDuressDispAmt": 1,
    "TwinSafeGlobalUserId": "text",
    "CashMachineRelease": 1
  }
}

updateCdmByID

post

Update CDM by ID

Authorizations

Body

CdmCdmintegerOptional

Responses

200

Successful operation.

application/json

post

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CdmCdm": 1,
  "CdmUpdatableFields": {
    "CassDenom6DuressAuto1Notes": [
      {
        "EntryId": 1,
        "CassDenom6DuressAuto1Notes": 1
      }
    ],
    "CassDenom6DuressAuto2Notes": [
      {
        "EntryId": 1,
        "CassDenom6DuressAuto2Notes": 1
      }
    ],
    "CassDenom6DuressAuto3Notes": [
      {
        "EntryId": 1,
        "CassDenom6DuressAuto3Notes": 1
      }
    ],
    "CassetteDenomAutomixNotes": [
      {
        "EntryId": 1,
        "CassetteDenomAutomixNotes": 1
      }
    ],
    "CassetteDenomination": [
      {
        "EntryId": 1,
        "CassetteDenomination": 1
      }
    ],
    "CdmDuressDispAmt": 1,
    "CdmDuressSilentAlarm": true,
    "ConsoleFileName": "text",
    "ConsoleFileNameExt": "text",
    "LeftCoinDispenser": true,
    "MachineType": 1,
    "Recycler": true,
    "RemoteDevice": true,
    "RightCoinDispenser": true
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": [
      {
        "Record": "text",
        "ErrorCode": "text",
        "ErrorMessage": "text",
        "PrimaryKeyField": [
          {
            "Name": "text",
            "Value": "text"
          }
        ]
      }
    ]
  }
}

updateCdmCommonByID

post

Update CDM Common by ID

Authorizations

Body

Responses

200

Successful operation.

application/json

post

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CdmCommonUpdatableFields": {
    "CashMachineRelease": 1,
    "CdmDuressAutoMixDescr": [
      {
        "EntryId": 1,
        "CdmDuressAutoMixDescr": "text"
      }
    ],
    "ExternalHostName": "text",
    "ExternalHostNameExt": "text",
    "ExternalKeystorePassword": "text",
    "ExternalUserName": "text",
    "ExternalUserPassword": "text",
    "LowCassetteAutoDispCash": true,
    "MaximumCdmAmount": 1,
    "TcrDuressDispAmt": 1,
    "TwinSafeGlobalUserId": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": [
      {
        "Record": "text",
        "ErrorCode": "text",
        "ErrorMessage": "text",
        "PrimaryKeyField": [
          {
            "Name": "text",
            "Value": "text"
          }
        ]
      }
    ]
  }
}