7x Developer Portal & API Documentation

Fetches existing renewal agent details associated with the supplied agent identifier. Supports edit and review workflows before update, payment, or deletion operations.

Request builder

GET

/api/v1/Renewal/GetAgents

agentIdstring

api-versionstring

Reference details

Query Parameters

agentId?string

api-version?string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/Renewal/GetAgents"

{  "agentId": 0,  "emailId": "string",  "mobileNo": "string",  "attachments": [    {      "attachmentName": "string",      "attachment": "string",      "fileFormat": "string",      "attachmentType": "Unknown"    }  ],  "emiratesId": "string",  "emirateCode": "string",  "idExpiryDate": "2019-08-24T14:15:22Z",  "agentFullNameEn": "string",  "agentFullNameAr": "string",  "agentStatus": "Active",  "approvalMessage": "string"}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

Overview

Fetches existing renewal agent details associated with the supplied agent identifier. Supports edit and review workflows before update, payment, or deletion operations.

Request builder

GET

/api/v1/Renewal/GetAgents

agentIdstring

api-versionstring

Reference details

Query Parameters

agentId?string

api-version?string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/Renewal/GetAgents"

{  "agentId": 0,  "emailId": "string",  "mobileNo": "string",  "attachments": [    {      "attachmentName": "string",      "attachment": "string",      "fileFormat": "string",      "attachmentType": "Unknown"    }  ],  "emiratesId": "string",  "emirateCode": "string",  "idExpiryDate": "2019-08-24T14:15:22Z",  "agentFullNameEn": "string",  "agentFullNameAr": "string",  "agentStatus": "Active",  "approvalMessage": "string"}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

Query Parameters

Response Body

200application/json

400application/json

404application/json

500application/json

Query Parameters

Response Body

200application/json

400application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`