ParticipantFieldName

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getParticipantFieldName

post

Participant field name

Authorizations
Body
ParticipantFieldNameFieldintegerRequired
Responses
200

Successful operation.

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

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

Successful operation.

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

getParticipantFieldNameSelectFields

post

Participant field name select fields

Authorizations
Body
ParticipantFieldNameFieldintegerOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ParticipantFieldNameField": 1,
  "SelectableFields": {
    "IncludeAllParticipantFieldNameFields": true,
    "ParticipantFieldNameFields": {
      "Field": true,
      "FieldName": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

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

getParticipantFieldNamePagedList

post

Participant field name paged list

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/getParticipantFieldNamePagedList
POST /nexum/627/2022.01/parameter/getParticipantFieldNamePagedList 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.

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

getParticipantFieldNameListSelectFields

post

Participant field name list select fields

Authorizations
Body
Responses
200

Successful operation.

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

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

Successful operation.

{
  "ParticipantFieldNameList": {
    "hasReachedMaximumListSize": true,
    "ParticipantFieldName": [
      {
        "Field": 1,
        "FieldName": "text"
      }
    ]
  }
}

searchParticipantFieldNameSelectFields

post

Retrieve a list of select fields for participant field names

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/searchParticipantFieldNameSelectFields
POST /nexum/627/2022.01/parameter/searchParticipantFieldNameSelectFields 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&"
    }
  },
  "SelectableFields": {
    "IncludeAllParticipantFieldNameFields": true,
    "ParticipantFieldNameFields": {
      "Field": true,
      "FieldName": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "ParticipantFieldNameList": {
    "hasReachedMaximumListSize": true,
    "ParticipantFieldName": [
      {
        "Field": 1,
        "FieldName": "text"
      }
    ]
  }
}

getParticipantFieldNamePagedListSelectFields

post

Participant field name paged list select fields

Authorizations
Body
Responses
200

Successful operation.

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

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

Successful operation.

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

searchParticipantFieldNamePagedSelectFields

post

Retrieve a paged list of select fields for participant field names

Authorizations
Body
QuerystringOptional
Responses
200

Successful operation.

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

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

Successful operation.

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

updateParticipantFieldNameByID

post

Update participant field names by ID

Authorizations
Body
ParticipantFieldNameFieldintegerOptional
Responses
200

Successful operation.

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

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

Successful operation.

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

Last updated

Was this helpful?