Lookup

Perform various operations on lookup records.

Symitar eDocs References: Coming soon.

Operations

getLookupSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

LookupLocatorintegerOptional

Responses

200

Successful operation.

application/json

post

/getLookupSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/account/getLookupSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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-12-25",
    "Type": 1
  }
}

getLookupPagedListSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

post

/getLookupPagedListSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/account/getLookupPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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-12-25",
      "Type": 1
    }
  ],
  "Token": "text"
}

searchLookupPagedSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

post

/searchLookupPagedSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/account/searchLookupPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 445

{
  "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
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

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

updateLookupByID

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

LookupLocatorintegerOptional

Responses

200

Successful operation.

application/json

post

/updateLookupByID

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/account/updateLookupByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 289

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "LookupLocator": 1,
  "LookupFields": {
    "Id": "text",
    "IdType": 1,
    "Locator": 1,
    "Number": "text",
    "RecordChangeDate": "2025-12-25",
    "Type": 1
  },
  "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

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

post

/createLookup

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/account/createLookup HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 271

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "LookupFields": {
    "Id": "text",
    "IdType": 1,
    "Locator": 1,
    "Number": "text",
    "RecordChangeDate": "2025-12-25",
    "Type": 1
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "LookupLocator": 1
}

deleteLookup

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

LookupLocatorintegerOptional

Responses

200

Successful operation.

application/json

post

/deleteLookup

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/account/deleteLookup HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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": {}
}