AcsService

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getAcsService

post

Retrieve AcsService 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

AcsServiceAcsServiceTypeintegerRequired

Responses

200

Successful operation.

application/json

post/getAcsService

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getAcsService 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}"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  },
  "AcsServiceAcsServiceType": 1
}

200

Successful operation.

{
  "AcsService": {
    "AcquireItems": "NONE",
    "AcquireOption": 0,
    "AcsServiceType": 1,
    "Action": [
      {
        "EntryId": 1,
        "Action": "NONE"
      }
    ],
    "Description": null,
    "NewLoanType": 0,
    "Points": 0
  },
  "MessageId": "getAcsService"
}

getAcsServiceSelectFields

post

Retrieve AcsService 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

AcsServiceAcsServiceTypeintegerOptional

Responses

200

Successful operation.

application/json

post/getAcsServiceSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "AcsService": {
    "AcquireItems": "NONE",
    "AcquireOption": 0,
    "AcsServiceType": 0,
    "Action": [
      {
        "EntryId": 1,
        "Action": "NONE"
      }
    ],
    "ConsolidateMax": "0.00",
    "ExcludeMatch": false,
    "FactsLetterfile": "NONE",
    "NewLoanType": 0,
    "Points": 0
  },
  "MessageId": "getAcsServiceSelectFields"
}

getAcsServicePagedList

post

Retrieve AcsService 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/getAcsServicePagedList

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "AcsService": [],
  "Token": null,
  "MessageId": "getAcsServicePagedList"
}

getAcsServiceListSelectFields

post

Retrieve AcsService 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/getAcsServiceListSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "AcsServiceList": [],
  "MessageId": "getAcsServiceListSelectFields"
}

searchAcsServiceSelectFields

post

Search AcsService 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/searchAcsServiceSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "AcsServiceList": [],
  "MessageId": "searchAcsServiceSelectFields"
}

getAcsServicePagedListSelectFields

post

Retrieve AcsService 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/getAcsServicePagedListSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "AcsService": [
    {
      "AcquireItems": "NONE",
      "AcquireOption": 0,
      "AcsServiceType": 0,
      "Action": [
        {
          "EntryId": 1,
          "Action": "NONE"
        }
      ],
      "ConsolidateMax": "0.00",
      "ExcludeMatch": false,
      "FactsLetterfile": "NONE",
      "NewLoanType": 0,
      "Points": 0
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getAcsServicePagedListSelectFields"
}

searchAcsServicePagedSelectFields

post

Search AcsService 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/searchAcsServicePagedSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "AcsService": [
    {
      "AcquireItems": "NONE",
      "AcquireOption": 0,
      "AcsServiceType": 0,
      "Action": [
        {
          "EntryId": 1,
          "Action": "NONE"
        }
      ],
      "ConsolidateMax": "0.00",
      "ExcludeMatch": false,
      "FactsLetterfile": "NONE",
      "NewLoanType": 0,
      "Points": 0
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchAcsServicePagedSelectFields"
}

updateAcsServiceByID

post

Update AcsService 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

AcsServiceAcsServiceTypeintegerOptional

Responses

200

Successful operation.

application/json

post/updateAcsServiceByID

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

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