diff --git a/doc/api/application/activate.json b/doc/api/application/activate.json new file mode 100644 index 0000000..f1013d9 --- /dev/null +++ b/doc/api/application/activate.json @@ -0,0 +1,48 @@ +{ + "resource": "Lob Application", + "resource_explanation": "Public API endpoints for creating LOB Application Assets", + "http_method": "POST", + "route": "api/public/asset/v1/lob_application/activate/:id", + "description": "Activate Asset", + "explanation": "Activate a Lob Application Asset", + "parameters": [ + { + "required": true, + "data_type": "STRING(255)", + "name": "source_system", + "description": "Name of calling system" + }, + { + "required": true, + "data_type": "STRING(255)", + "name": "source_transaction_id", + "description": "Transaction ID supplied by calling system" + } + ], + "response_fields": [ + + ], + "requests": [ + { + "request_method": "POST", + "request_path": "api/public/asset/v1/lob_application/activate/14570", + "request_body": "{\"request\":{\"data\":{},\"source_system\":\"Marketplace\",\"source_transaction_id\":\"0934875y2394-8569\"}}", + "request_headers": { + "Authorization": "Basic TzAwMDA5MToxMjM0NTY=", + "Accept": "application/json", + "Content-Type": "application/json", + "Host": "example.org", + "Cookie": "" + }, + "request_query_parameters": { + }, + "request_content_type": "application/json", + "response_status": 200, + "response_status_text": "OK", + "response_body": "{\"activated\":true}", + "response_headers": {"Content-Type":"application/json; charset=utf-8","Access-Control-Allow-Origin":"*","X-UA-Compatible":"IE=Edge,chrome=1","ETag":"\"508b21dbddabe09471bc1f3e7583ef4b\"","Cache-Control":"max-age=0, private, must-revalidate","Set-Cookie":"_rsam_test=efa6519e56b7d319f8081d5730fd5c3a; domain=.example.org; path=/; HttpOnly","X-Request-Id":"13f9aa4fb8268aa9ad3dd0c5a0b055da","X-Runtime":"0.141479","Content-Length":"18"}, + "response_content_type": "application/json; charset=utf-8", + "curl": null +} + ] +} \ No newline at end of file diff --git a/doc/api/application/create.json b/doc/api/application/create.json new file mode 100644 index 0000000..5e329b0 --- /dev/null +++ b/doc/api/application/create.json @@ -0,0 +1,69 @@ +{ + "resource": "Lob Application", + "resource_explanation": "Public API endpoints for creating LOB Application Assets", + "http_method": "POST", + "route": "api/public/asset/v1/lob_application", + "description": "Create Asset", + "explanation": "Create a Lob Application", + "parameters": [ + { + "required": true, + "data_type": "INTEGER(38)", + "scope": "data", + "name": "seal_id", + "description": "Also know as appquest application id" + }, + { + "required": true, + "data_type": "STRING(255)", + "scope": "data", + "name": "environment", + "description": "One of prepopulated values in DB" + }, + { + "required": false, + "data_type": "STRING(255)", + "scope": "data", + "name": "instance", + "description": "Name of the asset instance" + }, + { + "required": true, + "data_type": "STRING(255)", + "name": "source_system", + "description": "Name of calling system" + }, + { + "required": true, + "data_type": "STRING(255)", + "name": "source_transaction_id", + "description": "Transaction ID supplied by calling system" + } + ], + "response_fields": [ + + ], + "requests": [ + { + "request_method": "POST", + "request_path": "api/public/asset/v1/lob_application", + "request_body": "{\"request\":{\"data\":{\"seal_id\":100002,\"environment\":\"Production\",\"instance\":\"Test\"},\"source_system\":\"GAIA Marketplace\",\"source_transaction_id\":\"348t7gp34iu-8347f\"}}", + "request_headers": { + "Authorization": "Basic TzAwMDExODoxMjM0NTY=", + "Accept": "application/json", + "Content-Type": "application/json", + "Host": "example.org", + "Cookie": "" + }, + "request_query_parameters": { + }, + "request_content_type": "application/json", + "response_status": 200, + "response_status_text": "OK", + "response_body": "{\"asset_id\":14571}", + "response_headers": {"Content-Type":"application/json; charset=utf-8","Access-Control-Allow-Origin":"*","X-UA-Compatible":"IE=Edge,chrome=1","ETag":"\"626e6bdfbfd35cbb9fa5f53a93957c7b\"","Cache-Control":"max-age=0, private, must-revalidate","Set-Cookie":"_rsam_test=7b6d9fdb93250553316125ef3bef8ec8; domain=.example.org; path=/; HttpOnly","X-Request-Id":"e3d92e63156ba79cae37572142cf6f72","X-Runtime":"0.127212","Content-Length":"18"}, + "response_content_type": "application/json; charset=utf-8", + "curl": null +} + ] +} \ No newline at end of file diff --git a/doc/api/certificate/add.json b/doc/api/certificate/add.json new file mode 100644 index 0000000..45a7ca5 --- /dev/null +++ b/doc/api/certificate/add.json @@ -0,0 +1,93 @@ +{ + "resource": "Certificate Request", + "resource_explanation": "Public API endpoints for requesting actions for certificates", + "http_method": "POST", + "route": "/api/public/cert/v1/certificate_request", + "description": "Add", + "explanation": "Create a new Certificate Request", + "parameters": [ + { + "required": true, + "name": "data", + "description": "Container object for request specific parameters" + }, + { + "required": true, + "scope": "data", + "name": "cert_request_type", + "description": "add" + }, + { + "required": true, + "scope": "data", + "name": "cert_type", + "description": "add" + }, + { + "required": true, + "scope": "data", + "name": "fid", + "description": "Functional ID" + }, + { + "required": true, + "scope": "data", + "data_type": "INTEGER", + "name": "licenses", + "description": "Number of licenses you are requesting" + }, + { + "required": true, + "scope": "data", + "data_type": "STRING(255)", + "name": "csr", + "description": "Valid CSR (SHA256 Encrypted)" + }, + { + "required": true, + "scope": "data", + "name": "cost_center", + "description": "Cost Center" + }, + { + "required": true, + "data_type": "STRING(4000)", + "scope": "data", + "name": "description", + "description": "Description" + }, + { + "required": false, + "scope": "data", + "data_type": "INTEGER(38)", + "name": "notify_sealid", + "description": "A seal id to send notifications to" + } + ], + "response_fields": [ + + ], + "requests": [ + { + "request_method": "POST", + "request_path": "/api/public/cert/v1/certificate_request", + "request_body": "{\"request\":{\"data\":{\"cert_request_type\":\"Add\",\"fid\":\"O000212\",\"licenses\":1,\"cert_type\":\"example\",\"csr\":\"\\u003C\\u003CCSR\\u003E\\u003E\",\"cost_center\":\"12345\",\"description\":\"I am a certificate for JPMCHASE.COM\",\"notify_sealid\":24041},\"requested_for\":\"O000209\"}}", + "request_headers": { + "Authorization": "Basic TzAwMDIwNjoxMjM0NTY=", + "Accept": "application/json", + "Content-Type": "application/json", + "Host": "example.org", + "Cookie": "" + }, + "request_query_parameters": { + }, + "request_content_type": "application/json", + "response_status": 200, + "response_status_text": "OK", + "response_body": "{\"request_id\":5952}", + "response_headers": {"Content-Type":"application/json; charset=utf-8","Access-Control-Allow-Origin":"*","X-UA-Compatible":"IE=Edge,chrome=1","ETag":"\"89f03a9bd405403f88e0691c64bbfba2\"","Cache-Control":"max-age=0, private, must-revalidate","Set-Cookie":"_rsam_test=e4de5a521d6a78ba8557ec241d24db77; domain=.example.org; path=/; HttpOnly","X-Request-Id":"fab79e97703cb1d257911eee507bddb4","X-Runtime":"0.109330","Content-Length":"19"}, + "response_content_type": "application/json; charset=utf-8", + "curl": null +} + ] +} \ No newline at end of file diff --git a/doc/api/certificate/renew.json b/doc/api/certificate/renew.json new file mode 100644 index 0000000..55fd222 --- /dev/null +++ b/doc/api/certificate/renew.json @@ -0,0 +1,67 @@ +{ + "resource": "Certificate Request", + "resource_explanation": "Public API endpoints for requesting actions for certificates", + "http_method": "POST", + "route": "/api/public/cert/v1/certificate_request", + "description": "Renew", + "explanation": "Creates a Certificate Renew Request", + "parameters": [ + { + "required": true, + "name": "data", + "description": "Container object for request specific parameters" + }, + { + "required": true, + "scope": "data", + "name": "cert_request_type", + "description": "add" + }, + { + "required": true, + "scope": "data", + "name": "fid", + "description": "Functional ID" + }, + { + "required": true, + "scope": "data", + "data_type": "STRING(255)", + "name": "csr", + "description": "Valid CSR (SHA256 Encrypted)" + }, + { + "required": true, + "scope": "data", + "data_type": "INTEGER", + "name": "serial_number", + "description": "The Serial number of the certificate" + } + ], + "response_fields": [ + + ], + "requests": [ + { + "request_method": "POST", + "request_path": "/api/public/cert/v1/certificate_request", + "request_body": "{\"request\":{\"data\":{\"fid\":\"O000203\",\"cert_request_type\":\"Renew\",\"csr\":\"\\u003C\\u003CCSR\\u003E\\u003E\",\"serial_number\":\"98210dj38290cjas8f3892jc89813981v\"},\"requested_for\":\"O000200\"}}", + "request_headers": { + "Authorization": "Basic TzAwMDE5NzoxMjM0NTY=", + "Accept": "application/json", + "Content-Type": "application/json", + "Host": "example.org", + "Cookie": "" + }, + "request_query_parameters": { + }, + "request_content_type": "application/json", + "response_status": 200, + "response_status_text": "OK", + "response_body": "{\"request_id\":5951}", + "response_headers": {"Content-Type":"application/json; charset=utf-8","Access-Control-Allow-Origin":"*","X-UA-Compatible":"IE=Edge,chrome=1","ETag":"\"9136a5e8b55b4ca351667623baf16503\"","Cache-Control":"max-age=0, private, must-revalidate","Set-Cookie":"_rsam_test=b75c0ae592cda268ab2cb075f318847f; domain=.example.org; path=/; HttpOnly","X-Request-Id":"063c538dfb9fbdb1b2ce083b9699e44e","X-Runtime":"0.109530","Content-Length":"19"}, + "response_content_type": "application/json; charset=utf-8", + "curl": null +} + ] +} \ No newline at end of file diff --git a/doc/api/certificate/replace.json b/doc/api/certificate/replace.json new file mode 100644 index 0000000..c128078 --- /dev/null +++ b/doc/api/certificate/replace.json @@ -0,0 +1,94 @@ +{ + "resource": "Certificate Request", + "resource_explanation": "Public API endpoints for requesting actions for certificates", + "http_method": "POST", + "route": "/api/public/cert/v1/certificate_request", + "description": "Replace", + "explanation": "Creates a Certificate Replace Request", + "parameters": [ + { + "required": true, + "name": "data", + "description": "Container object for request specific parameters" + }, + { + "required": true, + "scope": "data", + "name": "cert_request_type", + "description": "add" + }, + { + "required": true, + "scope": "data", + "name": "fid", + "description": "Functional ID" + }, + { + "required": true, + "scope": "data", + "data_type": "STRING(255)", + "name": "csr", + "description": "Valid CSR (SHA256 Encrypted)" + }, + { + "required": true, + "scope": "data", + "data_type": "INTEGER", + "name": "serial_number", + "description": "The Serial number of the certificate" + }, + { + "required": true, + "scope": "data", + "name": "cost_center", + "description": "Cost Center" + }, + { + "required": true, + "scope": "data", + "data_type": "INTEGER", + "name": "licenses", + "description": "Number of licenses you are requesting" + }, + { + "required": true, + "data_type": "STRING(4000)", + "scope": "data", + "name": "description", + "description": "Description" + }, + { + "required": false, + "scope": "data", + "data_type": "INTEGER(38)", + "name": "notify_sealid", + "description": "A seal id to send notifications to" + } + ], + "response_fields": [ + + ], + "requests": [ + { + "request_method": "POST", + "request_path": "/api/public/cert/v1/certificate_request", + "request_body": "{\"request\":{\"data\":{\"fid\":\"O000194\",\"cert_request_type\":\"Replace\",\"csr\":\"\\u003C\\u003CCSR\\u003E\\u003E\",\"cost_center\":\"cost center\",\"licenses\":\"licenses\",\"description\":\"I am a certificate for JPMCHASE.COM\",\"notify_sealid\":24041,\"serial_number\":\"98210dj38290cjas8f3892jc89813981v\"},\"requested_for\":\"O000191\"}}", + "request_headers": { + "Authorization": "Basic TzAwMDE4ODoxMjM0NTY=", + "Accept": "application/json", + "Content-Type": "application/json", + "Host": "example.org", + "Cookie": "" + }, + "request_query_parameters": { + }, + "request_content_type": "application/json", + "response_status": 200, + "response_status_text": "OK", + "response_body": "{\"code\":100,\"message\":\"Bad Request\",\"errors\":[[[\"Number of Licenses must be a number between 1 and 99\",\"Old Fid must be provided\"]]]}", + "response_headers": {"Content-Type":"application/json; charset=utf-8","Access-Control-Allow-Origin":"*","X-UA-Compatible":"IE=Edge,chrome=1","ETag":"\"6deb492107d9de5cadbedffab7dbd657\"","Cache-Control":"max-age=0, private, must-revalidate","Set-Cookie":"_rsam_test=4736bf78074c83a4324f634a564b1a3c; domain=.example.org; path=/; HttpOnly","X-Request-Id":"05f6acdbad6706356093040a00a5b1ce","X-Runtime":"0.089253","Content-Length":"133"}, + "response_content_type": "application/json; charset=utf-8", + "curl": null +} + ] +} \ No newline at end of file diff --git a/doc/api/certificate/revoke.json b/doc/api/certificate/revoke.json new file mode 100644 index 0000000..42df800 --- /dev/null +++ b/doc/api/certificate/revoke.json @@ -0,0 +1,67 @@ +{ + "resource": "Certificate Request", + "resource_explanation": "Public API endpoints for requesting actions for certificates", + "http_method": "POST", + "route": "/api/public/cert/v1/certificate_request", + "description": "Revoke", + "explanation": "Creates a Certificate Revoke Request", + "parameters": [ + { + "required": true, + "name": "data", + "description": "Container object for request specific parameters" + }, + { + "required": true, + "scope": "data", + "name": "cert_request_type", + "description": "add" + }, + { + "required": true, + "scope": "data", + "name": "fid", + "description": "Functional ID" + }, + { + "required": true, + "scope": "data", + "data_type": "STRING(255)", + "name": "reason", + "description": "Reason for action" + }, + { + "required": true, + "scope": "data", + "data_type": "INTEGER", + "name": "serial_number", + "description": "The Serial number of the certificate" + } + ], + "response_fields": [ + + ], + "requests": [ + { + "request_method": "POST", + "request_path": "/api/public/cert/v1/certificate_request", + "request_body": "{\"request\":{\"data\":{\"fid\":\"O000185\",\"cert_request_type\":\"Revoke\",\"reason\":\"No longer needed\",\"serial_number\":\"98210dj38290cjas8f3892jc89813981v\"},\"requested_for\":\"O000182\"}}", + "request_headers": { + "Authorization": "Basic TzAwMDE3OToxMjM0NTY=", + "Accept": "application/json", + "Content-Type": "application/json", + "Host": "example.org", + "Cookie": "" + }, + "request_query_parameters": { + }, + "request_content_type": "application/json", + "response_status": 200, + "response_status_text": "OK", + "response_body": "{\"request_id\":5950}", + "response_headers": {"Content-Type":"application/json; charset=utf-8","Access-Control-Allow-Origin":"*","X-UA-Compatible":"IE=Edge,chrome=1","ETag":"\"6f4e195bd5e0b6a985f55ff6292022ad\"","Cache-Control":"max-age=0, private, must-revalidate","Set-Cookie":"_rsam_test=458eebe723c59ab6a62b08a0a49e345b; domain=.example.org; path=/; HttpOnly","X-Request-Id":"ce9f07d1fc7199bdca0e0665476892e6","X-Runtime":"0.189935","Content-Length":"19"}, + "response_content_type": "application/json; charset=utf-8", + "curl": null +} + ] +} \ No newline at end of file diff --git a/doc/api/index.json b/doc/api/index.json new file mode 100644 index 0000000..554b04e --- /dev/null +++ b/doc/api/index.json @@ -0,0 +1,106 @@ +{ + "resources": [ + { + "name": "Certificate", + "explanation": "Public API endpoints for requesting actions for certificates", + "examples": [ + { + "description": "Add", + "link": "certificate/add.json", + "groups": "public", + "route": "/api/public/cert/v1/certificate", + "method": "post" + }, + { + "description": "Renew", + "link": "certificate/renew.json", + "groups": "public", + "route": "/api/public/cert/v1/certificate", + "method": "post" + }, + { + "description": "Replace", + "link": "certificate/replace.json", + "groups": "public", + "route": "/api/public/cert/v1/certificate", + "method": "post" + }, + { + "description": "Revoke", + "link": "certificate/revoke.json", + "groups": "public", + "route": "/api/public/cert/v1/certificate", + "method": "post" + } + ] + }, + { + "name": "Application", + "explanation": "Public API endpoints for creating Applications", + "examples": [ + { + "description": "Create", + "link": "application/create.json", + "groups": "public", + "route": "api/public/asset/v1/application", + "method": "post" + } + ] + }, + { + "name": "Request Status", + "explanation": "Retrieves the current status of the given Request ID", + "examples": [ + { + "description": "API Response Codes and Messages", + "link": "request_status/api_response_codes_and_messages.json", + "groups": "public", + "route": "/api/public/request_status/:id", + "method": "get" + }, + { + "description": "Error1", + "link": "request_status/error1.json", + "groups": "public", + "route": "/api/public/request_status/:id", + "method": "get" + }, + { + "description": "Error2", + "link": "request_status/error2.json", + "groups": "public", + "route": "/api/public/request_status/:id", + "method": "get" + }, + { + "description": "Error3", + "link": "request_status/error3.json", + "groups": "public", + "route": "/api/public/request_status/:id", + "method": "get" + }, + { + "description": "Error4", + "link": "request_status/error4.json", + "groups": "public", + "route": "/api/public/request_status/:id", + "method": "get" + }, + { + "description": "Success1", + "link": "request_status/success1.json", + "groups": "public", + "route": "/api/public/request_status/:id", + "method": "get" + }, + { + "description": "Success2", + "link": "request_status/success2.json", + "groups": "public", + "route": "/api/public/request_status/:id", + "method": "get" + } + ] + } + ] +} \ No newline at end of file diff --git a/doc/api/request_status/api_response_codes_and_messages.json b/doc/api/request_status/api_response_codes_and_messages.json new file mode 100644 index 0000000..02e72cb --- /dev/null +++ b/doc/api/request_status/api_response_codes_and_messages.json @@ -0,0 +1,17 @@ +{ + "resource": "Request Status", + "resource_explanation": "Retrieves the current status of the given Request ID", + "http_method": "GET", + "route": "/api/public/request_status/:id", + "description": "API Response Codes and Messages", + "explanation": "1000: Request %{id} was successfully created.
2000: Missing Parameter: %{param}
2001: Invalid Parameter: %{param}
2002: An unexpected error occurred: %{message}
2003: Request %{id} not found
3000: this is a placeholder, replace with your own
", + "parameters": [ + + ], + "response_fields": [ + + ], + "requests": [ + + ] +} \ No newline at end of file diff --git a/doc/api/request_status/error1.json b/doc/api/request_status/error1.json new file mode 100644 index 0000000..f4bec19 --- /dev/null +++ b/doc/api/request_status/error1.json @@ -0,0 +1,41 @@ +{ + "resource": "Request Status", + "resource_explanation": "Retrieves the current status of the given Request ID", + "http_method": "GET", + "route": "/api/public/request_status/:id", + "description": "Error1", + "explanation": "This happens when an invalid System Request ID is passed in.", + "parameters": [ + { + "required": true, + "name": "id", + "description": "This is the ID of the request. Is either a system request id (e.g. 12345), or a system request id followed by an ordinal representing which Request Item (e.g. 12345-2)" + } + ], + "response_fields": [ + + ], + "requests": [ + { + "request_method": "GET", + "request_path": "/api/public/request_status/12345", + "request_body": null, + "request_headers": { + "Authorization": "Basic TzAwMDA2ODoxMjM0NTY=", + "Accept": "application/json", + "Content-Type": "application/json", + "Host": "example.org", + "Cookie": "" + }, + "request_query_parameters": { + }, + "request_content_type": "application/json", + "response_status": 200, + "response_status_text": "OK", + "response_body": "{\"success\":false,\"errors\":[{\"code\":2003,\"message\":\"Request 12345 not found\"}]}", + "response_headers": {"Content-Type":"application/json; charset=utf-8","Access-Control-Allow-Origin":"*","X-UA-Compatible":"IE=Edge,chrome=1","ETag":"\"da5c6070651a7ef5f18de9a7db32b4a9\"","Cache-Control":"max-age=0, private, must-revalidate","Set-Cookie":"_rsam_test=59b0d8736458d54d8c6123dd737b7bd5; domain=.example.org; path=/; HttpOnly","X-Request-Id":"77c72ebe094b52d68a23d490281ad05d","X-Runtime":"0.033441","Content-Length":"78"}, + "response_content_type": "application/json; charset=utf-8", + "curl": null +} + ] +} \ No newline at end of file diff --git a/doc/api/request_status/error2.json b/doc/api/request_status/error2.json new file mode 100644 index 0000000..6434478 --- /dev/null +++ b/doc/api/request_status/error2.json @@ -0,0 +1,41 @@ +{ + "resource": "Request Status", + "resource_explanation": "Retrieves the current status of the given Request ID", + "http_method": "GET", + "route": "/api/public/request_status/:id", + "description": "Error2", + "explanation": "This happens when an invalid ID and/or Ordinal is passed in.", + "parameters": [ + { + "required": true, + "name": "id", + "description": "This is the ID of the request. Is either a system request id (e.g. 12345), or a system request id followed by an ordinal representing which Request Item (e.g. 12345-2)" + } + ], + "response_fields": [ + + ], + "requests": [ + { + "request_method": "GET", + "request_path": "/api/public/request_status/5943-9999", + "request_body": null, + "request_headers": { + "Authorization": "Basic TzAwMDAzODoxMjM0NTY=", + "Accept": "application/json", + "Content-Type": "application/json", + "Host": "example.org", + "Cookie": "" + }, + "request_query_parameters": { + }, + "request_content_type": "application/json", + "response_status": 200, + "response_status_text": "OK", + "response_body": "{\"success\":false,\"errors\":[{\"code\":2003,\"message\":\"Request 5943-9999 not found\"}]}", + "response_headers": {"Content-Type":"application/json; charset=utf-8","Access-Control-Allow-Origin":"*","X-UA-Compatible":"IE=Edge,chrome=1","ETag":"\"b710bc46ded310334fe4885326aed80d\"","Cache-Control":"max-age=0, private, must-revalidate","Set-Cookie":"_rsam_test=52ae5341c3b23aeaea2066d2b32da3fb; domain=.example.org; path=/; HttpOnly","X-Request-Id":"f4d18f47b77ec60d4136ae8ee4b99990","X-Runtime":"0.035163","Content-Length":"82"}, + "response_content_type": "application/json; charset=utf-8", + "curl": null +} + ] +} \ No newline at end of file diff --git a/doc/api/request_status/error3.json b/doc/api/request_status/error3.json new file mode 100644 index 0000000..1734fac --- /dev/null +++ b/doc/api/request_status/error3.json @@ -0,0 +1,41 @@ +{ + "resource": "Request Status", + "resource_explanation": "Retrieves the current status of the given Request ID", + "http_method": "GET", + "route": "/api/public/request_status/:id", + "description": "Error3", + "explanation": "This is included for troubleshooting only, and should be handled just in case.", + "parameters": [ + { + "required": true, + "name": "id", + "description": "This is the ID of the request. Is either a system request id (e.g. 12345), or a system request id followed by an ordinal representing which Request Item (e.g. 12345-2)" + } + ], + "response_fields": [ + + ], + "requests": [ + { + "request_method": "GET", + "request_path": "/api/public/request_status/5945", + "request_body": null, + "request_headers": { + "Authorization": "Basic TzAwMDA1ODoxMjM0NTY=", + "Accept": "application/json", + "Content-Type": "application/json", + "Host": "example.org", + "Cookie": "" + }, + "request_query_parameters": { + }, + "request_content_type": "application/json", + "response_status": 200, + "response_status_text": "OK", + "response_body": "{\"success\":false,\"errors\":[{\"code\":2002,\"message\":\"An unexpected error occurred: #\\u003CRuntimeError: error message goes here\\u003E\"}]}", + "response_headers": {"Content-Type":"application/json; charset=utf-8","Access-Control-Allow-Origin":"*","X-UA-Compatible":"IE=Edge,chrome=1","ETag":"\"5cf0eeeea7af5a020634bb0ef121d525\"","Cache-Control":"max-age=0, private, must-revalidate","Set-Cookie":"_rsam_test=fdf4620a74957320a1f18fcc301d71b3; domain=.example.org; path=/; HttpOnly","X-Request-Id":"a42e779665552e18f9aec090f32afbe0","X-Runtime":"0.034700","Content-Length":"135"}, + "response_content_type": "application/json; charset=utf-8", + "curl": null +} + ] +} \ No newline at end of file diff --git a/doc/api/request_status/error4.json b/doc/api/request_status/error4.json new file mode 100644 index 0000000..dffe7e7 --- /dev/null +++ b/doc/api/request_status/error4.json @@ -0,0 +1,41 @@ +{ + "resource": "Request Status", + "resource_explanation": "Retrieves the current status of the given Request ID", + "http_method": "GET", + "route": "/api/public/request_status/:id", + "description": "Error4", + "explanation": "The Rsam team needs to enable this API before it will work.", + "parameters": [ + { + "required": true, + "name": "id", + "description": "This is the ID of the request. Is either a system request id (e.g. 12345), or a system request id followed by an ordinal representing which Request Item (e.g. 12345-2)" + } + ], + "response_fields": [ + + ], + "requests": [ + { + "request_method": "GET", + "request_path": "/api/public/request_status/5941", + "request_body": null, + "request_headers": { + "Authorization": "Basic TzAwMDAxODoxMjM0NTY=", + "Accept": "application/json", + "Content-Type": "application/json", + "Host": "example.org", + "Cookie": "" + }, + "request_query_parameters": { + }, + "request_content_type": "application/json", + "response_status": 403, + "response_status_text": "Forbidden", + "response_body": " ", + "response_headers": {"Content-Type":"text/html; charset=utf-8","Access-Control-Allow-Origin":"*","X-UA-Compatible":"IE=Edge,chrome=1","Cache-Control":"no-cache","Set-Cookie":"_rsam_test=baeff0fe7459482077f83f69c85a3e5b; domain=.example.org; path=/; HttpOnly","X-Request-Id":"44662f56c32db7e51849b2bc86a46e15","X-Runtime":"0.074223","Content-Length":"1"}, + "response_content_type": "text/html; charset=utf-8", + "curl": null +} + ] +} \ No newline at end of file diff --git a/doc/api/request_status/success1.json b/doc/api/request_status/success1.json new file mode 100644 index 0000000..86b70ef --- /dev/null +++ b/doc/api/request_status/success1.json @@ -0,0 +1,41 @@ +{ + "resource": "Request Status", + "resource_explanation": "Retrieves the current status of the given Request ID", + "http_method": "GET", + "route": "/api/public/request_status/:id", + "description": "Success1", + "explanation": null, + "parameters": [ + { + "required": true, + "name": "id", + "description": "This is the ID of the request. Is either a system request id (e.g. 12345), or a system request id followed by an ordinal representing which Request Item (e.g. 12345-2)" + } + ], + "response_fields": [ + + ], + "requests": [ + { + "request_method": "GET", + "request_path": "/api/public/request_status/5946", + "request_body": null, + "request_headers": { + "Authorization": "Basic TzAwMDA3MToxMjM0NTY=", + "Accept": "application/json", + "Content-Type": "application/json", + "Host": "example.org", + "Cookie": "" + }, + "request_query_parameters": { + }, + "request_content_type": "application/json", + "response_status": 200, + "response_status_text": "OK", + "response_body": "{\"success\":true,\"errors\":[],\"request_status\":\"UnSubmitted\"}", + "response_headers": {"Content-Type":"application/json; charset=utf-8","Access-Control-Allow-Origin":"*","X-UA-Compatible":"IE=Edge,chrome=1","ETag":"\"5c471916fb8e0e76946b9425b8ef3ae0\"","Cache-Control":"max-age=0, private, must-revalidate","Set-Cookie":"_rsam_test=e04de0377a46b070a34bb0b4af49f162; domain=.example.org; path=/; HttpOnly","X-Request-Id":"1fc5c9732ca4afc697b1b2ee11e31cf2","X-Runtime":"0.031892","Content-Length":"59"}, + "response_content_type": "application/json; charset=utf-8", + "curl": null +} + ] +} \ No newline at end of file diff --git a/doc/api/request_status/success2.json b/doc/api/request_status/success2.json new file mode 100644 index 0000000..a9b28ad --- /dev/null +++ b/doc/api/request_status/success2.json @@ -0,0 +1,41 @@ +{ + "resource": "Request Status", + "resource_explanation": "Retrieves the current status of the given Request ID", + "http_method": "GET", + "route": "/api/public/request_status/:id", + "description": "Success2", + "explanation": null, + "parameters": [ + { + "required": true, + "name": "id", + "description": "This is the ID of the request. Is either a system request id (e.g. 12345), or a system request id followed by an ordinal representing which Request Item (e.g. 12345-2)" + } + ], + "response_fields": [ + + ], + "requests": [ + { + "request_method": "GET", + "request_path": "/api/public/request_status/5944-2", + "request_body": null, + "request_headers": { + "Authorization": "Basic TzAwMDA0ODoxMjM0NTY=", + "Accept": "application/json", + "Content-Type": "application/json", + "Host": "example.org", + "Cookie": "" + }, + "request_query_parameters": { + }, + "request_content_type": "application/json", + "response_status": 200, + "response_status_text": "OK", + "response_body": "{\"success\":true,\"errors\":[],\"request_status\":\"Complete\"}", + "response_headers": {"Content-Type":"application/json; charset=utf-8","Access-Control-Allow-Origin":"*","X-UA-Compatible":"IE=Edge,chrome=1","ETag":"\"a3f429e659dcc6c08a2a3dc31ea1dc37\"","Cache-Control":"max-age=0, private, must-revalidate","Set-Cookie":"_rsam_test=7651cd81d87bba8eb94bad9dbdce94e8; domain=.example.org; path=/; HttpOnly","X-Request-Id":"87a99abe53a1abccde2c769131c2998a","X-Runtime":"0.033075","Content-Length":"56"}, + "response_content_type": "application/json; charset=utf-8", + "curl": null +} + ] +} \ No newline at end of file