Jump to

• Request
• Response

Retrieves SCF Master Party Parameters

get

/service/v1/parties

This endpoint is used to get the scf master party parameters.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

• appId: string
  App ID
• branchCode: string
  Branch Code
• userId: string
  User ID

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Successful performs the operation

Body ()

Root Schema : ScfMasterPartyModelCollection

Type: object

Collection of list of Parties.

Show Source

• ScfMasterPartyModel(optional): array ScfMasterPartyModel

{
    "description":"Collection of list of Parties.",
    "type":"object",
    "properties":{
        "ScfMasterPartyModel":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ScfMasterPartyModel"
            }
        }
    }
}

Nested Schema : ScfMasterPartyModel

Type: array

Show Source

• Array of: object ScfMasterPartyModel
  Scf Master Party model

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ScfMasterPartyModel"
    }
}

Nested Schema : ScfMasterPartyModel

Type: object

Scf Master Party model

Show Source

• id(optional): integer(int64)
  Id of the Party
• partyCategory(optional): string
  Will differentiate weather it is customer/bank (C/B)
• partyCode(optional): string
  Code for the Party.This is a unique constraint
• partyDescription(optional): string
  Configured value for the disbursement mode which will be used in rest of application.

{
    "description":"Scf Master Party model",
    "type":"object",
    "properties":{
        "id":{
            "description":"Id of the Party",
            "type":"integer",
            "format":"int64"
        },
        "partyCode":{
            "description":"Code for the Party.This is a unique constraint",
            "type":"string"
        },
        "partyDescription":{
            "description":"Configured value for the disbursement mode which will be used in rest of application.",
            "type":"string"
        },
        "partyCategory":{
            "description":"Will differentiate weather it is customer/bank (C/B)",
            "type":"string"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error

Back to Top