Skip to main content

GridsApi

MethodHTTP requestDescription
assign_grid_by_id_using_putPUT /api/web/v1/grids/{gridserialnumber}/assignAssign a grid to a user by serial number
assign_grid_by_serial_number_using_putPUT /api/web/v1/users/{id}/grids/assignAssign a user to a grid
assigned_grids_page_using_postPOST /api/web/v2/gridspaged/assignedLists a page of assigned grids
change_grid_state_using_putPUT /api/web/v2/grids/{gridid}/changestateChange state of grid
create_grid_using_postPOST /api/web/v2/users/{userid}/gridsCreate a grid
create_unassigned_grids_using_postPOST /api/web/v1/gridsCreate unassigned grids
delete_grid_using_deleteDELETE /api/web/v2/grids/{gridid}Delete a grid
deliver_assigned_grid_by_email_using_postPOST /api/web/v1/grids/{gridid}/emailEmail a grid card to the card owner
get_grid_by_serial_number_using_getGET /api/web/v2/grids/sernum/{sernum}Get a grid by serial number
get_grid_properties_using_getGET /api/web/v1/grids/propertiesGet grid properties
get_grid_using_getGET /api/web/v2/grids/{gridid}Get a grid
get_single_grid_export_using_getGET /api/web/v1/grids/{gridid}/exportExport a grid to PDF format
modify_unassigned_grid_using_putPUT /api/web/v2/grids/{gridid}Modify unassigned grid
unassign_grid_using_putPUT /api/web/v1/grids/{id}/unassignUnassign a grid
unassigned_grids_page_using_postPOST /api/web/v1/gridspaged/unassignedLists a page of unassigned grids

assign_grid_by_id_using_put​

assign_grid_by_id_using_put(gridserialnumber, grid_assign_parms)

Assign a grid to a user by serial number

Assign the specified grid to a user. Caller requires the GRIDS:EDIT permission.

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
gridserialnumberstrThe Serial Number of the grid to assign.
grid_assign_parmsGridAssignParms

Return type​

void (empty response body)

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

assign_grid_by_serial_number_using_put​

assign_grid_by_serial_number_using_put(id, grid_assign_parms)

Assign a user to a grid

Assign the specified user a grid. Caller requires the GRIDS:EDIT permission.

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
idstrThe UUID of the user to which a grid is to be assigned.
grid_assign_parmsGridAssignParms

Return type​

void (empty response body)

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

assigned_grids_page_using_post​

GridsPage assigned_grids_page_using_post(search_parms)

Lists a page of assigned grids

Returns assigned grids for the provided search parameters. Caller requires the GRIDS:VIEW permission. The following searchByAttributes are supported:

  • serialNumber: a numeric value. Allowed operators are: EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL.
  • state: ACTIVE, INACTIVE, PENDING, CANCELED. Allowed operator: EQUALS.
  • expired: 'true' is the only value allowed. Allowed operator: EQUALS.
  • createDate: a String value representing an ISO-8601 date in UTC time (e.g., 2018-08-04T18:15:30). Allowed operators are: GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL.
  • expiryDate: a String value representing an ISO-8601 date in UTC time (e.g., 2018-08-04T18:15:30). Allowed operators are: GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL.
  • lastUsedDate: a String value representing an ISO-8601 date in UTC time (e.g., 2018-08-04T18:15:30). Allowed operators are: GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL.
  • userId: a String value. Allowed operators are: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, STARTS_WITH, ENDS_WITH.
  • groupId: a String value should be a UUID of an existing group. Allowed operator: EQUALS.

If you provide more than one search attribute, they are joined with an AND condition.

The orderByAttribute supports these attribute names: serialNumber, state, createDate, expiryDate, lastUsedDate, userId.
The results will only include grids that contain data in the orderByAttribute selected.

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
search_parmsSearchParms

Return type​

GridsPage

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

change_grid_state_using_put​

change_grid_state_using_put(gridid, grid_change_state_parms)

Change state of grid

Change the state of the specified grid. Caller requires the GRIDS:EDIT permission.

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
grididstrThe UUID of the grid whose state is to be changed.
grid_change_state_parmsGridChangeStateParms

Return type​

void (empty response body)

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

create_grid_using_post​

Grid create_grid_using_post(userid, grid_create_parms=grid_create_parms)

Create a grid

Create a grid for the specified user. Caller requires the GRIDS:ADD permission.

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
useridstrThe UUID of the user for which a grid will be created.
grid_create_parmsGridCreateParms[optional]

Return type​

Grid

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

create_unassigned_grids_using_post​

List[Grid] create_unassigned_grids_using_post(grid_create_parms)

Create unassigned grids

Create the specified number of unassigned grids. Caller requires the GRIDS:ADD permission.

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
grid_create_parmsGridCreateParms

Return type​

List[Grid]

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

delete_grid_using_delete​

delete_grid_using_delete(gridid)

Delete a grid

Delete the specified grid. Caller requires the GRIDS:REMOVE permission.

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
grididstrThe UUID of the grid to be deleted.

Return type​

void (empty response body)

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

deliver_assigned_grid_by_email_using_post​

deliver_assigned_grid_by_email_using_post(gridid, email_parms=email_parms)

Email a grid card to the card owner

Email a grid card to the card owner. Caller requires the GRIDS:VIEW permission.

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
grididstrThe ID of the grid to email.
email_parmsEmailParms[optional]

Return type​

void (empty response body)

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

get_grid_by_serial_number_using_get​

Grid get_grid_by_serial_number_using_get(sernum)

Get a grid by serial number

Get the grid for the specified serial number. Caller requires the GRIDS:VIEW permission.

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
sernumintThe serial number of the grid to be retrieved.

Return type​

Grid

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

get_grid_properties_using_get​

GridProperties get_grid_properties_using_get()

Get grid properties

Get grid properties. Caller requires the GRIDS:VIEW permission.

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

This endpoint does not need any parameter.

Return type​

GridProperties

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

get_grid_using_get​

Grid get_grid_using_get(gridid)

Get a grid

Get the specified grid. Caller requires the GRIDS:VIEW permission.

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
grididstrThe UUID of the grid to be retrieved.

Return type​

Grid

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

get_single_grid_export_using_get​

GridExport get_single_grid_export_using_get(gridid)

Export a grid to PDF format

Export a grid to PDF format. Caller requires the GRIDS:VIEW permission.

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
grididstrThe ID of the grid to export.

Return type​

GridExport

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

modify_unassigned_grid_using_put​

modify_unassigned_grid_using_put(gridid, grid_parms)

Modify unassigned grid

Modify the specified unassigned grid. Caller requires the GRIDS:EDIT permission.

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
grididstrThe UUID of the grid to be modified.
grid_parmsGridParms

Return type​

void (empty response body)

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

unassign_grid_using_put​

unassign_grid_using_put(id)

Unassign a grid

Unassigned the specified grid. Caller requires the GRIDS:EDIT permission.

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
idstrThe UUID of the grid to unassign.

Return type​

void (empty response body)

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

unassigned_grids_page_using_post​

GridsPage unassigned_grids_page_using_post(search_parms)

Lists a page of unassigned grids

Returns unassigned grids for the provided search parameters. Caller requires the GRIDS:VIEW permission. The following searchByAttributes are supported:

  • serialNumber: a numeric value. Allowed operators are: EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL.
  • createDate: a String value representing an ISO-8601 date in UTC time (e.g., 2018-08-04T18:15:30). Allowed operators are: GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL.
  • groupId: a String value should be a UUID of an existing group. Allowed operator: EQUALS.

If you provide more than one search attribute, they are joined with an AND condition.

The orderByAttribute supports these attribute names: serialNumber, createDate.

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
search_parmsSearchParms

Return type​

GridsPage

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-