ParticipantService⁠

Manage participant records.

Operations⁠

getParticipantSelectFields⁠

POST

Retrieves participant information with selected fields.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

ParticipantNumberstringoptional

Path Parameters

symstringrequired: Sym number

Responses

POST/nexum/{sym}/persistent/participant/getParticipantSelectFields

POST /nexum/627/persistent/participant/getParticipantSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ParticipantNumber": "string",
  "SelectableFields": {
    "IncludeAllParticipantFields": true,
    "ParticipantFields": {
      "AchTranCodeOut": true,
      "Active": true,
      "AdjLS": true,
      "Balance": true,
      "BeginningBalLS": true,
      "Branch": true,
      "Buckets": [
        0
      ],
      "ChargeOffBalance": true,
      "ChargebackBalance": true,
      "ChargebackLS": true,
      "ChgOffLoanCount": true,
      "CloseDate": true,
      "DealerAvailBalance": true,
      "DealerTotalBalance": true,
      "FeesLS": true,
      "FmLastPurgeDate": true,
      "HoldbackLS": true,
      "LastDisbursalDate": true,
      "LastFmDate": true,
      "LastPurgeDate": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getParticipantSelectFieldsFilterChildren⁠

POST

Retrieves participant information with selected fields and filters children.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

ParticipantNumberstringoptional

Path Parameters

symstringrequired: Sym number

Responses

POST/nexum/{sym}/persistent/participant/getParticipantSelectFieldsFilterChildren

POST /nexum/627/persistent/participant/getParticipantSelectFieldsFilterChildren HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ParticipantNumber": "string",
  "SelectableFields": {
    "IncludeAllParticipantFields": true,
    "ParticipantFields": {
      "AchTranCodeOut": true,
      "Active": true,
      "AdjLS": true,
      "Balance": true,
      "BeginningBalLS": true,
      "Branch": true,
      "Buckets": [
        0
      ],
      "ChargeOffBalance": true,
      "ChargebackBalance": true,
      "ChargebackLS": true,
      "ChgOffLoanCount": true,
      "CloseDate": true,
      "DealerAvailBalance": true,
      "DealerTotalBalance": true,
      "FeesLS": true,
      "FmLastPurgeDate": true,
      "HoldbackLS": true,
      "LastDisbursalDate": true,
      "LastFmDate": true,
      "LastPurgeDate": true
    },
    "ParticipantFmHistorySelectableFields": {
      "IncludeAllParticipantFmHistoryFields": true,
      "ParticipantFmHistoryFields": {
        "AccountNumber": true,
        "BatchSequence": true,
        "Branch": true,
        "ConfirmationSeq": true,
        "ConsoleNumber": true,
        "DataType": true,
        "FieldNumber": true,
        "FmType": true,
        "Id": true,
        "IdType": true,
        "LastFmDate": true,
        "NewCharacter": true,
        "NewDate": true,
        "NewMoney": true,
        "NewNumber": true,
        "NewRate": true,
        "OldCharacter": true,
        "OldDate": true,
        "OldMoney": true,
        "OldNumber": true
      }
    },
    "ParticipantNoteSelectableFields": {
      "IncludeAllParticipantNoteFields": true,
      "ParticipantNoteFields": {
        "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
      }
    },
    "ParticipantTransactionSelectableFields": {
      "IncludeAllParticipantTransactionFields": true,
      "ParticipantTransactionFields": {
        "ActionCode": true,
        "ActivityDate": true,
        "AdjustmentFlag": true,
        "AgId": true,
        "BalanceChange": true,
        "BatchSequence": true,
        "Branch": true,
        "Comment": true,
        "CommentFlag": true,
        "ConsoleNumber": true,
        "Description": true,
        "EffectiveDate": true,
        "LoanId": true,
        "MemberBranch": true,
        "NewBalance": true,
        "ParticipantNumber": true,
        "ParticipantType": true,
        "PoolNumber": true,
        "PostDate": true,
        "PostTime": true
      }
    }
  },
  "ChildrenSearchFilter": {
    "ParticipantFmHistoryFilter": {
      "StartPostDate": "string",
      "EndPostDate": "string",
      "Query": "string"
    },
    "ParticipantNoteFilter": {
      "Query": "string"
    },
    "ParticipantTransactionFilter": {
      "StartPostDate": "string",
      "EndPostDate": "string",
      "Query": "string"
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getParticipantFmHistoryPagedListSelectFields⁠

POST

Retrieves a paged list of participant FM history with selected fields.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

ParticipantNumberstringoptional

Path Parameters

symstringrequired: Sym number

Responses

Tokenstringoptional

POST/nexum/{sym}/persistent/participant/getParticipantFmHistoryPagedListSelectFields

POST /nexum/627/persistent/participant/getParticipantFmHistoryPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ParticipantNumber": "string",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "SelectableFields": {
    "IncludeAllParticipantFmHistoryFields": true,
    "ParticipantFmHistoryFields": {
      "AccountNumber": true,
      "BatchSequence": true,
      "Branch": true,
      "ConfirmationSeq": true,
      "ConsoleNumber": true,
      "DataType": true,
      "FieldNumber": true,
      "FmType": true,
      "Id": true,
      "IdType": true,
      "LastFmDate": true,
      "NewCharacter": true,
      "NewDate": true,
      "NewMoney": true,
      "NewNumber": true,
      "NewRate": true,
      "OldCharacter": true,
      "OldDate": true,
      "OldMoney": true,
      "OldNumber": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

searchParticipantFmHistoryPagedSelectFields⁠

POST

Searches participant FM history with pagination and selected fields.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

ParticipantNumberstringoptional

Path Parameters

symstringrequired: Sym number

Responses

Tokenstringoptional

POST/nexum/{sym}/persistent/participant/searchParticipantFmHistoryPagedSelectFields

POST /nexum/627/persistent/participant/searchParticipantFmHistoryPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ParticipantNumber": "string",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "SelectableFields": {
    "IncludeAllParticipantFmHistoryFields": true,
    "ParticipantFmHistoryFields": {
      "AccountNumber": true,
      "BatchSequence": true,
      "Branch": true,
      "ConfirmationSeq": true,
      "ConsoleNumber": true,
      "DataType": true,
      "FieldNumber": true,
      "FmType": true,
      "Id": true,
      "IdType": true,
      "LastFmDate": true,
      "NewCharacter": true,
      "NewDate": true,
      "NewMoney": true,
      "NewNumber": true,
      "NewRate": true,
      "OldCharacter": true,
      "OldDate": true,
      "OldMoney": true,
      "OldNumber": true
    }
  },
  "SearchFilter": {
    "StartPostDate": "string",
    "EndPostDate": "string",
    "Query": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getParticipantNoteSelectFields⁠

POST

Retrieves participant notes with selected fields.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

ParticipantNumberstringoptional

ParticipantNoteLocatorintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

POST/nexum/{sym}/persistent/participant/getParticipantNoteSelectFields

POST /nexum/627/persistent/participant/getParticipantNoteSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ParticipantNumber": "string",
  "ParticipantNoteLocator": 0,
  "SelectableFields": {
    "IncludeAllParticipantNoteFields": true,
    "ParticipantNoteFields": {
      "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
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getParticipantNotePagedListSelectFields⁠

POST

Retrieves a paged list of participant notes with selected fields.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

ParticipantNumberstringoptional

Path Parameters

symstringrequired: Sym number

Responses

Tokenstringoptional

POST/nexum/{sym}/persistent/participant/getParticipantNotePagedListSelectFields

POST /nexum/627/persistent/participant/getParticipantNotePagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ParticipantNumber": "string",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "SelectableFields": {
    "IncludeAllParticipantNoteFields": true,
    "ParticipantNoteFields": {
      "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
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}