GlCode

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getGlCode

post

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

GlCodePrimaryGlCodeintegerRequired

Responses

200

Successful operation.

application/json

post/getGlCode

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "GlCodePrimaryGlCode": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "GlCode": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getGlCode"
}

getGlCodeSelectFields

post

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

GlCodePrimaryGlCodeintegerOptional

Responses

200

Successful operation.

application/json

post/getGlCodeSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "GlCodePrimaryGlCode": 0,
  "SelectableFields": {
    "IncludeAllGlCodeFields": true
  }
}

200

Successful operation.

{
  "GlCode": {
    "BRXlate": 0,
    "Description": "GL Translation Exception",
    "PrimaryGlCode": 0,
    "XlateCount": 1,
    "XlateDetail": 0,
    "XlateGroup": 0,
    "XlateType": 0
  },
  "MessageId": "getGlCodeSelectFields"
}

getGlCodePagedList

post

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getGlCodePagedList

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getGlCodePagedList 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
      }
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0,
    "Token": "example-token"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "GlCode": [],
  "Token": null,
  "MessageId": "getGlCodePagedList"
}

getGlCodeListSelectFields

post

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post/getGlCodeListSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "SelectableFields": {
    "IncludeAllGlCodeFields": true
  }
}

200

Successful operation.

{
  "GlCodeList": [],
  "MessageId": "getGlCodeListSelectFields"
}

searchGlCodeSelectFields

post

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post/searchGlCodeSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "GlCodeList": [],
  "MessageId": "searchGlCodeSelectFields"
}

getGlCodePagedListSelectFields

post

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getGlCodePagedListSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "IncludeAllGlCodeFields": true
  }
}

200

Successful operation.

{
  "GlCode": [],
  "Token": null,
  "MessageId": "getGlCodePagedListSelectFields"
}

searchGlCodePagedSelectFields

post

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

QuerystringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/searchGlCodePagedSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "Query": "",
  "SelectableFields": {
    "IncludeAllGlCodeFields": true
  }
}

200

Successful operation.

{
  "GlCode": [],
  "Token": null,
  "MessageId": "searchGlCodePagedSelectFields"
}

updateGlCodeByID

post

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

GlCodePrimaryGlCodeintegerOptional

Responses

200

Successful operation.

application/json

post/updateGlCodeByID

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "GlCodePrimaryGlCode": 1,
  "GlCodeUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

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