PlanFieldName

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getPlanFieldName

post

Plan field name

Authorizations
Body
PlanFieldNameFieldintegerRequired
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PlanFieldNameField": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "PlanFieldName": {
    "Field": 1,
    "FieldName": "text"
  }
}

getPlanFieldNameSelectFields

post

Returns the plan field names with select fields

Authorizations
Body
PlanFieldNameFieldintegerOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PlanFieldNameField": 1,
  "SelectableFields": {
    "IncludeAllPlanFieldNameFields": true,
    "PlanFieldNameFields": {
      "Field": true,
      "FieldName": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "PlanFieldName": {
    "Field": 1,
    "FieldName": "text"
  }
}

getPlanFieldNamePagedList

post

Returns paged list of plan field names

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "PlanFieldName": [
    {
      "Field": 1,
      "FieldName": "text"
    }
  ],
  "Token": "text"
}

getPlanFieldNameListSelectFields

post

Returns the list of plan field names with select fields

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllPlanFieldNameFields": true,
    "PlanFieldNameFields": {
      "Field": true,
      "FieldName": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "PlanFieldNameList": {
    "hasReachedMaximumListSize": true,
    "PlanFieldName": [
      {
        "Field": 1,
        "FieldName": "text"
      }
    ]
  }
}

searchPlanFieldNameSelectFields

post

Retrieve a list of select fields for plan field names

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllPlanFieldNameFields": true,
    "PlanFieldNameFields": {
      "Field": true,
      "FieldName": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "PlanFieldNameList": {
    "hasReachedMaximumListSize": true,
    "PlanFieldName": [
      {
        "Field": 1,
        "FieldName": "text"
      }
    ]
  }
}

getPlanFieldNamePagedListSelectFields

post

Returns paged list of plan field names with select fields

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/getPlanFieldNamePagedListSelectFields
POST /nexum/627/2022.01/parameter/getPlanFieldNamePagedListSelectFields 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&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllPlanFieldNameFields": true,
    "PlanFieldNameFields": {
      "Field": true,
      "FieldName": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "PlanFieldName": [
    {
      "Field": 1,
      "FieldName": "text"
    }
  ],
  "Token": "text"
}

searchPlanFieldNamePagedSelectFields

post

Retrieve a paged list of select fields for plan field names

Authorizations
Body
QuerystringOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllPlanFieldNameFields": true,
    "PlanFieldNameFields": {
      "Field": true,
      "FieldName": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "PlanFieldName": [
    {
      "Field": 1,
      "FieldName": "text"
    }
  ],
  "Token": "text"
}

updatePlanFieldNameByID

post

Update plan field names by ID

Authorizations
Body
PlanFieldNameFieldintegerOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PlanFieldNameField": 1,
  "PlanFieldNameUpdatableFields": {
    "FieldName": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": [
      {
        "Record": "text",
        "ErrorCode": "text",
        "ErrorMessage": "text",
        "PrimaryKeyField": [
          {
            "Name": "text",
            "Value": "text"
          }
        ]
      }
    ]
  }
}
PreviousPlanDefaultNextPmtAppMethod

Last updated

Was this helpful?