Lookup

Perform various operations on lookup records.

Symitar eDocs References: Coming soon.

Operations

getLookup

post
Authorizations
Body
AccountNumberstringOptional
LookupLocatorintegerOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/account/getLookup HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 180

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "LookupLocator": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Lookup": {
    "Id": "text",
    "IdType": 1,
    "Locator": 1,
    "Number": "text",
    "RecordChangeDate": "2025-06-23",
    "Type": 1
  }
}

getLookupSelectFields

post
Authorizations
Body
AccountNumberstringOptional
LookupLocatorintegerOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/account/getLookupSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 337

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "LookupLocator": 1,
  "SelectableFields": {
    "IncludeAllLookupFields": true,
    "LookupFields": {
      "Id": true,
      "IdType": true,
      "Locator": true,
      "Number": true,
      "RecordChangeDate": true,
      "Type": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Lookup": {
    "Id": "text",
    "IdType": 1,
    "Locator": 1,
    "Number": "text",
    "RecordChangeDate": "2025-06-23",
    "Type": 1
  }
}

getLookupPagedList

post
Authorizations
Body
AccountNumberstringOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/account/getLookupPagedList HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 256

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Lookup": [
    {
      "Id": "text",
      "IdType": 1,
      "Locator": 1,
      "Number": "text",
      "RecordChangeDate": "2025-06-23",
      "Type": 1
    }
  ],
  "Token": "text"
}

getLookupListSelectFields

post
Authorizations
Body
AccountNumberstringOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/account/getLookupListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 319

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "SelectableFields": {
    "IncludeAllLookupFields": true,
    "LookupFields": {
      "Id": true,
      "IdType": true,
      "Locator": true,
      "Number": true,
      "RecordChangeDate": true,
      "Type": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "LookupList": {
    "hasReachedMaximumListSize": true,
    "Lookup": [
      {
        "Id": "text",
        "IdType": 1,
        "Locator": 1,
        "Number": "text",
        "RecordChangeDate": "2025-06-23",
        "Type": 1
      }
    ]
  }
}

searchLookupSelectFields

post
Authorizations
Body
AccountNumberstringOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/account/searchLookupSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 351

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "SelectableFields": {
    "IncludeAllLookupFields": true,
    "LookupFields": {
      "Id": true,
      "IdType": true,
      "Locator": true,
      "Number": true,
      "RecordChangeDate": true,
      "Type": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "LookupList": {
    "hasReachedMaximumListSize": true,
    "Lookup": [
      {
        "Id": "text",
        "IdType": 1,
        "Locator": 1,
        "Number": "text",
        "RecordChangeDate": "2025-06-23",
        "Type": 1
      }
    ]
  }
}

getLookupPagedListSelectFields

post
Authorizations
Body
AccountNumberstringOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/account/getLookupPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 413

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllLookupFields": true,
    "LookupFields": {
      "Id": true,
      "IdType": true,
      "Locator": true,
      "Number": true,
      "RecordChangeDate": true,
      "Type": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Lookup": [
    {
      "Id": "text",
      "IdType": 1,
      "Locator": 1,
      "Number": "text",
      "RecordChangeDate": "2025-06-23",
      "Type": 1
    }
  ],
  "Token": "text"
}

searchLookupPagedSelectFields

post
Authorizations
Body
AccountNumberstringOptional
QuerystringOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/account/searchLookupPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 428

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllLookupFields": true,
    "LookupFields": {
      "Id": true,
      "IdType": true,
      "Locator": true,
      "Number": true,
      "RecordChangeDate": true,
      "Type": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Lookup": [
    {
      "Id": "text",
      "IdType": 1,
      "Locator": 1,
      "Number": "text",
      "RecordChangeDate": "2025-06-23",
      "Type": 1
    }
  ],
  "Token": "text"
}

updateLookupByID

post
Authorizations
Body
LookupLocatorintegerOptional
AccountNumberstringOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/account/updateLookupByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 254

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "LookupLocator": 1,
  "LookupUpdatableFields": {
    "Id": "text",
    "IdType": 1,
    "Number": "text",
    "Type": 1
  },
  "AccountNumber": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": [
      {
        "Record": "text",
        "ErrorCode": "text",
        "ErrorMessage": "text",
        "PrimaryKeyField": [
          {
            "Name": "text",
            "Value": "text"
          }
        ]
      }
    ]
  }
}

createLookup

post
Authorizations
Body
AccountNumberstringOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/account/createLookup HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 236

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "LookupCreatableFields": {
    "Id": "text",
    "IdType": 1,
    "Number": "text",
    "Type": 1
  },
  "AccountNumber": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "LookupLocator": 1
}

deleteLookup

post
Authorizations
Body
AccountNumberstringOptional
LookupLocatorintegerOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/account/deleteLookup HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 180

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "LookupLocator": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "nxAttributes": {}
}
PreviousupdateLoanAppNextName

Last updated

Was this helpful?