Pre-Registration-Booking (1.0)

Download OpenAPI specification:Download

License: Mosip

Pre-Registration-Booking Service

booking-controller

Booking Controller

Cancel an booked appointment

path Parameters

preRegistrationId

required

string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "string",
"response": {"transactionId": "string",
"message": "string"
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

Booking Appointment

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
	object (MultiBookingRequest)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"request": {"bookingRequest": [{"preRegistrationId": "string",
"registration_center_id": "string",
"appointment_date": "string",
"time_slot_from": "string",
"time_slot_to": "string"
}
]
}
}

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "string",
"response": {"bookingStatusResponse": [{"bookingMessage": "string"
}
]
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

Discard Booking

query Parameters

preRegistrationId

required

string

Responses

Response samples

200
204

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "string",
"response": {"preRegistrationId": "string",
"deletedBy": "string",
"deletedDateTime": "2019-08-24T14:15:22Z"
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

Fetch Appointment details

path Parameters

preRegistrationId

required

string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "string",
"response": {"registration_center_id": "string",
"appointment_date": "string",
"time_slot_from": "string",
"time_slot_to": "string"
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

Cancel an booked appointment

path Parameters

preRegistrationId

required

string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "string",
"response": {"transactionId": "string",
"message": "string"
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

Booking Appointment

path Parameters

preRegistrationId

required

string

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
	object (BookingRequestDTO)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"request": {"registration_center_id": "string",
"appointment_date": "string",
"time_slot_from": "string",
"time_slot_to": "string"
}
}

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "string",
"response": {"bookingMessage": "string"
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

Get Pre-Registartion ids By Booked Date Time And Registration center id

path Parameters

registrationCenterId

required

string

query Parameters

from_date required	string
to_date required	string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "string",
"response": {"registrationCenterId": "string",
"idsWithAppointmentDate": {"property1": {"property1": {"fromTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
},
"toTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
}
},
"property2": {"fromTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
},
"toTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
}
}
},
"property2": {"property1": {"fromTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
},
"toTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
}
},
"property2": {"fromTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
},
"toTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
}
}
}
}
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

Get Pre-Registartion ids By Booked Date Time And Registration center id

path Parameters

registrationCenterId

required

string

query Parameters

from_date required	string
to_date required	string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "string",
"response": {"registration_center_id": "string",
"pre_registration_ids": ["string"
]
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

Fetch availability Data

path Parameters

registrationCenterId

required

string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "string",
"response": {"regCenterId": "string",
"centerDetails": [{"date": "string",
"timeSlots": [{"fromTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
},
"toTime": {"hour": 0,
"minute": 0,
"second": 0,
"nano": 0
},
"availability": 0
}
],
"holiday": true
}
]
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

Home

Pre-Registration-Booking (1.0)

booking-controller

Cancel an booked appointment

path Parameters

Responses

Response samples

Booking Appointment

Request Body schema: application/json

Responses

Request samples

Response samples

Discard Booking

query Parameters

Responses

Response samples

Fetch Appointment details

path Parameters

Responses

Response samples

Cancel an booked appointment

path Parameters

Responses

Response samples

Booking Appointment

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Get Pre-Registartion ids By Booked Date Time And Registration center id

path Parameters

query Parameters

Responses

Response samples

Get Pre-Registartion ids By Booked Date Time And Registration center id

path Parameters

query Parameters

Responses

Response samples

Fetch availability Data

path Parameters

Responses

Response samples

Home