Skip to content
NexumAPI Docs

Site⁠

Perform various operations on site records.

Operations⁠

getSiteSelectFields⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
SiteLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/persistent/account/getSiteSelectFields
POST /nexum/627/persistent/account/getSiteSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "string",
  "SiteLocator": 0,
  "SelectableFields": {
    "IncludeAllSiteFields": true,
    "SiteFields": {
      "City": true,
      "CloseDate": true,
      "ContactPhone": true,
      "ExtraAddress": true,
      "FaxPhone": true,
      "Locator": true,
      "RecordChangeDate": true,
      "SiteContactName": true,
      "SiteId": true,
      "SiteName": true,
      "SiteNumber": true,
      "SiteSettleShareId": true,
      "State": true,
      "Street": true,
      "ZipCode": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getSiteSelectFieldsFilterChildren⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
SiteLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/persistent/account/getSiteSelectFieldsFilterChildren
POST /nexum/627/persistent/account/getSiteSelectFieldsFilterChildren HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "string",
  "SiteLocator": 0,
  "SelectableFields": {
    "IncludeAllSiteFields": true,
    "SiteFields": {
      "City": true,
      "CloseDate": true,
      "ContactPhone": true,
      "ExtraAddress": true,
      "FaxPhone": true,
      "Locator": true,
      "RecordChangeDate": true,
      "SiteContactName": true,
      "SiteId": true,
      "SiteName": true,
      "SiteNumber": true,
      "SiteSettleShareId": true,
      "State": true,
      "Street": true,
      "ZipCode": true
    },
    "SiteCashOrderTypeSelectableFields": {
      "IncludeAllSiteCashOrderTypeFields": true,
      "SiteCashOrderTypeFields": {
        "ActiveFlag": true,
        "ApplyHandlingFee": true,
        "CashOrderTypeCoinBag": [
          0
        ],
        "CashOrderTypeCoinRoll": [
          0
        ],
        "CashOrderTypeComment": [
          0
        ],
        "CashOrderTypeCurrFit": [
          0
        ],
        "CashOrderTypeCurrNew": [
          0
        ],
        "CashOrderTypeDelCharge": true,
        "CashOrderTypeMaxOrder": true,
        "CashOrderTypeMinOrder": true,
        "CashOrderTypeName": true,
        "CashOrderTypeSpecDelCharge": true,
        "CloseDate": true,
        "DelFrequency": true,
        "DeliveryDays": [
          0
        ],
        "LocationCode": true,
        "Locator": true,
        "OrderLimiting": true,
        "RecordChangeDate": true,
        "SpecHandlingFee": true
      }
    }
  },
  "ChildrenSearchFilter": {
    "SiteCashOrderTypeFilter": {
      "Query": "string"
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getSitePagedListSelectFields⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
Path Parameters
symstringrequired
Sym number
Responses
Tokenstringoptional
POST/nexum/{sym}/persistent/account/getSitePagedListSelectFields
POST /nexum/627/persistent/account/getSitePagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "IncludeAllSiteFields": false,
    "SiteFields": {
      "Locator": true,
      "SiteId": true,
      "SiteName": true,
      "SiteNumber": true,
      "City": true,
      "State": true,
      "RecordChangeDate": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

searchSitePagedSelectFields⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
Path Parameters
symstringrequired
Sym number
Responses
Tokenstringoptional
POST/nexum/{sym}/persistent/account/searchSitePagedSelectFields
POST /nexum/627/persistent/account/searchSitePagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "Query": "string",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "IncludeAllSiteFields": false,
    "SiteFields": {
      "Locator": true,
      "SiteId": true,
      "SiteName": true,
      "SiteNumber": true,
      "City": true,
      "State": true,
      "RecordChangeDate": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getSiteCashOrderTypeSelectFields⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
SiteLocatorintegeroptional
SiteCashOrderTypeLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/persistent/account/getSiteCashOrderTypeSelectFields
POST /nexum/627/persistent/account/getSiteCashOrderTypeSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "string",
  "SiteLocator": 0,
  "SiteCashOrderTypeLocator": 0,
  "SelectableFields": {
    "IncludeAllSiteCashOrderTypeFields": true,
    "SiteCashOrderTypeFields": {
      "ActiveFlag": true,
      "ApplyHandlingFee": true,
      "CashOrderTypeCoinBag": [
        0
      ],
      "CashOrderTypeCoinRoll": [
        0
      ],
      "CashOrderTypeComment": [
        0
      ],
      "CashOrderTypeCurrFit": [
        0
      ],
      "CashOrderTypeCurrNew": [
        0
      ],
      "CashOrderTypeDelCharge": true,
      "CashOrderTypeMaxOrder": true,
      "CashOrderTypeMinOrder": true,
      "CashOrderTypeName": true,
      "CashOrderTypeSpecDelCharge": true,
      "CloseDate": true,
      "DelFrequency": true,
      "DeliveryDays": [
        0
      ],
      "LocationCode": true,
      "Locator": true,
      "OrderLimiting": true,
      "RecordChangeDate": true,
      "SpecHandlingFee": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getSiteCashOrderTypePagedListSelectFields⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
SiteLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
Tokenstringoptional
POST/nexum/{sym}/persistent/account/getSiteCashOrderTypePagedListSelectFields
POST /nexum/627/persistent/account/getSiteCashOrderTypePagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "string",
  "SiteLocator": 0,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "SelectableFields": {
    "IncludeAllSiteCashOrderTypeFields": true,
    "SiteCashOrderTypeFields": {
      "ActiveFlag": true,
      "ApplyHandlingFee": true,
      "CashOrderTypeCoinBag": [
        0
      ],
      "CashOrderTypeCoinRoll": [
        0
      ],
      "CashOrderTypeComment": [
        0
      ],
      "CashOrderTypeCurrFit": [
        0
      ],
      "CashOrderTypeCurrNew": [
        0
      ],
      "CashOrderTypeDelCharge": true,
      "CashOrderTypeMaxOrder": true,
      "CashOrderTypeMinOrder": true,
      "CashOrderTypeName": true,
      "CashOrderTypeSpecDelCharge": true,
      "CloseDate": true,
      "DelFrequency": true,
      "DeliveryDays": [
        0
      ],
      "LocationCode": true,
      "Locator": true,
      "OrderLimiting": true,
      "RecordChangeDate": true,
      "SpecHandlingFee": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

searchSiteCashOrderTypePagedSelectFields⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
SiteLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
Tokenstringoptional
POST/nexum/{sym}/persistent/account/searchSiteCashOrderTypePagedSelectFields
POST /nexum/627/persistent/account/searchSiteCashOrderTypePagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "string",
  "SiteLocator": 0,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "SelectableFields": {
    "IncludeAllSiteCashOrderTypeFields": true,
    "SiteCashOrderTypeFields": {
      "ActiveFlag": true,
      "ApplyHandlingFee": true,
      "CashOrderTypeCoinBag": [
        0
      ],
      "CashOrderTypeCoinRoll": [
        0
      ],
      "CashOrderTypeComment": [
        0
      ],
      "CashOrderTypeCurrFit": [
        0
      ],
      "CashOrderTypeCurrNew": [
        0
      ],
      "CashOrderTypeDelCharge": true,
      "CashOrderTypeMaxOrder": true,
      "CashOrderTypeMinOrder": true,
      "CashOrderTypeName": true,
      "CashOrderTypeSpecDelCharge": true,
      "CloseDate": true,
      "DelFrequency": true,
      "DeliveryDays": [
        0
      ],
      "LocationCode": true,
      "Locator": true,
      "OrderLimiting": true,
      "RecordChangeDate": true,
      "SpecHandlingFee": true
    }
  },
  "SearchFilter": {
    "Query": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}

updateSiteByID⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
SiteLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/persistent/account/updateSiteByID
POST /nexum/627/persistent/account/updateSiteByID HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "SiteLocator": 0,
  "SiteFields": {
    "SiteName": "string",
    "Street": "string",
    "City": "string",
    "State": "string",
    "ZipCode": "0"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

updateSiteCashOrderTypeByID⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
SiteLocatorintegeroptional
SiteCashOrderTypeLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/persistent/account/updateSiteCashOrderTypeByID
POST /nexum/627/persistent/account/updateSiteCashOrderTypeByID HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "SiteLocator": 0,
  "SiteCashOrderTypeLocator": 0,
  "SiteCashOrderTypeFields": {},
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

createSite⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/persistent/account/createSite
POST /nexum/627/persistent/account/createSite HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "SiteFields": {
    "SiteId": "string",
    "SiteName": "string",
    "SiteNumber": 0,
    "Street": "string",
    "City": "string",
    "State": "string",
    "ZipCode": "0"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

createSiteCashOrderType⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
SiteLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
SiteCashOrderTypeLocatorintegeroptional
POST/nexum/{sym}/persistent/account/createSiteCashOrderType
POST /nexum/627/persistent/account/createSiteCashOrderType HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "SiteLocator": 0,
  "SiteCashOrderTypeFields": {},
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}