OnlineOutlet⁠

Perform various operations for Symitar parameters.

Operations⁠

getOnlineOutletSelectFields⁠

POST

Execute the persistent ParameterService getOnlineOutletSelectFields operation.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

OnlineOutletBranchNumberintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

MessageIdstringoptional

POST/nexum/{sym}/persistent/parameter/getOnlineOutletSelectFields

POST /nexum/627/persistent/parameter/getOnlineOutletSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "OnlineOutletBranchNumber": 0,
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "SelectableFields": {
    "IncludeAllOnlineOutletFields": true,
    "OnlineOutletFields": {
      "BranchNumber": true,
      "InstitutionId": true,
      "NetworkId": true,
      "PseudoTerminalId": true,
      "TerminalIdPrefix": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getOnlineOutletPagedListSelectFields⁠

POST

Execute the persistent ParameterService getOnlineOutletPagedListSelectFields operation.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

Path Parameters

symstringrequired: Sym number

Responses

Tokenstringoptional

MessageIdstringoptional

POST/nexum/{sym}/persistent/parameter/getOnlineOutletPagedListSelectFields

POST /nexum/627/persistent/parameter/getOnlineOutletPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "SelectableFields": {
    "IncludeAllOnlineOutletFields": true,
    "OnlineOutletFields": {
      "BranchNumber": true,
      "InstitutionId": true,
      "NetworkId": true,
      "PseudoTerminalId": true,
      "TerminalIdPrefix": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

searchOnlineOutletPagedSelectFields⁠

POST

Execute the persistent ParameterService searchOnlineOutletPagedSelectFields operation.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

Path Parameters

symstringrequired: Sym number

Responses

Tokenstringoptional

MessageIdstringoptional

POST/nexum/{sym}/persistent/parameter/searchOnlineOutletPagedSelectFields

POST /nexum/627/persistent/parameter/searchOnlineOutletPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "SelectableFields": {
    "IncludeAllOnlineOutletFields": true,
    "OnlineOutletFields": {
      "BranchNumber": true,
      "InstitutionId": true,
      "NetworkId": true,
      "PseudoTerminalId": true,
      "TerminalIdPrefix": true
    }
  },
  "SearchFilter": {
    "Query": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}

updateOnlineOutletByID⁠

POST

Execute the persistent ParameterService updateOnlineOutletByID operation.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

OnlineOutletBranchNumberintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

MessageIdstringoptional

POST/nexum/{sym}/persistent/parameter/updateOnlineOutletByID

POST /nexum/627/persistent/parameter/updateOnlineOutletByID HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "OnlineOutletBranchNumber": 0,
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "OnlineOutletFields": {
    "BranchNumber": 0,
    "InstitutionId": "string",
    "NetworkId": "string",
    "PseudoTerminalId": "string",
    "TerminalIdPrefix": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}