OnlineOutlet

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getOnlineOutlet

post

Online outlet

Authorizations
Body
OnlineOutletBranchNumberintegerRequired
Responses
200

Successful operation.

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

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

Successful operation.

{
  "OnlineOutlet": {
    "BranchNumber": 1,
    "InstitutionId": "text",
    "NetworkId": "text",
    "PseudoTerminalId": "text",
    "TerminalIdPrefix": "text"
  }
}

getOnlineOutletSelectFields

post

Online outlet select fields

Authorizations
Body
OnlineOutletBranchNumberintegerOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "OnlineOutletBranchNumber": 1,
  "SelectableFields": {
    "IncludeAllOnlineOutletFields": true,
    "OnlineOutletFields": {
      "BranchNumber": true,
      "InstitutionId": true,
      "NetworkId": true,
      "PseudoTerminalId": true,
      "TerminalIdPrefix": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "OnlineOutlet": {
    "BranchNumber": 1,
    "InstitutionId": "text",
    "NetworkId": "text",
    "PseudoTerminalId": "text",
    "TerminalIdPrefix": "text"
  }
}

getOnlineOutletPagedList

post

Online outlet paged list

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/getOnlineOutletPagedList
POST /nexum/627/2022.01/parameter/getOnlineOutletPagedList HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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.

{
  "OnlineOutlet": [
    {
      "BranchNumber": 1,
      "InstitutionId": "text",
      "NetworkId": "text",
      "PseudoTerminalId": "text",
      "TerminalIdPrefix": "text"
    }
  ],
  "Token": "text"
}

getOnlineOutletListSelectFields

post

Online outlet list select fields

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllOnlineOutletFields": true,
    "OnlineOutletFields": {
      "BranchNumber": true,
      "InstitutionId": true,
      "NetworkId": true,
      "PseudoTerminalId": true,
      "TerminalIdPrefix": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "OnlineOutletList": {
    "hasReachedMaximumListSize": true,
    "OnlineOutlet": [
      {
        "BranchNumber": 1,
        "InstitutionId": "text",
        "NetworkId": "text",
        "PseudoTerminalId": "text",
        "TerminalIdPrefix": "text"
      }
    ]
  }
}

searchOnlineOutletSelectFields

post

Retrieve a list of select fields for online outlets

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllOnlineOutletFields": true,
    "OnlineOutletFields": {
      "BranchNumber": true,
      "InstitutionId": true,
      "NetworkId": true,
      "PseudoTerminalId": true,
      "TerminalIdPrefix": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "OnlineOutletList": {
    "hasReachedMaximumListSize": true,
    "OnlineOutlet": [
      {
        "BranchNumber": 1,
        "InstitutionId": "text",
        "NetworkId": "text",
        "PseudoTerminalId": "text",
        "TerminalIdPrefix": "text"
      }
    ]
  }
}

getOnlineOutletPagedListSelectFields

post

Online outlet paged list select fields

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllOnlineOutletFields": true,
    "OnlineOutletFields": {
      "BranchNumber": true,
      "InstitutionId": true,
      "NetworkId": true,
      "PseudoTerminalId": true,
      "TerminalIdPrefix": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "OnlineOutlet": [
    {
      "BranchNumber": 1,
      "InstitutionId": "text",
      "NetworkId": "text",
      "PseudoTerminalId": "text",
      "TerminalIdPrefix": "text"
    }
  ],
  "Token": "text"
}

searchOnlineOutletPagedSelectFields

post

Retrieve a paged list of select fields for online outlets

Authorizations
Body
QuerystringOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllOnlineOutletFields": true,
    "OnlineOutletFields": {
      "BranchNumber": true,
      "InstitutionId": true,
      "NetworkId": true,
      "PseudoTerminalId": true,
      "TerminalIdPrefix": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "OnlineOutlet": [
    {
      "BranchNumber": 1,
      "InstitutionId": "text",
      "NetworkId": "text",
      "PseudoTerminalId": "text",
      "TerminalIdPrefix": "text"
    }
  ],
  "Token": "text"
}

updateOnlineOutletByID

post

Update online outlets by ID

Authorizations
Body
OnlineOutletBranchNumberintegerOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "OnlineOutletBranchNumber": 1,
  "OnlineOutletUpdatableFields": {
    "InstitutionId": "text",
    "NetworkId": "text",
    "PseudoTerminalId": "text",
    "TerminalIdPrefix": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

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

Last updated

Was this helpful?