Schemas Postman

SEPA participants. Fetch data by request POST

Get SEPA participants data by request

# ENDPOINT
/api/sepaParticipants/getData/sepaParticipantsSearchRequest
# REQUEST arguments
Variable Value Example Usage Description
X-App-Sig
header
0 		M Dev Authentication
# REQUEST BODY
# RESPONSE
# REQUEST arguments
Variable Name Type Format Usage Description
X-App-Sig X-App-Sig header string M Dev Authentication
# REQUEST BODY
Schema: sepaParticipantsSearchRequest
Type: object
Variable Name Type Format Usage Description
bic bic string Bank Identification Code / Swift Code as for the International payment standard
limit limit integer int64 Count records for part data to get
offset_version Offset version INTEGER
offsetid Offsetid integer
page page integer int64 Part data with number of page
page_changes_version_offset Page changes version offset INTEGER
participant_name participant_name string
skip_total_records Skip total records boolean
List of allowed values in field (value=>name):
  • 0
    false
  • 1
    true
# REQUEST BODY EXAMPLE
# POSITIVE RESPONSE

200 - Response successfully when status is OK

<p style="color:green;font-size:16px;">200 - Response successfully when status is OK</p>

Schema: sepaParticipants
Type: application/json
Variable Name Type Format Description
status status string Request execution status
error_description Error Description string Description of error
error Error Code string Error code
data_type data_type string Type of data
total_records total_records string Total count of records
data data array data of Response
attribute: data
Variable Name Type Format Description
action Action string
address address string
bic bic string Bank Identification Code / Swift Code as for the International payment standard
city city string Residence/ correspondence address city/town
country country string
create_date Create Date string DATETIME The date entry was created on
create_user Create User string The username of ABS user who has created an entry
form_title form_title string Service field
id id integer INT64 Record's sequence number generated in the system.
leaving_date leaving_date string
modify_date Modify Date string DATETIME The date entry was last modified on
modify_user Modify User string The username of ABS user who has made last changes to the entry
participant_name participant_name string
participation_type participation_type string
readiness_date readiness_date string
state state integer INT64 Record state for replication
uid uid string Unique record identifier which is used to distinguish between existing records
version version integer INT64 Record version for replication
# NEGATIVE RESPONSE

200 - Response with error when status is ERROR

<p style="color:red;font-size:16px;">200 - Response with error when status is ERROR</p>

Schema: HeaderResponseStatusError
Type: application/json
Variable Name Type Format Description
status status string Request execution status
error_description Error Description string Description of error
error Error Code string Error code
data_type data_type string Type of data
total_records total_records string Total count of records
data data object Empty object
# Other endpoints
Name Endpoint
SEPA Participants. Fetch data by ID /model/sepaParticipants/getDb/{id}
SEPA Participants. Validate data /model/sepaParticipants/validate
SEPA Participants. Prepare data /model/sepaParticipants/prepare
SEPA Participants. Create/update data /model/sepaParticipants/putDb
SEPA Participants. Delete item by ID /api/sepaParticipants/deleteItem/{id}