InventoryType

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getInventoryType

post

Retrieve InventoryType parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

InventoryTypeInventoryTypeintegerRequired

Responses

200

Successful operation.

application/json

post/getInventoryType

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "InventoryTypeInventoryType": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "InventoryType": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getInventoryType"
}

getInventoryTypeSelectFields

post

Retrieve InventoryType parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

InventoryTypeInventoryTypeintegerOptional

Responses

200

Successful operation.

application/json

post/getInventoryTypeSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "InventoryTypeInventoryType": 0,
  "SelectableFields": {
    "InventoryTypeFields": {
      "InventoryType": true,
      "Description": true,
      "ScreenDefinitionType": true
    }
  }
}

200

Successful operation.

{
  "InventoryType": {
    "Description": "Money Order",
    "InventoryType": 0,
    "ScreenDefinitionType": 0
  },
  "MessageId": "getInventoryTypeSelectFields"
}

getInventoryTypePagedList

post

Retrieve InventoryType parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getInventoryTypePagedList

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0,
    "Token": "example-token"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "InventoryType": [],
  "Token": null,
  "MessageId": "getInventoryTypePagedList"
}

getInventoryTypeListSelectFields

post

Retrieve InventoryType parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

post/getInventoryTypeListSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "SelectableFields": {
    "IncludeAllInventoryTypeFields": true
  }
}

200

Successful operation.

{
  "InventoryTypeList": [],
  "MessageId": "getInventoryTypeListSelectFields"
}

searchInventoryTypeSelectFields

post

Search InventoryType parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

post/searchInventoryTypeSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllInventoryTypeFields": true
  },
  "SearchFilter": {
    "Query": "example-query"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "InventoryTypeList": [],
  "MessageId": "searchInventoryTypeSelectFields"
}

getInventoryTypePagedListSelectFields

post

Retrieve InventoryType parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getInventoryTypePagedListSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "InventoryTypeFields": {
      "InventoryType": true,
      "Description": true,
      "ScreenDefinitionType": true
    }
  }
}

200

Successful operation.

{
  "InventoryType": [
    {
      "Description": "Money Order",
      "InventoryType": 0,
      "ScreenDefinitionType": 0
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getInventoryTypePagedListSelectFields"
}

searchInventoryTypePagedSelectFields

post

Search InventoryType parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

QuerystringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/searchInventoryTypePagedSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "Query": "",
  "SelectableFields": {
    "InventoryTypeFields": {
      "InventoryType": true,
      "Description": true,
      "ScreenDefinitionType": true
    }
  }
}

200

Successful operation.

{
  "InventoryType": [
    {
      "Description": "Money Order",
      "InventoryType": 0,
      "ScreenDefinitionType": 0
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchInventoryTypePagedSelectFields"
}

updateInventoryTypeByID

post

Update InventoryType parameter configuration. Parameter updates can change institution behavior and should be tested in a controlled environment before use.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

InventoryTypeInventoryTypeintegerOptional

Responses

200

Successful operation.

application/json

post/updateInventoryTypeByID

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "InventoryTypeInventoryType": 1,
  "InventoryTypeUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

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