{"id":19528517,"url":"https://github.com/orca-scan/orca-lookup-dotnet","last_synced_at":"2026-05-19T09:08:01.106Z","repository":{"id":118403264,"uuid":"302124429","full_name":"orca-scan/orca-lookup-dotnet","owner":"orca-scan","description":"How to respond to an Orca Scan Lookup request using ASP.NET Core","archived":false,"fork":false,"pushed_at":"2021-02-06T21:53:45.000Z","size":50,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-10-23T14:57:45.589Z","etag":null,"topics":["barcode-scanning","csharp","dotnet-core","smartphone"],"latest_commit_sha":null,"homepage":"https://orcascan.com/docs/api/lookup-url","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/orca-scan.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-10-07T18:23:04.000Z","updated_at":"2021-02-06T21:53:47.000Z","dependencies_parsed_at":null,"dependency_job_id":"63c59389-b04c-4e6c-b296-f0702ade24cd","html_url":"https://github.com/orca-scan/orca-lookup-dotnet","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/orca-scan/orca-lookup-dotnet","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orca-scan%2Forca-lookup-dotnet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orca-scan%2Forca-lookup-dotnet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orca-scan%2Forca-lookup-dotnet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orca-scan%2Forca-lookup-dotnet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/orca-scan","download_url":"https://codeload.github.com/orca-scan/orca-lookup-dotnet/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orca-scan%2Forca-lookup-dotnet/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33209534,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-19T07:54:09.561Z","status":"ssl_error","status_checked_at":"2026-05-19T07:54:08.508Z","response_time":58,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["barcode-scanning","csharp","dotnet-core","smartphone"],"created_at":"2024-11-11T01:19:07.783Z","updated_at":"2026-05-19T09:08:01.088Z","avatar_url":"https://github.com/orca-scan.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# orca-lookup-dotnet\n\nThis open source project is a an example of [how to scan barcodes using a smartphone](https://orcascan.com/mobile) and [present data from your system](https://orcascan.com/docs/api/lookup-url) using C# and the [ASP.NET Core](https://dotnet.microsoft.com/learn/aspnet/what-is-aspnet-core) framework.\n\n**How it works:**\n\n1. A user [scans a barcode](https://orcascan.com/mobile) using their smartphone\n2. Orca Scan sends a HTTP GET request to your endpoint with `?barcode=value`\n3. Your system queries a database or internal API for a `barcode` match\n4. Your system returns the data in JSON format with keys matching column names\n5. The [Orca Scan mobile](https://orcascan.com/mobile) app presents that data to the user\n\n*If the mobile user has [update permission](https://orcascan.com/docs/getting-started/adding-users#selecting-user-permissions) and saves the data, it will saved to your Orca sheet.*\n\n## Install\n\nFirst ensure you have [.NET Core 3.1](https://dotnet.microsoft.com/learn/aspnet/hello-world-tutorial/install) installed.\n\n```bash\n# should return 3.1.402 or similar\ndotnet --version\n```\n\nThen execute the following:\n\n```bash\n# download this example code\ngit clone https://github.com/orca-scan/orca-lookup-dotnet.git\n\n# go into the new directory\ncd orca-lookup-dotnet\n\n# install dependencies\ndotnet restore\n```\n\n## Run\n\n```bash\n# start the project\ndotnet run\n```\n\nVisit [http://localhost:5000?barcode=4S3BMHB68B3286050](http://localhost:5000?barcode=4S3BMHB68B3286050) to see the following:\n\n```json\n{\n    \"VIN\": \"4S3BMHB68B3286050\",\n    \"Make\": \"SUBARU\",\n    \"Model\": \"Legacy\",\n    \"Manufacturer Name\": \"FUJI HEAVY INDUSTRIES U.S.A\",\n    \"Vehicle Type\": \"PASSENGER CAR\",\n    \"Year\": 1992\n}\n```\n\n## How this example works\n\nThis project is broken into two parts a [controller](/Controllers/OrcaLookupController.cs) to handle the incoming request:\n\n```csharp\n[HttpGet]\npublic JsonResult Get()\n{\n    // get the incoming barcode sent from Orca Scan (scanned by a user)\n    string barcode = HttpContext.Request.Query[\"barcode\"].ToString();\n\n    // TODO: query a database or API to retrieve some data\n\n    // hydrate model (property names must match column names when serialised)\n    var result = new OrcaLookupModel(){\n        Vin = barcode,\n        Make = \"SUBARU\",\n        Model = \"Legacy\",\n        ManufacturerName = \"FUJI HEAVY INDUSTRIES U.S.A\",\n        VehicleType = \"PASSENGER CAR\",\n        Year = 1992\n    };\n\n    // return data to Orca as a JSON object\n    return new JsonResult(result);\n}\n```\n\nAnd a [model](/Models/OrcaLookupModel.cs) used to return data to Orca Scan in a structure that matches your sheet:\n\n```csharp\n// IMPORTANT: JSON property names must match Orca sheet column names when serialised\npublic class OrcaLookupModel {\n\n    [JsonPropertyName(\"VIN\")]\n    public string Vin { get; set; }\n\n    [JsonPropertyName(\"Make\")]\n    public string Make { get; set; }\n\n    [JsonPropertyName(\"Model\")]\n    public string Model { get; set; }\n\n    [JsonPropertyName(\"Manufacturer Name\")]\n    public string ManufacturerName { get; set; }\n\n    [JsonPropertyName(\"Vehicle Type\")]\n    public string VehicleType { get; set; }\n\n    [JsonPropertyName(\"Year\")]\n    public int Year { get; set; }\n}\n```\n\n## Troubleshooting\n\nIf you run into any issues not listed here, please [open a ticket](https://github.com/orca-scan/orca-lookup-dotnet/issues) and we'll get back to you as soon as we can.\n\n* **The current .NET SDK does not support targeting .NET Core 3.1**\n  This example uses [.NET Core 3.1](https://dotnet.microsoft.com/download/dotnet-core/3.1), upgrade and try again.\n\n## Examples in other langauges\n* [orca-lookup-node](https://github.com/orca-scan/orca-lookup-node)\n* [orca-lookup-go](https://github.com/orca-scan/orca-lookup-go)\n* [orca-lookup-python](https://github.com/orca-scan/orca-lookup-python)\n* [orca-lookup-php](https://github.com/orca-scan/orca-lookup-php)\n* [orca-lookup-java](https://github.com/orca-scan/orca-lookup-java)\n\n## History\n\nFor change-log, check [releases](https://github.com/orca-scan/orca-lookup-dotnet/releases).\n\n## License\n\nLicensed under [MIT License](LICENSE) \u0026copy; Orca Scan - [Barcode Tracking, Simplified.](https://orcascan.com)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Forca-scan%2Forca-lookup-dotnet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Forca-scan%2Forca-lookup-dotnet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Forca-scan%2Forca-lookup-dotnet/lists"}