Site Tools


guides:ws_validatebase64documentchecksum

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
guides:ws_validatebase64documentchecksum [2018/08/21 23:22] brett.zamoraguides:ws_validatebase64documentchecksum [2018/08/21 23:36] (current) brett.zamora
Line 31: Line 31:
 <color #7092be>JSON Request Parameters</color> <color #7092be>JSON Request Parameters</color>
  
-{{tablelayout?colwidth="150px,75px,125px,225px"&rowsFixed=1&rowsVisible=10&float=center}} +{{tablelayout?colwidth="175px,75px,100px,250px"&rowsFixed=1&rowsVisible=10&float=center}} 
-^ Parm Name ^ Req/Opt ^ Allowed Values ^ Description ^+^ Parm Name ^ Req/Opt ^ Format ^ Description ^
 | transaction_type | Required | [string] | Request or Response | | transaction_type | Required | [string] | Request or Response |
 | submitter_id | Required | [numeric] | Numeric submitter id enclosed in double-quotes. | | submitter_id | Required | [numeric] | Numeric submitter id enclosed in double-quotes. |
Line 38: Line 38:
 | document_order_index | Required | [numeric] | Document sequence number enclosed in double-quotes. | | document_order_index | Required | [numeric] | Document sequence number enclosed in double-quotes. |
 | checksum_algorithm | Required | [string] | Currently supporting SHA384. | | checksum_algorithm | Required | [string] | Currently supporting SHA384. |
-| checksum_value | Required | [string] | Locally calculated checksum value represented as a Base64 string. +| checksum_value | Required | [string] | Locally calculated checksum value represented as a Base64 string. See comments for example of how to calculate a SHA3 checksum and convert it to a Base64 string. |
-See comments for example of how to calculate a SHA3 checksum and convert it to a Base64 string. +
- |+
  
  
Line 46: Line 44:
  
 {{tablelayout?colwidth="125px,100px,375px"&rowsFixed=1&rowsVisible=10&float=center}} {{tablelayout?colwidth="125px,100px,375px"&rowsFixed=1&rowsVisible=10&float=center}}
-^ Parm Name ^ Data Type ^ Description ^+^ Parm Name ^ Format ^ Description ^
 | result | [string] | If transaction/document is found <color #7092be>true</color> or <color #7092be>false</color> will be returned. Note: Counties and/or agents may only query transactions/documents associated with their county and/or agent. | | result | [string] | If transaction/document is found <color #7092be>true</color> or <color #7092be>false</color> will be returned. Note: Counties and/or agents may only query transactions/documents associated with their county and/or agent. |
 | code | [string] | Exception conditions will result in code/message being returned. | | code | [string] | Exception conditions will result in code/message being returned. |
Line 86: Line 84:
 Status Code: 200 Status Code: 200
  
-or 
- 
-Status Code: 500  (When an error occurs.) 
  
 <code json> <code json>
Line 96: Line 91:
 </code> </code>
  
-or  (example 1)+ 
 +**or** 
 + 
 +Status Code: 500  (When an error occurs.) 
 + 
 + 
 +(Error example 1)
  
 <code json> <code json>
Line 107: Line 108:
 </code> </code>
  
-or  (example 2)+(Error example 2)
  
 <code json> <code json>
guides/ws_validatebase64documentchecksum.1534893765.txt.gz · Last modified: by brett.zamora