ID Generation

ID Generation APIs

Generates unique ID/code in the prescribed format

Create new id.

API to generate new id based on the id formats passed.

post

/id/_generate

Body

requestInfoobject

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

idRequestsobject[]

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://dev.digit.org/egov-idgen//id/_generate' \
  --header 'Content-Type: */*' \
  --data '{"requestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"idRequests":[{"idName":"text","tenantId":"text"}]}'

201

400

201

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "idResponses": [
    {
      "id": "text"
    }
  ]
}

Id generated sucessfully.