Lookup

Perform various operations on lookup records.

Symitar eDocs References: Coming soon.

Operations

getLookupSelectFields

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

AccountNumberstringOptional

LookupLocatorintegerOptional

Responses

200

Successful operation.

application/json

post/getLookupSelectFields

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: 235

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000013454",
  "LookupLocator": 273,
  "SelectableFields": {
    "IncludeAllLookupFields": true
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

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

getLookupPagedListSelectFields

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getLookupPagedListSelectFields

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: 401

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "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

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/searchLookupPagedSelectFields

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: 421

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "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

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

AccountNumberstringOptional

LookupLocatorintegerOptional

Responses

200

Successful operation.

application/json

post/updateLookupByID

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: 249

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000013824",
  "LookupLocator": 273,
  "LookupFields": {
    "Type": 0,
    "IdType": 0,
    "Id": "0020",
    "Number": "NW4B"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": null,
    "Version_1": null,
    "_value_1": null
  },
  "MessageId": "updateLookupByID"
}

createLookup

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

LookupLocatorintegerOptional

post/createLookup

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: 229

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000013824",
  "LookupFields": {
    "Type": 0,
    "IdType": 0,
    "Id": "0020",
    "Number": "NW4A"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

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

deleteLookup

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

AccountNumberstringOptional

LookupLocatorintegerOptional

Responses

200

Successful operation.

application/json

nxAttributesobjectOptional

The custom object for NexumAPI response attributes.

post/deleteLookup

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: 184

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000013824",
  "LookupLocator": 273,
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "MessageId": "deleteLookup"
}