CorpTransfer

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getCorpTransfer

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

CorpTransferRuleSetintegerRequired

Responses

200

Successful operation.

application/json

post/getCorpTransfer

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CorpTransferRuleSet": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "CorpTransfer": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getCorpTransfer"
}

getCorpTransferSelectFields

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

CorpTransferRuleSetintegerOptional

Responses

200

Successful operation.

application/json

post/getCorpTransferSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "SelectableFields": {
    "IncludeAllCorpTransferFields": true
  }
}

200

Successful operation.

{
  "CorpTransfer": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getCorpTransferSelectFields"
}

getCorpTransferPagedList

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getCorpTransferPagedList

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

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

200

Successful operation.

{
  "CorpTransfer": [],
  "Token": null,
  "MessageId": "getCorpTransferPagedList"
}

getCorpTransferListSelectFields

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

post/getCorpTransferListSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "SelectableFields": {
    "IncludeAllCorpTransferFields": true
  }
}

200

Successful operation.

{
  "CorpTransferList": [],
  "MessageId": "getCorpTransferListSelectFields"
}

searchCorpTransferSelectFields

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

post/searchCorpTransferSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllCorpTransferFields": true
  },
  "SearchFilter": {
    "Query": "example-query"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "CorpTransferList": [],
  "MessageId": "searchCorpTransferSelectFields"
}

getCorpTransferPagedListSelectFields

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getCorpTransferPagedListSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "IncludeAllCorpTransferFields": true
  }
}

200

Successful operation.

{
  "CorpTransfer": [],
  "Token": null,
  "MessageId": "getCorpTransferPagedListSelectFields"
}

searchCorpTransferPagedSelectFields

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

QuerystringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/searchCorpTransferPagedSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "Query": "",
  "SelectableFields": {
    "IncludeAllCorpTransferFields": true
  }
}

200

Successful operation.

{
  "CorpTransfer": [],
  "Token": null,
  "MessageId": "searchCorpTransferPagedSelectFields"
}