Purpose Group APIs

Delete Purpose Group Old (DELETE)

Deletes an existing purpose group.

Route

URI	/api/v1/purposeGroup
Method	DELETE
Result	JSON – ChangeResult

Parameters

Name	Type	Mandatory	Description
identifier	string	No

Response Structure Returns ChangeResult object containing:

• Success: bool value

• Data: object value

• ResponseId: Guid? value

• ErrorDetails: ExternalInterfaceException value

Example

DELETE http://localhost/api/v1/purposeGroup

Example Response

{     "Success": true,     "Data": {},     "ResponseId": "123e4567-e89b-12d3-a456-426614174000",     "ErrorDetails": {} }

Create Purpose Group Old (POST)

Creates a new purpose group.

Route

URI	/api/v1/purposeGroup
Method	POST
Result	JSON – ChangeResult

Request Payload

PurposeGroupModel object:

Property	Type	Mandatory	Description
Identifier	string	No
Icon	string	No
AliasName	string	No
Description	string	No

Response Structure Returns ChangeResult object containing:

• Success: bool value

• Data: object value

• ResponseId: Guid? value

• ErrorDetails: ExternalInterfaceException value

Example

POST http://localhost/api/v1/purposeGroup Content-Type: application/json  

{     
"Identifier": "sample",     
"Icon": "sample",     
"AliasName": "sample",     
"Description": "sample" 
}

Example Response

{     "Success": true,     "Data": {},     "ResponseId": "123e4567-e89b-12d3-a456-426614174000",     "ErrorDetails": {} }

Create Purpose Group (POST)

Creates a new purpose group.

Route

URI	/api/v1/purposeGroups
Method	POST
Result	JSON – ChangeResult

Request Payload

PurposeGroupModel object:

Property	Type	Mandatory	Description
Identifier	string	No
Icon	string	No
AliasName	string	No
Description	string	No

Response Structure Returns ChangeResult object containing:

• Success: bool value

• Data: object value

• ResponseId: Guid? value

• ErrorDetails: ExternalInterfaceException value

Example

POST http://localhost/api/v1/purposeGroups Content-Type: application/json  

{     
"Identifier": "sample",     
"Icon": "sample",     
"AliasName": "sample",     
"Description": "sample" 
}

Example Response

{     "Success": true,     "Data": {},     "ResponseId": "123e4567-e89b-12d3-a456-426614174000",     "ErrorDetails": {} }

Get All Purpose Groups (GET)

Returns all defined purpose groups as <seealso cref="PurposeGroupModel"/>.

Route

URI	/api/v1/purposeGroups
Method	GET
Result	JSON – PurposeGroupModel[]

Parameters

None

Response Structure Returns PurposeGroupModel[] object containing:

• Identifier: string value

• Icon: string value

• AliasName: string value

• Description: string value

Example

GET http://localhost/api/v1/purposeGroups

Example Response

{     "Identifier": "sample",     "Icon": "sample",     "AliasName": "sample",     "Description": "sample" }

Delete Purpose Group (DELETE)

Deletes an existing purpose group.

Route

URI	/api/v1/purposeGroups/{id}
Method	DELETE
Result	JSON – ChangeResult

Parameters

Name	Type	Mandatory	Description
id	string	Yes

Response Structure Returns ChangeResult object containing:

• Success: bool value

• Data: object value

• ResponseId: Guid? value

• ErrorDetails: ExternalInterfaceException value

Example

DELETE http://localhost/api/v1/purposeGroups/{id}

Example Response

{     "Success": true,     "Data": {},     "ResponseId": "123e4567-e89b-12d3-a456-426614174000",     "ErrorDetails": {} }