Challenge Overview
Welcome to Topcoder Mobile - Connected Car Swagger Mock Service API Code Challenge
The purpose of this challenge is to create Swagger API Mock Service for the Topcoder Mobile - Connected Car by using Swagger 2.0 Spec.
General Requirements
- The file should be named swagger.yaml
- The spec should written in Swagger 2.0 with YAML format.
- The requests and responses should properly list all fields.
- For responses, you should cover all the cases, not just 200 status code, like 404
- Descriptions should be properly written for APIs, request input and responses etc
- You can use editor.swagger.io for validation
- Create some sample body request for each API paths
Swagger Mock Service API for Topcoder Mobile Connected Cars
Swagger doc should contain definitions for the following:
1). /Customer/Lookup:
- POST of e-mail and Phone number returns firstname lastname when matched
- Data should match 10 digit phone and e-mail format or
- Failure when invalid data or no match
Notes: Customer Model has
-- E-mail,
-- Phone,
-- FirstName,
-- LastName,
-- Street,
-- City,
-- State,
-- Zip
2). /SIM/Lookup:
- POST of Vehicle VIN Number which returns SIM ID when matched
- Data should match standards for ICCID and VIN or
- Failure when invalid data or no match
Notes: SIM Model has
- VIN,
- SIM
3). /PIN/Create:
- POST of phone number and SIM ID returns success or failure
Notes: PIN Model has
Phone,
PIN,
SIM
4). /PIN/Send:
- POST of Phone + SIM ID returns success or failure
5). /PIN/Input:
- POST of 4 digit pin number and Phone Number which returns success or failure
6). /Provisioning:
- POST of SIM ID which returns success or failure
We’ll follow a subjective scorecard (1-10) for this challenge. The submissions will be evaluated on the basis of
- Completeness of Swagger file based on challenge requirements
- Adherence to best practices for designing REST API
Final Submission Guidelines
- Swagger file
- Feel free to include any other document(s) that you think will help coders better understand how to implement the API
The purpose of this challenge is to create Swagger API Mock Service for the Topcoder Mobile - Connected Car by using Swagger 2.0 Spec.
General Requirements
- The file should be named swagger.yaml
- The spec should written in Swagger 2.0 with YAML format.
- The requests and responses should properly list all fields.
- For responses, you should cover all the cases, not just 200 status code, like 404
- Descriptions should be properly written for APIs, request input and responses etc
- You can use editor.swagger.io for validation
- Create some sample body request for each API paths
Swagger Mock Service API for Topcoder Mobile Connected Cars
Swagger doc should contain definitions for the following:
1). /Customer/Lookup:
- POST of e-mail and Phone number returns firstname lastname when matched
- Data should match 10 digit phone and e-mail format or
- Failure when invalid data or no match
Notes: Customer Model has
-- E-mail,
-- Phone,
-- FirstName,
-- LastName,
-- Street,
-- City,
-- State,
-- Zip
2). /SIM/Lookup:
- POST of Vehicle VIN Number which returns SIM ID when matched
- Data should match standards for ICCID and VIN or
- Failure when invalid data or no match
Notes: SIM Model has
- VIN,
- SIM
3). /PIN/Create:
- POST of phone number and SIM ID returns success or failure
Notes: PIN Model has
Phone,
PIN,
SIM
4). /PIN/Send:
- POST of Phone + SIM ID returns success or failure
5). /PIN/Input:
- POST of 4 digit pin number and Phone Number which returns success or failure
6). /Provisioning:
- POST of SIM ID which returns success or failure
Final Submission Guidelines
Scorecard & Review CriteriaWe’ll follow a subjective scorecard (1-10) for this challenge. The submissions will be evaluated on the basis of
- Completeness of Swagger file based on challenge requirements
- Adherence to best practices for designing REST API
Final Submission Guidelines
- Swagger file
- Feel free to include any other document(s) that you think will help coders better understand how to implement the API