Skip to main content

GridsApi

MethodHTTP requestDescription
AssignGridByIdUsingPUTPUT /api/web/v1/grids/{gridserialnumber}/assignAssign a grid to a user by serial number
AssignGridBySerialNumberUsingPUTPUT /api/web/v1/users/{id}/grids/assignAssign a user to a grid
AssignedGridsPageUsingPOSTPOST /api/web/v2/gridspaged/assignedLists a page of assigned grids
ChangeGridStateUsingPUTPUT /api/web/v2/grids/{gridid}/changestateChange state of grid
CreateGridUsingPOSTPOST /api/web/v2/users/{userid}/gridsCreate a grid
CreateUnassignedGridsUsingPOSTPOST /api/web/v1/gridsCreate unassigned grids
DeleteGridUsingDELETEDELETE /api/web/v2/grids/{gridid}Delete a grid
DeliverAssignedGridByEmailUsingPOSTPOST /api/web/v1/grids/{gridid}/emailEmail a grid card to the card owner
GetGridBySerialNumberUsingGETGET /api/web/v2/grids/sernum/{sernum}Get a grid by serial number
GetGridPropertiesUsingGETGET /api/web/v1/grids/propertiesGet grid properties
GetGridUsingGETGET /api/web/v2/grids/{gridid}Get a grid
GetSingleGridExportUsingGETGET /api/web/v1/grids/{gridid}/exportExport a grid to PDF format
ModifyUnassignedGridUsingPUTPUT /api/web/v2/grids/{gridid}Modify unassigned grid
UnassignGridUsingPUTPUT /api/web/v1/grids/{id}/unassignUnassign a grid
UnassignedGridsPageUsingPOSTPOST /api/web/v1/gridspaged/unassignedLists a page of unassigned grids

AssignGridByIdUsingPUT​

void AssignGridByIdUsingPUT (string gridserialnumber, GridAssignParms gridAssignParms)

Assign a grid to a user by serial number

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

Using the AssignGridByIdUsingPUTWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters​

NameTypeDescriptionNotes
gridserialnumberstringThe Serial Number of the grid to assign.
gridAssignParmsGridAssignParms

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-

AssignGridBySerialNumberUsingPUT​

void AssignGridBySerialNumberUsingPUT (string id, GridAssignParms gridAssignParms)

Assign a user to a grid

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

Example​

Using the AssignGridBySerialNumberUsingPUTWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters​

NameTypeDescriptionNotes
idstringThe UUID of the user to which a grid is to be assigned.
gridAssignParmsGridAssignParms

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-

AssignedGridsPageUsingPOST​

GridsPage AssignedGridsPageUsingPOST (SearchParms searchParms)

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​

Using the AssignedGridsPageUsingPOSTWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters​

NameTypeDescriptionNotes
searchParmsSearchParms

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-

ChangeGridStateUsingPUT​

void ChangeGridStateUsingPUT (string gridid, GridChangeStateParms gridChangeStateParms)

Change state of grid

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

Example​

Using the ChangeGridStateUsingPUTWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters​

NameTypeDescriptionNotes
grididstringThe UUID of the grid whose state is to be changed.
gridChangeStateParmsGridChangeStateParms

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-

CreateGridUsingPOST​

Grid CreateGridUsingPOST (string userid, GridCreateParms gridCreateParms = null)

Create a grid

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

Example​

Using the CreateGridUsingPOSTWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters​

NameTypeDescriptionNotes
useridstringThe UUID of the user for which a grid will be created.
gridCreateParmsGridCreateParms[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-

CreateUnassignedGridsUsingPOST​

List<Grid> CreateUnassignedGridsUsingPOST (GridCreateParms gridCreateParms)

Create unassigned grids

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

Example​

Using the CreateUnassignedGridsUsingPOSTWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters​

NameTypeDescriptionNotes
gridCreateParmsGridCreateParms

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-

DeleteGridUsingDELETE​

void DeleteGridUsingDELETE (string gridid)

Delete a grid

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

Example​

Using the DeleteGridUsingDELETEWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters​

NameTypeDescriptionNotes
grididstringThe 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-

DeliverAssignedGridByEmailUsingPOST​

void DeliverAssignedGridByEmailUsingPOST (string gridid, EmailParms emailParms = null)

Email a grid card to the card owner

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

Example​

Using the DeliverAssignedGridByEmailUsingPOSTWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters​

NameTypeDescriptionNotes
grididstringThe ID of the grid to email.
emailParmsEmailParms[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-

GetGridBySerialNumberUsingGET​

Grid GetGridBySerialNumberUsingGET (long sernum)

Get a grid by serial number

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

Example​

Using the GetGridBySerialNumberUsingGETWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters​

NameTypeDescriptionNotes
sernumlongThe 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-

GetGridPropertiesUsingGET​

GridProperties GetGridPropertiesUsingGET ()

Get grid properties

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

Example​

Using the GetGridPropertiesUsingGETWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

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-

GetGridUsingGET​

Grid GetGridUsingGET (string gridid)

Get a grid

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

Example​

Using the GetGridUsingGETWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters​

NameTypeDescriptionNotes
grididstringThe 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-

GetSingleGridExportUsingGET​

GridExport GetSingleGridExportUsingGET (string gridid)

Export a grid to PDF format

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

Example​

Using the GetSingleGridExportUsingGETWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters​

NameTypeDescriptionNotes
grididstringThe 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-

ModifyUnassignedGridUsingPUT​

void ModifyUnassignedGridUsingPUT (string gridid, GridParms gridParms)

Modify unassigned grid

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

Example​

Using the ModifyUnassignedGridUsingPUTWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters​

NameTypeDescriptionNotes
grididstringThe UUID of the grid to be modified.
gridParmsGridParms

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-

UnassignGridUsingPUT​

void UnassignGridUsingPUT (string id)

Unassign a grid

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

Example​

Using the UnassignGridUsingPUTWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters​

NameTypeDescriptionNotes
idstringThe 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-

UnassignedGridsPageUsingPOST​

GridsPage UnassignedGridsPageUsingPOST (SearchParms searchParms)

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​

Using the UnassignedGridsPageUsingPOSTWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters​

NameTypeDescriptionNotes
searchParmsSearchParms

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-