AcctMembGrpDesc

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getAcctMembGrpDesc

post

Retrieve the account member group description

Authorizations
Body
AcctMembGrpDescMemberGroupintegerRequired
Responses
200

Successful operation.

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

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

Successful operation.

{
  "AcctMembGrpDesc": {
    "Description": "text",
    "MemberGroup": 1
  }
}

getAcctMembGrpDescSelectFields

post
Authorizations
Body
AcctMembGrpDescMemberGroupintegerOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AcctMembGrpDescMemberGroup": 1,
  "SelectableFields": {
    "IncludeAllAcctMembGrpDescFields": true,
    "AcctMembGrpDescFields": {
      "Description": true,
      "MemberGroup": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "AcctMembGrpDesc": {
    "Description": "text",
    "MemberGroup": 1
  }
}

getAcctMembGrpDescPagedList

post

Retrieve a paged list of account member group descriptions

Authorizations
Body
Responses
200

Successful operation.

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

{
  "AcctMembGrpDesc": [
    {
      "Description": "text",
      "MemberGroup": 1
    }
  ],
  "Token": "text"
}

getAcctMembGrpDescListSelectFields

post

Retrieve the list of account member group descriptions with selectable fields

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllAcctMembGrpDescFields": true,
    "AcctMembGrpDescFields": {
      "Description": true,
      "MemberGroup": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "AcctMembGrpDescList": {
    "hasReachedMaximumListSize": true,
    "AcctMembGrpDesc": [
      {
        "Description": "text",
        "MemberGroup": 1
      }
    ]
  }
}

searchAcctMembGrpDescSelectFields

post

Search account member group description select fields

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/searchAcctMembGrpDescSelectFields
POST /nexum/627/2022.01/parameter/searchAcctMembGrpDescSelectFields 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&"
    }
  },
  "SelectableFields": {
    "IncludeAllAcctMembGrpDescFields": true,
    "AcctMembGrpDescFields": {
      "Description": true,
      "MemberGroup": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "AcctMembGrpDescList": {
    "hasReachedMaximumListSize": true,
    "AcctMembGrpDesc": [
      {
        "Description": "text",
        "MemberGroup": 1
      }
    ]
  }
}

getAcctMembGrpDescPagedListSelectFields

post

Retrieve a paged list of account member group descriptions with selected fields

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllAcctMembGrpDescFields": true,
    "AcctMembGrpDescFields": {
      "Description": true,
      "MemberGroup": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "AcctMembGrpDesc": [
    {
      "Description": "text",
      "MemberGroup": 1
    }
  ],
  "Token": "text"
}

searchAcctMembGrpDescPagedSelectFields

post

Search account member group description paged select fields

Authorizations
Body
QuerystringOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllAcctMembGrpDescFields": true,
    "AcctMembGrpDescFields": {
      "Description": true,
      "MemberGroup": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "AcctMembGrpDesc": [
    {
      "Description": "text",
      "MemberGroup": 1
    }
  ],
  "Token": "text"
}

updateAcctMembGrpDescByID

post

Update Account Member Group Description by ID

Authorizations
Body
AcctMembGrpDescMemberGroupintegerOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AcctMembGrpDescMemberGroup": 1,
  "AcctMembGrpDescUpdatableFields": {
    "Description": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

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

Last updated

Was this helpful?