Skip to content
NexumAPI Docs

CpWorkCard⁠

Perform various operations on Collection Package (CP) work card records.

Operations⁠

createCpWorkCard⁠

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
CpWorkCardLocatorintegeroptional
POST/nexum/{sym}/2022.01/account/createCpWorkCard
POST /nexum/627/2022.01/account/createCpWorkCard HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CpWorkCardCreatableFields": {
    "Type": 0,
    "Priority": "0",
    "LastCollectorId": 0
  },
  "AccountNumber": "0000000000",
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

createCpWorkCardNote⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CpWorkCardNoteCreatableFields": {
    "Type": 0,
    "Priority": "0",
    "LastCollectorId": 0
  },
  "AccountNumber": "0000000000",
  "CpWorkCardLocator": 0,
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

createCpWorkCardTracking⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CpWorkCardTrackingCreatableFields": {
    "Type": 0,
    "Priority": "0",
    "LastCollectorId": 0
  },
  "AccountNumber": "0000000000",
  "CpWorkCardLocator": 0,
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

deleteCpWorkCard⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
CpWorkCardLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
nxAttributesobjectoptionalThe custom object for NexumAPI response attributes.
POST/nexum/{sym}/2022.01/account/deleteCpWorkCard
POST /nexum/627/2022.01/account/deleteCpWorkCard 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",
  "CpWorkCardLocator": 0,
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

deleteCpWorkCardTracking⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
CpWorkCardLocatorintegeroptional
CpWorkCardTrackingLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
nxAttributesobjectoptionalThe custom object for NexumAPI response attributes.
POST/nexum/{sym}/2022.01/account/deleteCpWorkCardTracking
POST /nexum/627/2022.01/account/deleteCpWorkCardTracking 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",
  "CpWorkCardLocator": 0,
  "CpWorkCardTrackingLocator": 0,
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}