Operator

getOperator

get

This method returns the information of an operator, given its search keys.

Path parameters

keystringRequired

Responses

200

OK

No content

302

Found

application/json

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

415

Unsupported Media Type

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

503

Service Unavailable

*/*

get

/gbs-spid-server/operator/{key}

HTTPcURLJavaScriptPython

GET /gbs-spid-server/operator/{key} HTTP/1.1
Host: <ip>:8082
Accept: */*

No content

deleteOperator

delete

This method deletes an operator from the database, given its search keys.

Path parameters

keystringRequired

Responses

202

Accepted

204

No Content

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

415

Unsupported Media Type

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

503

Service Unavailable

*/*

delete

/gbs-spid-server/operator/{key}

HTTPcURLJavaScriptPython

DELETE /gbs-spid-server/operator/{key} HTTP/1.1
Host: <ip>:8082
Accept: */*

No content

operatorList

get

This method returns the list of valid operators into the database.

Responses

200

OK

application/json

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

415

Unsupported Media Type

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

503

Service Unavailable

*/*

get

/gbs-spid-server/operator/list

HTTPcURLJavaScriptPython

GET /gbs-spid-server/operator/list HTTP/1.1
Host: <ip>:8082
Accept: */*

[
  {
    "document": "text",
    "status": "VERIFIED",
    "tguid": "text"
  }
]

operatorInsert

post

Body

application/json

Responses

201

Created

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

415

Unsupported Media Type

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

503

Service Unavailable

*/*

post

/gbs-spid-server/operator

HTTPcURLJavaScriptPython

POST /gbs-spid-server/operator HTTP/1.1
Host: <ip>:8082
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "data": {
    "document": "text"
  }
}

No content

enrollOperator

put

This method submits an operator enrollment to the server.

Body

application/json

Responses

201

Created

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

415

Unsupported Media Type

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

503

Service Unavailable

*/*

put

/gbs-spid-server/operator

HTTPcURLJavaScriptPython

PUT /gbs-spid-server/operator HTTP/1.1
Host: <ip>:8082
Content-Type: application/json
Accept: */*
Content-Length: 143

{
  "data": {
    "document": "text",
    "biometrics": [
      {
        "index": 1,
        "content": "text",
        "width": 1,
        "height": 1,
        "resolution": 1
      }
    ],
    "status": "VERIFIED",
    "tguid": "text"
  }
}

No content