OnlineOutlet

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getOnlineOutlet

post

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

OnlineOutletBranchNumberintegerRequired

Responses

200

Successful operation.

application/json

post/getOnlineOutlet

HTTPcURLJavaScriptPython

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: 193

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

200

Successful operation.

{
  "OnlineOutlet": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getOnlineOutlet"
}

getOnlineOutletSelectFields

post

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

OnlineOutletBranchNumberintegerOptional

Responses

200

Successful operation.

application/json

post/getOnlineOutletSelectFields

HTTPcURLJavaScriptPython

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: 291

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "OnlineOutletBranchNumber": 0,
  "SelectableFields": {
    "OnlineOutletFields": {
      "BranchNumber": true,
      "InstitutionId": true,
      "NetworkId": true
    }
  }
}

200

Successful operation.

{
  "OnlineOutlet": {
    "BranchNumber": 0,
    "InstitutionId": null,
    "NetworkId": null
  },
  "MessageId": "getOnlineOutletSelectFields"
}

getOnlineOutletPagedList

post

Retrieve OnlineOutlet 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/getOnlineOutletPagedList

HTTPcURLJavaScriptPython

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: 260

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0,
    "Token": "example-token"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "OnlineOutlet": [],
  "Token": null,
  "MessageId": "getOnlineOutletPagedList"
}

getOnlineOutletListSelectFields

post

Retrieve OnlineOutlet 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/getOnlineOutletListSelectFields

HTTPcURLJavaScriptPython

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: 217

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

200

Successful operation.

{
  "OnlineOutletList": [],
  "MessageId": "getOnlineOutletListSelectFields"
}

searchOnlineOutletSelectFields

post

Search OnlineOutlet 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/searchOnlineOutletSelectFields

HTTPcURLJavaScriptPython

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: 255

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

200

Successful operation.

{
  "OnlineOutletList": [],
  "MessageId": "searchOnlineOutletSelectFields"
}

getOnlineOutletPagedListSelectFields

post

Retrieve OnlineOutlet 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/getOnlineOutletPagedListSelectFields

HTTPcURLJavaScriptPython

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: 341

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

200

Successful operation.

{
  "OnlineOutlet": [
    {
      "BranchNumber": 0,
      "InstitutionId": null,
      "NetworkId": null
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getOnlineOutletPagedListSelectFields"
}

searchOnlineOutletPagedSelectFields

post

Search OnlineOutlet 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/searchOnlineOutletPagedSelectFields

HTTPcURLJavaScriptPython

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: 352

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

200

Successful operation.

{
  "OnlineOutlet": [
    {
      "BranchNumber": 0,
      "InstitutionId": null,
      "NetworkId": null
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchOnlineOutletPagedSelectFields"
}

updateOnlineOutletByID

post

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

OnlineOutletBranchNumberintegerOptional

Responses

200

Successful operation.

application/json

post/updateOnlineOutletByID

HTTPcURLJavaScriptPython

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: 264

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "OnlineOutletBranchNumber": "NEXW45",
  "OnlineOutletUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

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