CardWiz

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getCardWiz

post

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

CardWizCardTypeintegerRequired

Responses

200

Successful operation.

application/json

post/getCardWiz

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "CardWizCardType": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "CardWiz": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getCardWiz"
}

getCardWizSelectFields

post

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

CardWizCardTypeintegerOptional

Responses

200

Successful operation.

application/json

post/getCardWizSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "CardWiz": {
    "AllowCardActivation": false,
    "AllowCardCreation": false,
    "CardStatusReasonCodes": "NONE",
    "CardSuffixHigh": 99,
    "CardSuffixLow": 1,
    "CardType": 0,
    "Defined": false,
    "UniqueCardNumber": true
  },
  "MessageId": "getCardWizSelectFields"
}

getCardWizPagedList

post

Retrieve CardWiz 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/getCardWizPagedList

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "CardWiz": [],
  "Token": null,
  "MessageId": "getCardWizPagedList"
}

getCardWizListSelectFields

post

Retrieve CardWiz 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/getCardWizListSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "CardWizList": [],
  "MessageId": "getCardWizListSelectFields"
}

searchCardWizSelectFields

post

Search CardWiz 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/searchCardWizSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/searchCardWizSelectFields 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": null
      }
    }
  },
  "SelectableFields": {
    "IncludeAllCardWizFields": true
  },
  "SearchFilter": {
    "Query": "example-query"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "CardWizList": [],
  "MessageId": "searchCardWizSelectFields"
}

getCardWizPagedListSelectFields

post

Retrieve CardWiz 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/getCardWizPagedListSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "CardWiz": [
    {
      "AllowCardActivation": false,
      "AllowCardCreation": false,
      "CardStatusReasonCodes": "NONE",
      "CardSuffixHigh": 99,
      "CardSuffixLow": 1,
      "CardType": 0,
      "Defined": false,
      "UniqueCardNumber": true
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getCardWizPagedListSelectFields"
}

searchCardWizPagedSelectFields

post

Search CardWiz 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/searchCardWizPagedSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "CardWiz": [
    {
      "AllowCardActivation": false,
      "AllowCardCreation": false,
      "CardStatusReasonCodes": "NONE",
      "CardSuffixHigh": 99,
      "CardSuffixLow": 1,
      "CardType": 0,
      "Defined": false,
      "UniqueCardNumber": true
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchCardWizPagedSelectFields"
}

updateCardWizByID

post

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

CardWizCardTypeintegerOptional

Responses

200

Successful operation.

application/json

post/updateCardWizByID

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

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