Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
EXEC sp_OASetProperty @http, 'BasicAuth', 1
EXEC sp_OASetProperty @http, 'Login', '{{secretId}}'
EXEC sp_OASetProperty @http, 'Password', '{{secretPassword}}'
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://domain.com/api/tax-status/:id/', @sbResponseBody
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
RETURN
END
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @http, 'LastStatus', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @http, 'LastHeader', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)
-- {
-- "id": "<uuid>",
-- "link": "<uuid>",
-- "collected_at": "<dateTime>",
-- "place_and_date_of_issuance": "<string>",
-- "official_name": "<string>",
-- "id_cif": "<string>",
-- "tax_payer_information": {
-- "rfc": "<string>",
-- "curp": "<string>",
-- "name": "<string>",
-- "first_last_name": "<string>",
-- "second_last_name": "<string>",
-- "start_operations_date": "<string>",
-- "status_padron": "<string>",
-- "last_status_change_date": "<string>",
-- "commercial_name": "<string>",
-- "social_name": "<string>",
-- "email": "<string>",
-- "phone": "<string>"
-- },
-- "address": {
-- "postal_code": "<string>",
-- "street_type": "<string>",
-- "street": "<string>",
-- "exterior_number": "<string>",
-- "interior_number": "<string>",
-- "suburb": "<string>",
-- "locality": "<string>",
-- "municipality": "<string>",
-- "state": "<string>",
-- "between_street": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- },
-- "economic_activity": [
-- {
-- "economic_activity": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "end_date": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "initial_date": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "order": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "percentage": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- },
-- {
-- "economic_activity": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "end_date": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "initial_date": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "order": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "percentage": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- }
-- ],
-- "regimens": [
-- {
-- "end_date": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "initial_date": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "regimen": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- },
-- {
-- "end_date": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "initial_date": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "regimen": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- }
-- ],
-- "obligations": {
-- "obligation": "<string>",
-- "expiration": "<string>",
-- "initial_date": "<string>",
-- "end_date": "<string>"
-- },
-- "personal_information": "<object>",
-- "digital_stamp": "<string>",
-- "digital_stamp_chain": "<string>",
-- "pdf": "<binary>"
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @economic_activityValue nvarchar(4000)
DECLARE @end_dateValue nvarchar(4000)
DECLARE @initial_dateValue nvarchar(4000)
DECLARE @orderValue nvarchar(4000)
DECLARE @percentageValue nvarchar(4000)
DECLARE @regimenValue nvarchar(4000)
DECLARE @id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'id'
DECLARE @link nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @link OUT, 'link'
DECLARE @collected_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @collected_at OUT, 'collected_at'
DECLARE @place_and_date_of_issuance nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @place_and_date_of_issuance OUT, 'place_and_date_of_issuance'
DECLARE @official_name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @official_name OUT, 'official_name'
DECLARE @id_cif nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @id_cif OUT, 'id_cif'
DECLARE @Rfc nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Rfc OUT, 'tax_payer_information.rfc'
DECLARE @Curp nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Curp OUT, 'tax_payer_information.curp'
DECLARE @Name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Name OUT, 'tax_payer_information.name'
DECLARE @First_last_name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @First_last_name OUT, 'tax_payer_information.first_last_name'
DECLARE @Second_last_name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Second_last_name OUT, 'tax_payer_information.second_last_name'
DECLARE @Start_operations_date nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Start_operations_date OUT, 'tax_payer_information.start_operations_date'
DECLARE @Status_padron nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Status_padron OUT, 'tax_payer_information.status_padron'
DECLARE @Last_status_change_date nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Last_status_change_date OUT, 'tax_payer_information.last_status_change_date'
DECLARE @Commercial_name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Commercial_name OUT, 'tax_payer_information.commercial_name'
DECLARE @Social_name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Social_name OUT, 'tax_payer_information.social_name'
DECLARE @v_Email nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Email OUT, 'tax_payer_information.email'
DECLARE @Phone nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Phone OUT, 'tax_payer_information.phone'
DECLARE @Postal_code nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Postal_code OUT, 'address.postal_code'
DECLARE @Street_type nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Street_type OUT, 'address.street_type'
DECLARE @Street nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Street OUT, 'address.street'
DECLARE @Exterior_number nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Exterior_number OUT, 'address.exterior_number'
DECLARE @Interior_number nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Interior_number OUT, 'address.interior_number'
DECLARE @Suburb nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Suburb OUT, 'address.suburb'
DECLARE @Locality nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Locality OUT, 'address.locality'
DECLARE @Municipality nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Municipality OUT, 'address.municipality'
DECLARE @State nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @State OUT, 'address.state'
DECLARE @Value nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Value OUT, 'address.between_street.value'
DECLARE @Obligation nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Obligation OUT, 'obligations.obligation'
DECLARE @Expiration nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Expiration OUT, 'obligations.expiration'
DECLARE @Initial_date nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Initial_date OUT, 'obligations.initial_date'
DECLARE @End_date nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @End_date OUT, 'obligations.end_date'
DECLARE @personal_information nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @personal_information OUT, 'personal_information'
DECLARE @digital_stamp nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @digital_stamp OUT, 'digital_stamp'
DECLARE @digital_stamp_chain nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @digital_stamp_chain OUT, 'digital_stamp_chain'
DECLARE @pdf nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @pdf OUT, 'pdf'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'economic_activity'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @economic_activityValue OUT, 'economic_activity[i].economic_activity.value'
EXEC sp_OAMethod @jResp, 'StringOf', @end_dateValue OUT, 'economic_activity[i].end_date.value'
EXEC sp_OAMethod @jResp, 'StringOf', @initial_dateValue OUT, 'economic_activity[i].initial_date.value'
EXEC sp_OAMethod @jResp, 'StringOf', @orderValue OUT, 'economic_activity[i].order.value'
EXEC sp_OAMethod @jResp, 'StringOf', @percentageValue OUT, 'economic_activity[i].percentage.value'
SELECT @i = @i + 1
END
SELECT @i = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'regimens'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @end_dateValue OUT, 'regimens[i].end_date.value'
EXEC sp_OAMethod @jResp, 'StringOf', @initial_dateValue OUT, 'regimens[i].initial_date.value'
EXEC sp_OAMethod @jResp, 'StringOf', @regimenValue OUT, 'regimens[i].regimen.value'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -X GET
-u '{{secretId}}:{{secretPassword}}'
https://domain.com/api/tax-status/:id/
Postman Collection Item JSON
{
"name": "Detail",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/tax-status/:id/",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"tax-status",
":id",
""
],
"variable": [
{
"key": "id",
"value": "consequa",
"description": "(Required) The `tax-status.id` you want to get detailed information about."
}
]
},
"description": "Get the details of a specific tax status."
},
"response": [
{
"name": "Ok",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/tax-status/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"tax-status",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n\t\"id\": \"<uuid>\",\n\t\"link\": \"<uuid>\",\n\t\"collected_at\": \"<dateTime>\",\n\t\"place_and_date_of_issuance\": \"<string>\",\n\t\"official_name\": \"<string>\",\n\t\"id_cif\": \"<string>\",\n\t\"tax_payer_information\": {\n\t\t\"rfc\": \"<string>\",\n\t\t\"curp\": \"<string>\",\n\t\t\"name\": \"<string>\",\n\t\t\"first_last_name\": \"<string>\",\n\t\t\"second_last_name\": \"<string>\",\n\t\t\"start_operations_date\": \"<string>\",\n\t\t\"status_padron\": \"<string>\",\n\t\t\"last_status_change_date\": \"<string>\",\n\t\t\"commercial_name\": \"<string>\",\n\t\t\"social_name\": \"<string>\",\n\t\t\"email\": \"<string>\",\n\t\t\"phone\": \"<string>\"\n\t},\n\t\"address\": {\n\t\t\"postal_code\": \"<string>\",\n\t\t\"street_type\": \"<string>\",\n\t\t\"street\": \"<string>\",\n\t\t\"exterior_number\": \"<string>\",\n\t\t\"interior_number\": \"<string>\",\n\t\t\"suburb\": \"<string>\",\n\t\t\"locality\": \"<string>\",\n\t\t\"municipality\": \"<string>\",\n\t\t\"state\": \"<string>\",\n\t\t\"between_street\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t}\n\t},\n\t\"economic_activity\": [\n\t\t{\n\t\t\t\"economic_activity\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"end_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"initial_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"order\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"percentage\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"economic_activity\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"end_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"initial_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"order\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"percentage\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t}\n\t\t}\n\t],\n\t\"regimens\": [\n\t\t{\n\t\t\t\"end_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"initial_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"regimen\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"end_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"initial_date\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"regimen\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t}\n\t\t}\n\t],\n\t\"obligations\": {\n\t\t\"obligation\": \"<string>\",\n\t\t\"expiration\": \"<string>\",\n\t\t\"initial_date\": \"<string>\",\n\t\t\"end_date\": \"<string>\"\n\t},\n\t\"personal_information\": \"<object>\",\n\t\"digital_stamp\": \"<string>\",\n\t\"digital_stamp_chain\": \"<string>\",\n\t\"pdf\": \"<binary>\"\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/tax-status/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"tax-status",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "[\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t},\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t}\n]"
},
{
"name": "Too Many Sessions",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/tax-status/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"tax-status",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "[\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t},\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t}\n]"
}
]
}
