Skip to content
NexumAPI Docs

CpWorkCard⁠

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

Operations⁠

getCpWorkCardSelectFields⁠

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
POST/nexum/{sym}/persistent/account/getCpWorkCardSelectFields
POST /nexum/627/persistent/account/getCpWorkCardSelectFields 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,
  "SelectableFields": {
    "IncludeAllCpWorkCardFields": false,
    "CpWorkCardFields": {
      "Locator": true,
      "Type": true,
      "Active": true,
      "Priority": true,
      "LastWorkDate": true,
      "NextWorkDate": true,
      "RecordChangeDate": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getCpWorkCardSelectFieldsFilterChildren⁠

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
POST/nexum/{sym}/persistent/account/getCpWorkCardSelectFieldsFilterChildren
POST /nexum/627/persistent/account/getCpWorkCardSelectFieldsFilterChildren 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",
  "CpWorkCardLocator": 0,
  "SelectableFields": {
    "IncludeAllCpWorkCardFields": true,
    "CpWorkCardFields": {
      "Active": true,
      "CloseDate": true,
      "FmLastDate": true,
      "LastCollectorId": true,
      "LastWorkDate": true,
      "LastWorktime": true,
      "Locator": true,
      "NextWorkDate": true,
      "NotePurgeDate": true,
      "Priority": true,
      "RecordChangeDate": true,
      "SecCollectorId": [
        0
      ],
      "SecPriority": [
        0
      ],
      "Type": true
    },
    "CpWorkCardNoteSelectableFields": {
      "IncludeAllCpWorkCardNoteFields": true,
      "CpWorkCardNoteFields": {
        "Code": true,
        "EnterDate": true,
        "EnterTime": true,
        "ExpirationDate": true,
        "Id": true,
        "IdType": true,
        "Locator": true,
        "RecordChangeDate": true,
        "Text": [
          0
        ],
        "TextLineCount": true,
        "UserId": true,
        "VoidFlag": true,
        "VoidedBy": true
      }
    },
    "CpWorkCardTrackingSelectableFields": {
      "IncludeAllCpWorkCardTrackingFields": true,
      "CpWorkCardTrackingFields": {
        "CreationDate": true,
        "CreationTime": true,
        "ExpireDate": true,
        "FmLastDate": true,
        "Id": true,
        "IdType": true,
        "Locator": true,
        "RecordChangeDate": true,
        "TrackingCode": true,
        "Type": true,
        "UserAmount1": true,
        "UserAmount10": true,
        "UserAmount11": true,
        "UserAmount12": true,
        "UserAmount13": true,
        "UserAmount14": true,
        "UserAmount15": true,
        "UserAmount16": true,
        "UserAmount17": true,
        "UserAmount18": true
      }
    }
  },
  "ChildrenSearchFilter": {
    "CpWorkCardNoteFilter": {
      "Query": "string"
    },
    "CpWorkCardTrackingFilter": {
      "Query": "string"
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getCpWorkCardPagedListSelectFields⁠

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/getCpWorkCardPagedListSelectFields
POST /nexum/627/persistent/account/getCpWorkCardPagedListSelectFields 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": {
    "IncludeAllCpWorkCardFields": false,
    "CpWorkCardFields": {
      "Locator": true,
      "Type": true,
      "Active": true,
      "Priority": true,
      "LastWorkDate": true,
      "NextWorkDate": true,
      "RecordChangeDate": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

searchCpWorkCardPagedSelectFields⁠

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/searchCpWorkCardPagedSelectFields
POST /nexum/627/persistent/account/searchCpWorkCardPagedSelectFields 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": {
    "IncludeAllCpWorkCardFields": false,
    "CpWorkCardFields": {
      "Locator": true,
      "Type": true,
      "Active": true,
      "Priority": true,
      "LastWorkDate": true,
      "NextWorkDate": true,
      "RecordChangeDate": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getCpWorkCardNoteSelectFields⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
CpWorkCardLocatorintegeroptional
CpWorkCardNoteLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/persistent/account/getCpWorkCardNoteSelectFields
POST /nexum/627/persistent/account/getCpWorkCardNoteSelectFields 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,
  "CpWorkCardNoteLocator": 0,
  "SelectableFields": {
    "IncludeAllCpWorkCardNoteFields": false,
    "CpWorkCardNoteFields": {
      "Locator": true,
      "Code": true,
      "EnterDate": true,
      "ExpirationDate": true,
      "RecordChangeDate": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getCpWorkCardNotePagedListSelectFields⁠

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
Tokenstringoptional
POST/nexum/{sym}/persistent/account/getCpWorkCardNotePagedListSelectFields
POST /nexum/627/persistent/account/getCpWorkCardNotePagedListSelectFields 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,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "IncludeAllCpWorkCardNoteFields": false,
    "CpWorkCardNoteFields": {
      "Locator": true,
      "Code": true,
      "EnterDate": true,
      "ExpirationDate": true,
      "RecordChangeDate": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}