Extended Organisation Profile

GetExtendedOrganisationProfiles

GET {{domain}}/api/v1/profile/extended/organisation

Gets the list of extended organisation profiles

Path Parameters

Name	Type	Description
clientId	string	Client Id of the application

Query Parameters

Name	Type	Description
pageSize	integer	Page size for pagination. Default value is set to 10
pageNumber	integer	Page number for pagination. Default value is set to 1

200

{
  "message": "200",
  "data": [
    {
      "OrganisationId": 1,
      "Address": "Yaba",
      "RCNumber": "A154FC",
    },
    {
      "OrganisationId": 3,
      "Address": "Ikeja",
      "RCNumber": "AA11bb",
    }
  ]
}

GetExtendedOrganisationProfileById

GET {{domain}}/api/v1/profile/extended/organisation

Gets the list of extended organisation profiles

Path Parameters

Name	Type	Description
orgId	string	Organisation Id
clientId	string	Client Id of the application

200

{
  "message": "200",
  "data": {
    "OrganisationId": 1,
    "Address": "Yaba",
    "RCNumber": "A154FC",
    "StaffNo": 12
  }
}

CreateExtendedOrganisationProfile

POST {{domain}}/api/v1/profile/extended/organisation

Creates an extended organisation profile

Request Body

Name	Type	Description
	object	{ "payload": { "{{attributeName}}": "{{attributeValue}}" }, "clientId": "string", "entityName": "string", "organisationId": "string", }

200

{
  "message": "Ok",
  "isError": false
}

UpdateExtendedOrganisationProfile

PUT {{domain}}/api/v1/profile/extended/organisation

Creates an extended organisation profile

Request Body

Name	Type	Description
	object	{ "payload": { "{{attributeName}}": "{{attributeValue}}" }, "clientId": "string", "entityName": "string", "organisationId": "string", }

200

{
  "message": "Ok",
  "isError": false
}