Id Repo Vid Service (1.0)

Download OpenAPI specification:Download

License: Mosip

Id Repo Vid Service

vid-controller

Vid Controller

createVid

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (VidRequestDTO)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"vidStatus": "string",
"vidType": "string",
"UIN": "string"
}
}

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "2019-08-24T14:15:22Z",
"metadata": { },
"response": {"vidStatus": "string",
"restoredVid": { },
"UIN": "string",
"VID": "string"
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

retrieveUinByVid

path Parameters

VID

required

string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "2019-08-24T14:15:22Z",
"metadata": { },
"response": {"vidStatus": "string",
"restoredVid": { },
"UIN": "string",
"VID": "string"
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

updateVidStatus

path Parameters

VID

required

string

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (VidRequestDTO)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"vidStatus": "string",
"vidType": "string",
"UIN": "string"
}
}

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "2019-08-24T14:15:22Z",
"metadata": { },
"response": {"vidStatus": "string",
"restoredVid": { },
"UIN": "string",
"VID": "string"
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

regenerateVid

path Parameters

VID

required

string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "2019-08-24T14:15:22Z",
"metadata": { },
"response": {"vidStatus": "string",
"restoredVid": { },
"UIN": "string",
"VID": "string"
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

retrieveVidsByUin

path Parameters

UIN

required

string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "2019-08-24T14:15:22Z",
"metadata": { },
"response": [{"vid": "string",
"vidType": "string",
"expiryTimestamp": "2019-08-24T14:15:22Z",
"transactionLimit": 0,
"hashAttributes": {"property1": "string",
"property2": "string"
}
}
],
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

reactivateVIDsForUIN

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (VidRequestDTO)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"vidStatus": "string",
"vidType": "string",
"UIN": "string"
}
}

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "2019-08-24T14:15:22Z",
"metadata": { },
"response": {"vidStatus": "string",
"restoredVid": { },
"UIN": "string",
"VID": "string"
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

deactivateVIDsForUIN

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (VidRequestDTO)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"vidStatus": "string",
"vidType": "string",
"UIN": "string"
}
}

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "2019-08-24T14:15:22Z",
"metadata": { },
"response": {"vidStatus": "string",
"restoredVid": { },
"UIN": "string",
"VID": "string"
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

createDraftVid

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (VidRequestDTO)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"vidStatus": "string",
"vidType": "string",
"UIN": "string"
}
}

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "2019-08-24T14:15:22Z",
"metadata": { },
"response": {"vidStatus": "string",
"restoredVid": { },
"UIN": "string",
"VID": "string"
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

Home

Id Repo Vid Service (1.0)

vid-controller

createVid

Request Body schema: application/json

Responses

Request samples

Response samples

retrieveUinByVid

path Parameters

Responses

Response samples

updateVidStatus

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

regenerateVid

path Parameters

Responses

Response samples

retrieveVidsByUin

path Parameters

Responses

Response samples

reactivateVIDsForUIN

Request Body schema: application/json

Responses

Request samples

Response samples

deactivateVIDsForUIN

Request Body schema: application/json

Responses

Request samples

Response samples

createDraftVid

Request Body schema: application/json

Responses

Request samples

Response samples

Home