Lookup

Perform various operations on lookup records.

Symitar eDocs References: Coming soon.

Operations

getLookup

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

LookupLocatorintegerOptional

Responses

200

Successful operation.

application/json

post/getLookup

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013454",
  "LookupLocator": 274,
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "Lookup": {
    "Locator": 274,
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getLookup"
}

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/2022.01/account/getLookupSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 257

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013454",
  "LookupLocator": 274,
  "SelectableFields": {
    "IncludeAllLookupFields": true
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "Lookup": {
    "Locator": 274,
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getLookupSelectFields"
}

getLookupPagedList

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getLookupPagedList

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013454",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "Lookup": [],
  "Token": null,
  "MessageId": "getLookupPagedList"
}

getLookupListSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

post/getLookupListSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013454",
  "SelectableFields": {
    "IncludeAllLookupFields": true
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "LookupList": [],
  "MessageId": "getLookupListSelectFields"
}

searchLookupSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

post/searchLookupSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013454",
  "SelectableFields": {
    "IncludeAllLookupFields": true
  },
  "SearchFilter": {
    "Query": "example-query"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "LookupList": [],
  "MessageId": "searchLookupSelectFields"
}

getLookupPagedListSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getLookupPagedListSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013454",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "IncludeAllLookupFields": false,
    "LookupFields": {
      "Locator": true,
      "Type": true,
      "Number": true,
      "Id": true,
      "IdType": true,
      "RecordChangeDate": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "Lookup": [],
  "Token": null,
  "MessageId": "getLookupPagedListSelectFields"
}

searchLookupPagedSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

QuerystringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/searchLookupPagedSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013454",
  "Query": "LOCATOR=0",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "IncludeAllLookupFields": false,
    "LookupFields": {
      "Locator": true,
      "Type": true,
      "Number": true,
      "Id": true,
      "IdType": true,
      "RecordChangeDate": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "Lookup": [],
  "Token": null,
  "MessageId": "searchLookupPagedSelectFields"
}

updateLookupByID

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

LookupLocatorintegerOptional

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

post/updateLookupByID

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013824",
  "LookupLocator": 274,
  "LookupUpdatableFields": {
    "Type": 0,
    "IdType": 0,
    "Id": "0020",
    "Number": "NW4B"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": []
  },
  "MessageId": "updateLookupByID"
}

createLookup

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

LookupLocatorintegerOptional

post/createLookup

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013824",
  "LookupCreatableFields": {
    "Type": 0,
    "IdType": 0,
    "Id": "0020",
    "Number": "NW4A"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "LookupLocator": 274,
  "MessageId": "createLookup"
}

deleteLookup

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

LookupLocatorintegerOptional

Responses

200

Successful operation.

application/json

nxAttributesobjectOptional

The custom object for NexumAPI response attributes.

post/deleteLookup

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013824",
  "LookupLocator": 274,
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "MessageId": "deleteLookup"
}