Jump to

• Request
• Response

Get party application aggregate details

get

/party-services/web/v1/partyapplication/{applicationNumber}

Add additional information here for the this endpoint.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• applicationNumber: string
  Application number for which Party application data needs to be fetched

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns PartyApplication data for the application number

Body ()

Root Schema : PartyApplicationAggregateModel

Type: object

PartyApplicationAggregateModel

Show Source

• applicationNumber(optional): string
  Application Number
• drawdownParty(optional): object DrawdownPartyModel
  DrawdownParty model
• id(optional): string
  Party Application Id
• party(optional): object PartyModel
  Party model
• processCode(optional): string
  Process Code
• processRefNumber(optional): string
  Process Ref Number
• stageCode(optional): string
  Stage Code

{
    "description":"PartyApplicationAggregateModel",
    "type":"object",
    "properties":{
        "applicationNumber":{
            "description":"Application Number",
            "type":"string"
        },
        "processRefNumber":{
            "description":"Process Ref Number",
            "type":"string"
        },
        "id":{
            "description":"Party Application Id",
            "type":"string"
        },
        "stageCode":{
            "description":"Stage Code",
            "type":"string"
        },
        "processCode":{
            "description":"Process Code",
            "type":"string"
        },
        "party":{
            "$ref":"#/definitions/PartyModel"
        },
        "drawdownParty":{
            "$ref":"#/definitions/DrawdownPartyModel"
        }
    }
}

Nested Schema : DrawdownPartyModel

Type: object

DrawdownParty model

Show Source

• applicationNumber(optional): string
  applicationNumber
• createdBy(optional): string
  Maximum Length: 36

  createdBy
• dataSegmentCode(optional): string
  Data segment code
• id(optional): string
  Maximum Length: 36

  Id of the DrawdownParty
• partyDetails(optional): array partyDetails
• processRefNumber(optional): string
  Process ref Number
• remarks(optional): string
  remarks
• stageCode(optional): string
  Maximum Length: 36

  stageCode
• status(optional): string
  Maximum Length: 36

  status
• updatedBy(optional): string
  Updated By
• updatedTimeStamp(optional): string
  Updated Time Stamp
• validateSave(optional): string
  validateSave

{
    "description":"DrawdownParty model",
    "type":"object",
    "properties":{
        "id":{
            "description":"Id of the DrawdownParty",
            "type":"string",
            "maxLength":36
        },
        "processRefNumber":{
            "description":"Process ref Number",
            "type":"string"
        },
        "dataSegmentCode":{
            "description":"Data segment code",
            "type":"string"
        },
        "updatedBy":{
            "description":"Updated By",
            "type":"string"
        },
        "updatedTimeStamp":{
            "description":"Updated Time Stamp",
            "type":"string"
        },
        "stageCode":{
            "description":"stageCode",
            "type":"string",
            "maxLength":36
        },
        "createdBy":{
            "description":"createdBy",
            "type":"string",
            "maxLength":36
        },
        "status":{
            "description":"status",
            "type":"string",
            "maxLength":36
        },
        "applicationNumber":{
            "description":"applicationNumber",
            "type":"string"
        },
        "validateSave":{
            "description":"validateSave",
            "type":"string"
        },
        "remarks":{
            "description":"remarks",
            "type":"string"
        },
        "partyDetails":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DrawdownPartyDetailsModel"
            }
        }
    }
}

Nested Schema : PartyModel

Type: object

Party model

Show Source

• applicationNumber(optional): string
  applicationNumber
• createdBy(optional): string
  Maximum Length: 36

  createdBy
• dataSegmentCode(optional): string
  Data segment code
• id(optional): string
  Maximum Length: 36

  Id of the Party
• partyDetails(optional): array partyDetails
• processRefNumber(optional): string
  processRefNumber
• remarks(optional): string
  remarks
• stageCode(optional): string
  Maximum Length: 36

  stageCode
• status(optional): string
  Maximum Length: 36

  status
• updatedBy(optional): string
  Updated By
• updatedTimeStamp(optional): string
  Updated Time Stamp
• validateSave(optional): string
  validate Save flag

{
    "description":"Party model",
    "type":"object",
    "properties":{
        "id":{
            "description":"Id of the Party",
            "type":"string",
            "maxLength":36
        },
        "dataSegmentCode":{
            "description":"Data segment code",
            "type":"string"
        },
        "updatedBy":{
            "description":"Updated By",
            "type":"string"
        },
        "updatedTimeStamp":{
            "description":"Updated Time Stamp",
            "type":"string"
        },
        "stageCode":{
            "description":"stageCode",
            "type":"string",
            "maxLength":36
        },
        "createdBy":{
            "description":"createdBy",
            "type":"string",
            "maxLength":36
        },
        "status":{
            "description":"status",
            "type":"string",
            "maxLength":36
        },
        "applicationNumber":{
            "description":"applicationNumber",
            "type":"string"
        },
        "processRefNumber":{
            "description":"processRefNumber",
            "type":"string"
        },
        "remarks":{
            "description":"remarks",
            "type":"string"
        },
        "validateSave":{
            "description":"validate Save flag",
            "type":"string"
        },
        "partyDetails":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PartyDetailsModel"
            }
        }
    }
}

Nested Schema : partyDetails

Type: array

Show Source

• Array of: object DrawdownPartyDetailsModel
  DrawdownPartyDetails model

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

Nested Schema : DrawdownPartyDetailsModel

Type: object

DrawdownPartyDetails model

Show Source

• address(optional): object DrawdownAddressModel
  DrawdownAddress model
• countryOfIncorporation(optional): string
  countryOfIncorporation
• dateOfIncorporation(optional): string
  dateOfIncorporation
• demographicType(optional): string
  demographicType
• existingParty(optional): string
  existingParty
• externalCustomer(optional): string
  externalCustomer
• holdingPattern(optional): string
  holdingPattern
• id(optional): string
  Id of the DrawdownPartyDetails
• kycStatus(optional): string
  kycStatus
• languageCode(optional): string
  languageCode
• legalStatus(optional): string
  legalStatus
• maintenancePartyId(optional): string
  maintenancePartyId
• onboardingRefNumber(optional): string
  onboardingRefNumber
• onboardingStatus(optional): string
  onboardingStatus
• organizationType(optional): string
  organizationType
• partyContact(optional): array partyContact
• partyId(optional): string
  partyId
• partyName(optional): string
  partyName
• partyNumber(optional): string
  partyNumber
• partyRole(optional): array partyRole
• partyType(optional): string
  partyType
• placeOfIncorporation(optional): string
  placeOfIncorporation
• reportLocale(optional): string
  reportLocale
• updatePartyMaintenance(optional): string
  updatePartyMaintenance

{
    "description":"DrawdownPartyDetails model",
    "type":"object",
    "properties":{
        "id":{
            "description":"Id of the DrawdownPartyDetails",
            "type":"string"
        },
        "partyId":{
            "description":"partyId",
            "type":"string"
        },
        "partyNumber":{
            "description":"partyNumber",
            "type":"string"
        },
        "partyName":{
            "description":"partyName",
            "type":"string"
        },
        "maintenancePartyId":{
            "description":"maintenancePartyId",
            "type":"string"
        },
        "countryOfIncorporation":{
            "description":"countryOfIncorporation",
            "type":"string"
        },
        "dateOfIncorporation":{
            "description":"dateOfIncorporation",
            "type":"string"
        },
        "legalStatus":{
            "description":"legalStatus",
            "type":"string"
        },
        "kycStatus":{
            "description":"kycStatus",
            "type":"string"
        },
        "holdingPattern":{
            "description":"holdingPattern",
            "type":"string"
        },
        "partyType":{
            "description":"partyType",
            "type":"string"
        },
        "placeOfIncorporation":{
            "description":"placeOfIncorporation",
            "type":"string"
        },
        "demographicType":{
            "description":"demographicType",
            "type":"string"
        },
        "organizationType":{
            "description":"organizationType",
            "type":"string"
        },
        "onboardingRefNumber":{
            "description":"onboardingRefNumber",
            "type":"string"
        },
        "onboardingStatus":{
            "description":"onboardingStatus",
            "type":"string"
        },
        "existingParty":{
            "description":"existingParty",
            "type":"string"
        },
        "externalCustomer":{
            "description":"externalCustomer",
            "type":"string"
        },
        "updatePartyMaintenance":{
            "description":"updatePartyMaintenance",
            "type":"string"
        },
        "languageCode":{
            "description":"languageCode",
            "type":"string"
        },
        "reportLocale":{
            "description":"reportLocale",
            "type":"string"
        },
        "address":{
            "$ref":"#/definitions/DrawdownAddressModel"
        },
        "partyContact":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DrawdownPartyContactModel"
            }
        },
        "partyRole":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DrawdownPartyRoleModel"
            }
        }
    }
}

Nested Schema : DrawdownAddressModel

Type: object

DrawdownAddress model

Show Source

• addressType(optional): string
  addressType
• area(optional): string
  area
• building(optional): string
  building
• city(optional): string
  city
• country(optional): string
  country
• id(optional): string
  Id of the DrawdownAddress
• landmark(optional): string
  landmark
• locality(optional): string
  locality
• maintenanceAddressId(optional): string
  maintenanceAddressId
• parentId(optional): string
  parentId
• state(optional): string
  state
• street(optional): string
  street
• zipcode(optional): string
  zipcode

{
    "description":"DrawdownAddress model",
    "type":"object",
    "properties":{
        "id":{
            "description":"Id of the DrawdownAddress",
            "type":"string"
        },
        "parentId":{
            "description":"parentId",
            "type":"string"
        },
        "maintenanceAddressId":{
            "description":"maintenanceAddressId",
            "type":"string"
        },
        "addressType":{
            "description":"addressType",
            "type":"string"
        },
        "area":{
            "description":"area",
            "type":"string"
        },
        "building":{
            "description":"building",
            "type":"string"
        },
        "city":{
            "description":"city",
            "type":"string"
        },
        "country":{
            "description":"country",
            "type":"string"
        },
        "landmark":{
            "description":"landmark",
            "type":"string"
        },
        "locality":{
            "description":"locality",
            "type":"string"
        },
        "state":{
            "description":"state",
            "type":"string"
        },
        "street":{
            "description":"street",
            "type":"string"
        },
        "zipcode":{
            "description":"zipcode",
            "type":"string"
        }
    }
}

Nested Schema : partyContact

Type: array

Show Source

• Array of: object DrawdownPartyContactModel
  DrawdownPartyContact model

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

Nested Schema : partyRole

Type: array

Show Source

• Array of: object DrawdownPartyRoleModel
  DrawdownPartyRole model

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

Nested Schema : DrawdownPartyContactModel

Type: object

DrawdownPartyContact model

Show Source

• designation(optional): string
  designation
• firstName(optional): string
  firstName
• id(optional): string
  Id of the DrawdownPartyContact
• lastName(optional): string
  lastName
• MaintenanceContactId(optional): string
  MaintenanceContactId
• partyContactMedia(optional): array partyContactMedia
• partyContactRole(optional): array partyContactRole
• partyDetailsId(optional): string
  partyDetailsId
• salutation(optional): string
  salutation

{
    "description":"DrawdownPartyContact model",
    "type":"object",
    "properties":{
        "id":{
            "description":"Id of the DrawdownPartyContact",
            "type":"string"
        },
        "partyDetailsId":{
            "description":"partyDetailsId",
            "type":"string"
        },
        "MaintenanceContactId":{
            "description":"MaintenanceContactId",
            "type":"string"
        },
        "salutation":{
            "description":"salutation",
            "type":"string"
        },
        "firstName":{
            "description":"firstName",
            "type":"string"
        },
        "lastName":{
            "description":"lastName",
            "type":"string"
        },
        "designation":{
            "description":"designation",
            "type":"string"
        },
        "partyContactMedia":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DrawdownPartyContactMediaModel"
            }
        },
        "partyContactRole":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DrawdownPartyContactRoleModel"
            }
        }
    }
}

Nested Schema : partyContactMedia

Type: array

Show Source

• Array of: object DrawdownPartyContactMediaModel
  DrawdownPartyContactMedia model

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

Nested Schema : partyContactRole

Type: array

Show Source

• Array of: object DrawdownPartyContactRoleModel
  DrawdownPartyContactRole model

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

Nested Schema : DrawdownPartyContactMediaModel

Type: object

DrawdownPartyContactMedia model

Show Source

• address(optional): object DrawdownAddressModel
  DrawdownAddress model
• id(optional): string
  Id of the DrawdownPartyContactMedia
• maintenanceContactMediaId(optional): string
  maintenanceContactMediaId
• mediaAddress(optional): string
  mediaAddress
• mediaType(optional): string
  mediaType
• partyContactId(optional): string
  partyContactId
• preferredFlag(optional): string
  preferredFlag

{
    "description":"DrawdownPartyContactMedia model",
    "type":"object",
    "properties":{
        "id":{
            "description":"Id of the DrawdownPartyContactMedia",
            "type":"string"
        },
        "maintenanceContactMediaId":{
            "description":"maintenanceContactMediaId",
            "type":"string"
        },
        "mediaAddress":{
            "description":"mediaAddress",
            "type":"string"
        },
        "mediaType":{
            "description":"mediaType",
            "type":"string"
        },
        "partyContactId":{
            "description":"partyContactId",
            "type":"string"
        },
        "preferredFlag":{
            "description":"preferredFlag",
            "type":"string"
        },
        "address":{
            "$ref":"#/definitions/DrawdownAddressModel"
        }
    }
}

Nested Schema : DrawdownPartyContactRoleModel

Type: object

DrawdownPartyContactRole model

Show Source

• id(optional): string
  Id of the DrawdownPartyContactRole
• partyContactId(optional): string
  partyContactId
• partyDetailsId(optional): string
  partyDetailsId
• role(optional): string
  role

{
    "description":"DrawdownPartyContactRole model",
    "type":"object",
    "properties":{
        "id":{
            "description":"Id of the DrawdownPartyContactRole",
            "type":"string"
        },
        "partyDetailsId":{
            "description":"partyDetailsId",
            "type":"string"
        },
        "role":{
            "description":"role",
            "type":"string"
        },
        "partyContactId":{
            "description":"partyContactId",
            "type":"string"
        }
    }
}

Nested Schema : DrawdownPartyRoleModel

Type: object

DrawdownPartyRole model

Show Source

• id(optional): string
  Id of the DrawdownPartyRole
• partyDetailsId(optional): string
  partyDetailsId
• role(optional): string
  role

{
    "description":"DrawdownPartyRole model",
    "type":"object",
    "properties":{
        "id":{
            "description":"Id of the DrawdownPartyRole",
            "type":"string"
        },
        "partyDetailsId":{
            "description":"partyDetailsId",
            "type":"string"
        },
        "role":{
            "description":"role",
            "type":"string"
        }
    }
}

Nested Schema : partyDetails

Type: array

Show Source

• Array of: object PartyDetailsModel
  PartyDetails model

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

Nested Schema : PartyDetailsModel

Type: object

PartyDetails model

Show Source

• address(optional): object AddressModel
  Address model
• countryOfIncorporation(optional): string
  Country Of Incorporation
• dateOfIncorporation(optional): string
  Date Of Incorporation
• demographicType(optional): string
  Demographic Type
• existingParty(optional): string
  Maximum Length: 1

  Existing Party
• externalCustomer(optional): string
  externalCustomer
• holdingPattern(optional): string
  Holding Pattern
• id(optional): string
  Id of the PartyDetails
• keyId(optional): string
  Maintenance Id of the PartyDetails
• kycStatus(optional): string
  KYC Status
• languageCode(optional): string
  Language Code
• maintenancePartyId(optional): string
  maintenancePartyId
• modNo(optional): number
  Mod Number
• onboardingRefNumber(optional): string
  Onboarding Ref Number
• onboardingStatus(optional): string
  onboardingStatus
• organizationType(optional): string
  Organization Type
• partyContact(optional): array partyContact
• partyId(optional): string
  partyId
• partyName(optional): string
  partyName
• partyNumber(optional): string
  partyNumber
• partyRole(optional): array partyRole
• partyType(optional): string
  Party Type
• placeOfIncorporation(optional): string
  Place Of Incorporation
• reportLocale(optional): string
  Report Locale
• updatePartyMaintenance(optional): string
  Maximum Length: 1

  Update Party Maintenance

{
    "description":"PartyDetails model",
    "type":"object",
    "properties":{
        "id":{
            "description":"Id of the PartyDetails",
            "type":"string"
        },
        "keyId":{
            "description":"Maintenance Id of the PartyDetails",
            "type":"string"
        },
        "modNo":{
            "description":"Mod Number",
            "type":"number"
        },
        "partyNumber":{
            "description":"partyNumber",
            "type":"string"
        },
        "partyName":{
            "description":"partyName",
            "type":"string"
        },
        "partyId":{
            "description":"partyId",
            "type":"string"
        },
        "maintenancePartyId":{
            "description":"maintenancePartyId",
            "type":"string"
        },
        "countryOfIncorporation":{
            "type":"string",
            "description":"Country Of Incorporation"
        },
        "dateOfIncorporation":{
            "type":"string",
            "description":"Date Of Incorporation"
        },
        "demographicType":{
            "type":"string",
            "description":"Demographic Type"
        },
        "organizationType":{
            "type":"string",
            "description":"Organization Type"
        },
        "kycStatus":{
            "type":"string",
            "description":"KYC Status"
        },
        "holdingPattern":{
            "type":"string",
            "description":"Holding Pattern"
        },
        "partyType":{
            "type":"string",
            "description":"Party Type"
        },
        "placeOfIncorporation":{
            "type":"string",
            "description":"Place Of Incorporation"
        },
        "onboardingRefNumber":{
            "description":"Onboarding Ref Number",
            "type":"string"
        },
        "onboardingStatus":{
            "description":"onboardingStatus",
            "type":"string"
        },
        "externalCustomer":{
            "description":"externalCustomer",
            "type":"string"
        },
        "existingParty":{
            "description":"Existing Party",
            "type":"string",
            "maxLength":1
        },
        "updatePartyMaintenance":{
            "description":"Update Party Maintenance",
            "type":"string",
            "maxLength":1
        },
        "languageCode":{
            "type":"string",
            "description":"Language Code"
        },
        "reportLocale":{
            "type":"string",
            "description":"Report Locale"
        },
        "address":{
            "$ref":"#/definitions/AddressModel"
        },
        "partyContact":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PartyContactModel"
            }
        },
        "partyRole":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PartyRoleModel"
            }
        }
    }
}

Nested Schema : AddressModel

Type: object

Address model

Show Source

• addressType(optional): string
  addressType
• area(optional): string
  area
• building(optional): string
  building
• city(optional): string
  city
• country(optional): string
  country
• id(optional): string
  Id of the PartyContactRole
• landmark(optional): string
  landmark
• locality(optional): string
  locality
• maintenanceAddressId(optional): string
  maintenanceAddressId
• parentId(optional): string
  parent Id
• state(optional): string
  state
• street(optional): string
  street
• zipcode(optional): string
  zipcode

{
    "description":"Address model",
    "type":"object",
    "properties":{
        "id":{
            "description":"Id of the PartyContactRole",
            "type":"string"
        },
        "parentId":{
            "description":"parent Id",
            "type":"string"
        },
        "maintenanceAddressId":{
            "description":"maintenanceAddressId",
            "type":"string"
        },
        "addressType":{
            "description":"addressType",
            "type":"string"
        },
        "area":{
            "description":"area",
            "type":"string"
        },
        "building":{
            "description":"building",
            "type":"string"
        },
        "city":{
            "description":"city",
            "type":"string"
        },
        "country":{
            "description":"country",
            "type":"string"
        },
        "landmark":{
            "description":"landmark",
            "type":"string"
        },
        "locality":{
            "description":"locality",
            "type":"string"
        },
        "state":{
            "description":"state",
            "type":"string"
        },
        "street":{
            "description":"street",
            "type":"string"
        },
        "zipcode":{
            "description":"zipcode",
            "type":"string"
        }
    }
}

Nested Schema : partyContact

Type: array

Show Source

• Array of: object PartyContactModel
  PartyContact model

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

Nested Schema : partyRole

Type: array

Show Source

• Array of: object PartyRoleModel
  PartyRole model

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

Nested Schema : PartyContactModel

Type: object

PartyContact model

Show Source

• designation(optional): string
  designation
• firstName(optional): string
  First Name
• id(optional): string
  Id of the PartyContact
• lastName(optional): string
  Last Name
• maintenanceContactId(optional): string
  maintenanceContactId
• partyContactMedia(optional): array partyContactMedia
• partyContactRole(optional): array partyContactRole
• partyDetailsId(optional): string
  partyDetailsId
• partyId(optional): string
  Party Id
• salutation(optional): string
  Salutation

{
    "description":"PartyContact model",
    "type":"object",
    "properties":{
        "id":{
            "description":"Id of the PartyContact",
            "type":"string"
        },
        "partyDetailsId":{
            "description":"partyDetailsId",
            "type":"string"
        },
        "maintenanceContactId":{
            "description":"maintenanceContactId",
            "type":"string"
        },
        "salutation":{
            "type":"string",
            "description":"Salutation"
        },
        "firstName":{
            "type":"string",
            "description":"First Name"
        },
        "lastName":{
            "type":"string",
            "description":"Last Name"
        },
        "designation":{
            "description":"designation",
            "type":"string"
        },
        "partyId":{
            "type":"string",
            "description":"Party Id"
        },
        "partyContactMedia":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PartyContactMediaModel"
            }
        },
        "partyContactRole":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PartyContactRoleModel"
            }
        }
    }
}

Nested Schema : partyContactMedia

Type: array

Show Source

• Array of: object PartyContactMediaModel
  PartyContactMedia model

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

Nested Schema : partyContactRole

Type: array

Show Source

• Array of: object PartyContactRoleModel
  PartyContactRole model

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

Nested Schema : PartyContactMediaModel

Type: object

PartyContactMedia model

Show Source

• address(optional): object AddressModel
  Address model
• id(optional): string
  Id of the PartyContactMedia
• maintenanceContactMediaId(optional): string
  maintenanceContactMediaId
• mediaAddress(optional): string
  mediaAddress
• mediaType(optional): string
  mediaType
• partyContactId(optional): string
  partyContactId
• preferredFlag(optional): string
  preferredFlag

{
    "description":"PartyContactMedia model",
    "type":"object",
    "properties":{
        "id":{
            "description":"Id of the PartyContactMedia",
            "type":"string"
        },
        "maintenanceContactMediaId":{
            "description":"maintenanceContactMediaId",
            "type":"string"
        },
        "mediaAddress":{
            "description":"mediaAddress",
            "type":"string"
        },
        "mediaType":{
            "description":"mediaType",
            "type":"string"
        },
        "partyContactId":{
            "description":"partyContactId",
            "type":"string"
        },
        "preferredFlag":{
            "description":"preferredFlag",
            "type":"string"
        },
        "address":{
            "$ref":"#/definitions/AddressModel"
        }
    }
}

Nested Schema : PartyContactRoleModel

Type: object

PartyContactRole model

Show Source

• id(optional): string
  Id of the PartyContactRole
• partyContactId(optional): string
  partyContactId
• partyDetailsId(optional): string
  partyDetailsId
• role(optional): string
  role

{
    "description":"PartyContactRole model",
    "type":"object",
    "properties":{
        "id":{
            "description":"Id of the PartyContactRole",
            "type":"string"
        },
        "partyDetailsId":{
            "description":"partyDetailsId",
            "type":"string"
        },
        "role":{
            "description":"role",
            "type":"string"
        },
        "partyContactId":{
            "description":"partyContactId",
            "type":"string"
        }
    }
}

Nested Schema : PartyRoleModel

Type: object

PartyRole model

Show Source

• id(optional): string
  Id of the PartyRole
• partyDetailsId(optional): string
  partyDetailsId
• role(optional): string
  role

{
    "description":"PartyRole model",
    "type":"object",
    "properties":{
        "id":{
            "description":"Id of the PartyRole",
            "type":"string"
        },
        "partyDetailsId":{
            "description":"partyDetailsId",
            "type":"string"
        },
        "role":{
            "description":"role",
            "type":"string"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input

500 Response

Internal error

Back to Top