{ "openapi": "3.0.1", "info": { "title": "BarBan API", "description": "باربان — استعلام بارنامه خودرو تجاری با پلاک", "version": "v1" }, "paths": { "/api/v1/rmto/bol": { "get": { "tags": [ "ApiV1Rmto" ], "summary": "بارنامه با سریال و شماره", "description": "استعلام از سرویس راهداری با کنترل دسترسی، ثبت مصرف و پاسخ استاندارد.\nRequired scope: waybills:read\nUpstream: LoadBillOfLadingByNumber", "parameters": [ { "name": "serial", "in": "query", "description": "سریال بارنامه", "required": true, "schema": { "type": "string" }, "example": "123" }, { "name": "number", "in": "query", "description": "شماره بارنامه", "required": true, "schema": { "type": "integer" }, "example": 123456 }, { "name": "Idempotency-Key", "in": "header", "description": "Reuse for the same API key, endpoint and parameters. In-progress duplicates return 409; completed responses replay without billing.", "schema": { "maxLength": 100, "type": "string" } } ], "responses": { "200": { "description": "Completed inquiry. Usage follows the purchased metering policy. Sandbox data is explicitly marked.", "content": { "application/json": { "schema": { "required": [ "requestId", "found" ], "type": "object", "properties": { "requestId": { "type": "string" }, "found": { "type": "boolean" }, "sandbox": { "type": "boolean", "description": "True only for test keys; no live upstream inquiry. Quota consumption follows the purchased sandbox and metering policy." }, "data": { "anyOf": [ { "type": "object", "properties": { "ChangeStatusDate": { "type": "object", "properties": { "Day": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "Month": { "type": "integer", "description": "فیلد قرارداد راهداری", "nullable": true }, "Year": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "Company": { "type": "object", "properties": { "Branch": { "type": "object", "properties": { "ID": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int64" }, "Name": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "Code": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "LOCATION": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "Name": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NationalCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int64" }, "SARASARY": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "CompanyCommission": { "type": "number", "description": "فیلد قرارداد راهداری" }, "CompanyCommissionPercent": { "type": "number", "description": "فیلد قرارداد راهداری" }, "Cost": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int64" }, "CustomInfo": { "type": "object", "properties": { "Code": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "KootajDate": { "type": "string", "description": "فیلد قرارداد راهداری", "format": "date-time" }, "KootajNo": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "Description": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "DestinationCityCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "DestinationCityName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "DischargeCost": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "DriverCommission": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "FirstDriver": { "type": "object", "properties": { "BirthCityCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "BirthCityName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "CardNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "CardValidationDate": { "type": "object", "properties": { "Day": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "Month": { "type": "integer", "description": "فیلد قرارداد راهداری", "nullable": true }, "Year": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "CertifcateIssueCityCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "CertifcateIssueCityName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "CertifcateNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Driver_Type": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Family": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "FatherName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "IdentifierNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "InsuranceBranch": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "InsuranceId": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "IsActive": { "type": "boolean", "description": "فیلد قرارداد راهداری" }, "Mobile": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NOVE_GAVAHINAMEH": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Name": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NationalId": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "TARIKH_ETEBAR_KART_SALAMAT": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "Freighter": { "type": "object", "properties": { "BARGIR_ID": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int64" }, "CardNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "IsActive": { "type": "boolean", "description": "فیلد قرارداد راهداری" }, "LOADER_LINK_TYPE": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "LoadingTypeCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "LoadingTypeTitle": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "MadeYear": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "Mobile": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NOVE_GAVAHINAMEH": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NOVE_NAVGAN_BARI": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "PlaqueCityCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "PlaqueCityName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "PlaqueNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "PlaqueSerialNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "PlaqueType": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "TARIKH_ETEBAR_MOAYENE_FANI": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "VINCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "YearType": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "GoodInfoList": { "type": "array", "items": { "type": "object", "properties": { "GoodTitle": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "GoodTypeCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "HSCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "HSTarrifTitle": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "IranCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "MeghdareTabieiLitr": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "PackingTitle": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "PackingTypeCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "Value": { "type": "number", "description": "فیلد قرارداد راهداری" }, "VazneMakhsoos": { "type": "number", "description": "فیلد قرارداد راهداری" }, "Weight": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" } } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "InsuranceCompany": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "InsuranceCost": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int64" }, "InsuranceNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "IssuDate": { "type": "object", "properties": { "Day": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "Month": { "type": "integer", "description": "فیلد قرارداد راهداری", "nullable": true }, "Year": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "IssueTime": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "KalaDesc": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "LanderTitle": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "LanderTypeCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "LoadingCost": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "MasterBillofLadingTraceCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Number": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int64" }, "OriginCityCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "OriginCityName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "PayanehCost": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "Serial": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Status": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Tax": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "TotalCost": { "type": "number", "description": "فیلد قرارداد راهداری" }, "TransitTypeTitle": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Receiver": { "type": "object", "properties": { "Name": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NationalCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "PostalCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "LastName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "ReceiverAddress": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Robari": { "type": "boolean", "description": "فیلد قرارداد راهداری" }, "Sender": { "type": "object", "properties": { "Name": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NationalCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "PostalCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "LastName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "SenderAddress": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "ShomarehHavalehAnbarNaft": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int64" }, "TraceCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "TransitTypecode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "WeighbridgeCost": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "secondDriver": { "type": "object", "properties": { "BirthCityCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "BirthCityName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "CardNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "CardValidationDate": { "type": "object", "properties": { "Day": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "Month": { "type": "integer", "description": "فیلد قرارداد راهداری", "nullable": true }, "Year": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "CertifcateIssueCityCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "CertifcateIssueCityName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "CertifcateNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Driver_Type": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Family": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "FatherName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "IdentifierNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "InsuranceBranch": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "InsuranceId": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "IsActive": { "type": "boolean", "description": "فیلد قرارداد راهداری" }, "Mobile": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NOVE_GAVAHINAMEH": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Name": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NationalId": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "TARIKH_ETEBAR_KART_SALAMAT": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } }, "description": "فیلد قرارداد راهداری", "nullable": true } }, "nullable": true }, { "required": [ "sandbox" ], "type": "object", "properties": { "sandbox": { "type": "boolean" }, "service": { "type": "string" }, "message": { "type": "string" } } } ], "nullable": true }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } } } } } }, "401": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "402": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "403": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "409": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "422": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "429": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "502": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "503": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "504": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/rmto/bol/all": { "get": { "tags": [ "ApiV1Rmto" ], "summary": "تمام بارنامه‌های یک شماره و سریال", "description": "استعلام از سرویس راهداری با کنترل دسترسی، ثبت مصرف و پاسخ استاندارد.\nRequired scope: waybills:read\nUpstream: LoadAllBillOfLadingByNumber", "parameters": [ { "name": "number", "in": "query", "description": "شماره بارنامه", "required": true, "schema": { "type": "integer" }, "example": 123456 }, { "name": "serial", "in": "query", "description": "سریال بارنامه مطابق قرارداد راهداری؛ ورودی قدیمی بدون سریال با مقدار خالی ارسال می‌شود و پذیرش آن تضمین نشده است.", "schema": { "type": "string" }, "example": "123" }, { "name": "Idempotency-Key", "in": "header", "description": "Reuse for the same API key, endpoint and parameters. In-progress duplicates return 409; completed responses replay without billing.", "schema": { "maxLength": 100, "type": "string" } } ], "responses": { "200": { "description": "Completed inquiry. Usage follows the purchased metering policy. Sandbox data is explicitly marked.", "content": { "application/json": { "schema": { "required": [ "requestId", "found" ], "type": "object", "properties": { "requestId": { "type": "string" }, "found": { "type": "boolean" }, "sandbox": { "type": "boolean", "description": "True only for test keys; no live upstream inquiry. Quota consumption follows the purchased sandbox and metering policy." }, "data": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "ChangeStatusDate": { "type": "object", "properties": { "Day": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "Month": { "type": "integer", "description": "فیلد قرارداد راهداری", "nullable": true }, "Year": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "Company": { "type": "object", "properties": { "Branch": { "type": "object", "properties": { "ID": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int64" }, "Name": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "Code": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "LOCATION": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "Name": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NationalCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int64" }, "SARASARY": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "CompanyCommission": { "type": "number", "description": "فیلد قرارداد راهداری" }, "CompanyCommissionPercent": { "type": "number", "description": "فیلد قرارداد راهداری" }, "Cost": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int64" }, "CustomInfo": { "type": "object", "properties": { "Code": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "KootajDate": { "type": "string", "description": "فیلد قرارداد راهداری", "format": "date-time" }, "KootajNo": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "Description": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "DestinationCityCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "DestinationCityName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "DischargeCost": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "DriverCommission": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "FirstDriver": { "type": "object", "properties": { "BirthCityCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "BirthCityName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "CardNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "CardValidationDate": { "type": "object", "properties": { "Day": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "Month": { "type": "integer", "description": "فیلد قرارداد راهداری", "nullable": true }, "Year": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "CertifcateIssueCityCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "CertifcateIssueCityName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "CertifcateNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Driver_Type": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Family": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "FatherName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "IdentifierNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "InsuranceBranch": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "InsuranceId": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "IsActive": { "type": "boolean", "description": "فیلد قرارداد راهداری" }, "Mobile": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NOVE_GAVAHINAMEH": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Name": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NationalId": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "TARIKH_ETEBAR_KART_SALAMAT": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "Freighter": { "type": "object", "properties": { "BARGIR_ID": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int64" }, "CardNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "IsActive": { "type": "boolean", "description": "فیلد قرارداد راهداری" }, "LOADER_LINK_TYPE": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "LoadingTypeCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "LoadingTypeTitle": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "MadeYear": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "Mobile": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NOVE_GAVAHINAMEH": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NOVE_NAVGAN_BARI": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "PlaqueCityCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "PlaqueCityName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "PlaqueNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "PlaqueSerialNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "PlaqueType": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "TARIKH_ETEBAR_MOAYENE_FANI": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "VINCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "YearType": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "GoodInfoList": { "type": "array", "items": { "type": "object", "properties": { "GoodTitle": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "GoodTypeCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "HSCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "HSTarrifTitle": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "IranCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "MeghdareTabieiLitr": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "PackingTitle": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "PackingTypeCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "Value": { "type": "number", "description": "فیلد قرارداد راهداری" }, "VazneMakhsoos": { "type": "number", "description": "فیلد قرارداد راهداری" }, "Weight": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" } } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "InsuranceCompany": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "InsuranceCost": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int64" }, "InsuranceNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "IssuDate": { "type": "object", "properties": { "Day": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "Month": { "type": "integer", "description": "فیلد قرارداد راهداری", "nullable": true }, "Year": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "IssueTime": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "KalaDesc": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "LanderTitle": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "LanderTypeCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "LoadingCost": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "MasterBillofLadingTraceCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Number": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int64" }, "OriginCityCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "OriginCityName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "PayanehCost": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "Serial": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Status": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Tax": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "TotalCost": { "type": "number", "description": "فیلد قرارداد راهداری" }, "TransitTypeTitle": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Receiver": { "type": "object", "properties": { "Name": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NationalCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "PostalCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "LastName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "ReceiverAddress": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Robari": { "type": "boolean", "description": "فیلد قرارداد راهداری" }, "Sender": { "type": "object", "properties": { "Name": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NationalCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "PostalCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "LastName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "SenderAddress": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "ShomarehHavalehAnbarNaft": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int64" }, "TraceCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "TransitTypecode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "WeighbridgeCost": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "secondDriver": { "type": "object", "properties": { "BirthCityCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "BirthCityName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "CardNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "CardValidationDate": { "type": "object", "properties": { "Day": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "Month": { "type": "integer", "description": "فیلد قرارداد راهداری", "nullable": true }, "Year": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "CertifcateIssueCityCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "CertifcateIssueCityName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "CertifcateNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Driver_Type": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Family": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "FatherName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "IdentifierNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "InsuranceBranch": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "InsuranceId": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "IsActive": { "type": "boolean", "description": "فیلد قرارداد راهداری" }, "Mobile": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NOVE_GAVAHINAMEH": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Name": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NationalId": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "TARIKH_ETEBAR_KART_SALAMAT": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } }, "description": "فیلد قرارداد راهداری", "nullable": true } } }, "nullable": true }, { "required": [ "sandbox" ], "type": "object", "properties": { "sandbox": { "type": "boolean" }, "service": { "type": "string" }, "message": { "type": "string" } } } ], "nullable": true }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } } } } } }, "401": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "402": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "403": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "409": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "422": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "429": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "502": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "503": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "504": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/rmto/driver/card": { "get": { "tags": [ "ApiV1Rmto" ], "summary": "راننده با کارت هوشمند", "description": "استعلام از سرویس راهداری با کنترل دسترسی، ثبت مصرف و پاسخ استاندارد.\nRequired scope: drivers:read\nUpstream: GetDriverBySmartCardNo", "parameters": [ { "name": "cardNo", "in": "query", "description": "شماره کارت هوشمند راننده", "required": true, "schema": { "type": "string" }, "example": "1234567" }, { "name": "Idempotency-Key", "in": "header", "description": "Reuse for the same API key, endpoint and parameters. In-progress duplicates return 409; completed responses replay without billing.", "schema": { "maxLength": 100, "type": "string" } } ], "responses": { "200": { "description": "Completed inquiry. Usage follows the purchased metering policy. Sandbox data is explicitly marked.", "content": { "application/json": { "schema": { "required": [ "requestId", "found" ], "type": "object", "properties": { "requestId": { "type": "string" }, "found": { "type": "boolean" }, "sandbox": { "type": "boolean", "description": "True only for test keys; no live upstream inquiry. Quota consumption follows the purchased sandbox and metering policy." }, "data": { "anyOf": [ { "type": "object", "properties": { "BirthCityCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "BirthCityName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "CardNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "CardValidationDate": { "type": "object", "properties": { "Day": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "Month": { "type": "integer", "description": "فیلد قرارداد راهداری", "nullable": true }, "Year": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "CertifcateIssueCityCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "CertifcateIssueCityName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "CertifcateNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Driver_Type": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Family": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "FatherName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "IdentifierNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "InsuranceBranch": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "InsuranceId": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "IsActive": { "type": "boolean", "description": "فیلد قرارداد راهداری" }, "Mobile": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NOVE_GAVAHINAMEH": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Name": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NationalId": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "TARIKH_ETEBAR_KART_SALAMAT": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } }, "nullable": true }, { "required": [ "sandbox" ], "type": "object", "properties": { "sandbox": { "type": "boolean" }, "service": { "type": "string" }, "message": { "type": "string" } } } ], "nullable": true }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } } } } } }, "401": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "402": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "403": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "409": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "422": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "429": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "502": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "503": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "504": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/rmto/driver/national-id": { "get": { "tags": [ "ApiV1Rmto" ], "summary": "راننده با کد ملی", "description": "استعلام از سرویس راهداری با کنترل دسترسی، ثبت مصرف و پاسخ استاندارد.\nRequired scope: drivers:read\nUpstream: GetDriverByNational_ID", "parameters": [ { "name": "nationalId", "in": "query", "description": "کد ملی ده رقمی راننده", "required": true, "schema": { "type": "string" }, "example": "1234567890" }, { "name": "Idempotency-Key", "in": "header", "description": "Reuse for the same API key, endpoint and parameters. In-progress duplicates return 409; completed responses replay without billing.", "schema": { "maxLength": 100, "type": "string" } } ], "responses": { "200": { "description": "Completed inquiry. Usage follows the purchased metering policy. Sandbox data is explicitly marked.", "content": { "application/json": { "schema": { "required": [ "requestId", "found" ], "type": "object", "properties": { "requestId": { "type": "string" }, "found": { "type": "boolean" }, "sandbox": { "type": "boolean", "description": "True only for test keys; no live upstream inquiry. Quota consumption follows the purchased sandbox and metering policy." }, "data": { "anyOf": [ { "type": "object", "properties": { "BirthCityCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "BirthCityName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "CardNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "CardValidationDate": { "type": "object", "properties": { "Day": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "Month": { "type": "integer", "description": "فیلد قرارداد راهداری", "nullable": true }, "Year": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "CertifcateIssueCityCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "CertifcateIssueCityName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "CertifcateNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Driver_Type": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Family": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "FatherName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "IdentifierNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "InsuranceBranch": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "InsuranceId": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "IsActive": { "type": "boolean", "description": "فیلد قرارداد راهداری" }, "Mobile": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NOVE_GAVAHINAMEH": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Name": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NationalId": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "TARIKH_ETEBAR_KART_SALAMAT": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } }, "nullable": true }, { "required": [ "sandbox" ], "type": "object", "properties": { "sandbox": { "type": "boolean" }, "service": { "type": "string" }, "message": { "type": "string" } } } ], "nullable": true }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } } } } } }, "401": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "402": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "403": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "409": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "422": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "429": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "502": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "503": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "504": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/rmto/freighter/card": { "get": { "tags": [ "ApiV1Rmto" ], "summary": "اطلاعات کامل ناوگان", "description": "استعلام از سرویس راهداری با کنترل دسترسی، ثبت مصرف و پاسخ استاندارد.\nRequired scope: freighters:read\nUpstream: GetFreighterBySmartCardNoFull", "parameters": [ { "name": "cardNo", "in": "query", "description": "شماره کارت هوشمند ناوگان", "required": true, "schema": { "type": "string" }, "example": "1234567" }, { "name": "Idempotency-Key", "in": "header", "description": "Reuse for the same API key, endpoint and parameters. In-progress duplicates return 409; completed responses replay without billing.", "schema": { "maxLength": 100, "type": "string" } } ], "responses": { "200": { "description": "Completed inquiry. Usage follows the purchased metering policy. Sandbox data is explicitly marked.", "content": { "application/json": { "schema": { "required": [ "requestId", "found" ], "type": "object", "properties": { "requestId": { "type": "string" }, "found": { "type": "boolean" }, "sandbox": { "type": "boolean", "description": "True only for test keys; no live upstream inquiry. Quota consumption follows the purchased sandbox and metering policy." }, "data": { "anyOf": [ { "type": "object", "properties": { "BARGIR_ID": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int64" }, "CardNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "IsActive": { "type": "boolean", "description": "فیلد قرارداد راهداری" }, "LOADER_LINK_TYPE": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "LoadingTypeCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "LoadingTypeTitle": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "MadeYear": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "Mobile": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NOVE_GAVAHINAMEH": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NOVE_NAVGAN_BARI": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "PlaqueCityCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "PlaqueCityName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "PlaqueNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "PlaqueSerialNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "PlaqueType": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "TARIKH_ETEBAR_MOAYENE_FANI": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "VINCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "YearType": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } }, "nullable": true }, { "required": [ "sandbox" ], "type": "object", "properties": { "sandbox": { "type": "boolean" }, "service": { "type": "string" }, "message": { "type": "string" } } } ], "nullable": true }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } } } } } }, "401": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "402": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "403": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "409": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "422": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "429": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "502": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "503": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "504": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/rmto/freighter/card/basic": { "get": { "tags": [ "ApiV1Rmto" ], "summary": "اطلاعات پایه ناوگان", "description": "استعلام از سرویس راهداری با کنترل دسترسی، ثبت مصرف و پاسخ استاندارد.\nRequired scope: freighters:read\nUpstream: GetFreighterBySmartCardNo", "parameters": [ { "name": "cardNo", "in": "query", "description": "شماره کارت هوشمند ناوگان", "required": true, "schema": { "type": "string" }, "example": "1234567" }, { "name": "Idempotency-Key", "in": "header", "description": "Reuse for the same API key, endpoint and parameters. In-progress duplicates return 409; completed responses replay without billing.", "schema": { "maxLength": 100, "type": "string" } } ], "responses": { "200": { "description": "Completed inquiry. Usage follows the purchased metering policy. Sandbox data is explicitly marked.", "content": { "application/json": { "schema": { "required": [ "requestId", "found" ], "type": "object", "properties": { "requestId": { "type": "string" }, "found": { "type": "boolean" }, "sandbox": { "type": "boolean", "description": "True only for test keys; no live upstream inquiry. Quota consumption follows the purchased sandbox and metering policy." }, "data": { "anyOf": [ { "type": "object", "properties": { "BARGIR_ID": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int64" }, "CardNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "IsActive": { "type": "boolean", "description": "فیلد قرارداد راهداری" }, "LOADER_LINK_TYPE": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "LoadingTypeCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "LoadingTypeTitle": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "MadeYear": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "Mobile": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NOVE_GAVAHINAMEH": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NOVE_NAVGAN_BARI": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "PlaqueCityCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "PlaqueCityName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "PlaqueNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "PlaqueSerialNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "PlaqueType": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "TARIKH_ETEBAR_MOAYENE_FANI": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "VINCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "YearType": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } }, "nullable": true }, { "required": [ "sandbox" ], "type": "object", "properties": { "sandbox": { "type": "boolean" }, "service": { "type": "string" }, "message": { "type": "string" } } } ], "nullable": true }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } } } } } }, "401": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "402": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "403": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "409": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "422": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "429": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "502": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "503": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "504": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/rmto/today/driver-card": { "get": { "tags": [ "ApiV1Rmto" ], "summary": "بارنامه‌های امروز راننده با کارت", "description": "استعلام از سرویس راهداری با کنترل دسترسی، ثبت مصرف و پاسخ استاندارد.\nRequired scope: waybills:read\nUpstream: GetBillOfLadingByDriverCardNumberInToday", "parameters": [ { "name": "cardNumber", "in": "query", "description": "شماره کارت راننده", "required": true, "schema": { "type": "string" }, "example": "1234567" }, { "name": "Idempotency-Key", "in": "header", "description": "Reuse for the same API key, endpoint and parameters. In-progress duplicates return 409; completed responses replay without billing.", "schema": { "maxLength": 100, "type": "string" } } ], "responses": { "200": { "description": "Completed inquiry. Usage follows the purchased metering policy. Sandbox data is explicitly marked.", "content": { "application/json": { "schema": { "required": [ "requestId", "found" ], "type": "object", "properties": { "requestId": { "type": "string" }, "found": { "type": "boolean" }, "sandbox": { "type": "boolean", "description": "True only for test keys; no live upstream inquiry. Quota consumption follows the purchased sandbox and metering policy." }, "data": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "Company": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "DestinationCity": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Number": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int64" }, "OriginCity": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Serial": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } } }, "nullable": true }, { "required": [ "sandbox" ], "type": "object", "properties": { "sandbox": { "type": "boolean" }, "service": { "type": "string" }, "message": { "type": "string" } } } ], "nullable": true }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } } } } } }, "401": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "402": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "403": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "409": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "422": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "429": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "502": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "503": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "504": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/rmto/today/freighter-card": { "get": { "tags": [ "ApiV1Rmto" ], "summary": "بارنامه‌های امروز ناوگان", "description": "استعلام از سرویس راهداری با کنترل دسترسی، ثبت مصرف و پاسخ استاندارد.\nRequired scope: waybills:read\nUpstream: GetBillOfLadingByFreighterCardNumberInToday", "parameters": [ { "name": "cardNumber", "in": "query", "description": "شماره کارت ناوگان", "required": true, "schema": { "type": "string" }, "example": "1234567" }, { "name": "Idempotency-Key", "in": "header", "description": "Reuse for the same API key, endpoint and parameters. In-progress duplicates return 409; completed responses replay without billing.", "schema": { "maxLength": 100, "type": "string" } } ], "responses": { "200": { "description": "Completed inquiry. Usage follows the purchased metering policy. Sandbox data is explicitly marked.", "content": { "application/json": { "schema": { "required": [ "requestId", "found" ], "type": "object", "properties": { "requestId": { "type": "string" }, "found": { "type": "boolean" }, "sandbox": { "type": "boolean", "description": "True only for test keys; no live upstream inquiry. Quota consumption follows the purchased sandbox and metering policy." }, "data": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "Company": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "DestinationCity": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Number": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int64" }, "OriginCity": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Serial": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } } }, "nullable": true }, { "required": [ "sandbox" ], "type": "object", "properties": { "sandbox": { "type": "boolean" }, "service": { "type": "string" }, "message": { "type": "string" } } } ], "nullable": true }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } } } } } }, "401": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "402": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "403": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "409": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "422": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "429": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "502": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "503": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "504": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/rmto/today/driver-national-id": { "get": { "tags": [ "ApiV1Rmto" ], "summary": "بارنامه‌های امروز با کد ملی", "description": "استعلام از سرویس راهداری با کنترل دسترسی، ثبت مصرف و پاسخ استاندارد.\nRequired scope: waybills:read\nUpstream: GetBillOfLadingByDriverNationalIdInToday", "parameters": [ { "name": "nationalId", "in": "query", "description": "کد ملی ده رقمی راننده", "required": true, "schema": { "type": "string" }, "example": "1234567890" }, { "name": "Idempotency-Key", "in": "header", "description": "Reuse for the same API key, endpoint and parameters. In-progress duplicates return 409; completed responses replay without billing.", "schema": { "maxLength": 100, "type": "string" } } ], "responses": { "200": { "description": "Completed inquiry. Usage follows the purchased metering policy. Sandbox data is explicitly marked.", "content": { "application/json": { "schema": { "required": [ "requestId", "found" ], "type": "object", "properties": { "requestId": { "type": "string" }, "found": { "type": "boolean" }, "sandbox": { "type": "boolean", "description": "True only for test keys; no live upstream inquiry. Quota consumption follows the purchased sandbox and metering policy." }, "data": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "Company": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "DestinationCity": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Number": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int64" }, "OriginCity": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Serial": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } } }, "nullable": true }, { "required": [ "sandbox" ], "type": "object", "properties": { "sandbox": { "type": "boolean" }, "service": { "type": "string" }, "message": { "type": "string" } } } ], "nullable": true }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } } } } } }, "401": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "402": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "403": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "409": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "422": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "429": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "502": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "503": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "504": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/rmto/driver/bills": { "get": { "tags": [ "ApiV1Rmto" ], "summary": "بارنامه راننده با کد ملی", "description": "آخرین بارنامه قابل دریافت راننده در ۱۰ روز گذشته؛ طبق مستند V03 راهداری.\nRequired scope: waybills:read\nUpstream: GetBillOfLadingByDriverNationalID", "parameters": [ { "name": "nationalId", "in": "query", "description": "کد ملی ده رقمی راننده", "required": true, "schema": { "type": "string" }, "example": "1234567890" }, { "name": "Idempotency-Key", "in": "header", "description": "Reuse for the same API key, endpoint and parameters. In-progress duplicates return 409; completed responses replay without billing.", "schema": { "maxLength": 100, "type": "string" } } ], "responses": { "200": { "description": "Completed inquiry. Usage follows the purchased metering policy. Sandbox data is explicitly marked.", "content": { "application/json": { "schema": { "required": [ "requestId", "found" ], "type": "object", "properties": { "requestId": { "type": "string" }, "found": { "type": "boolean" }, "sandbox": { "type": "boolean", "description": "True only for test keys; no live upstream inquiry. Quota consumption follows the purchased sandbox and metering policy." }, "data": { "anyOf": [ { "type": "object", "properties": { "ChangeStatusDate": { "type": "object", "properties": { "Day": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "Month": { "type": "integer", "description": "فیلد قرارداد راهداری", "nullable": true }, "Year": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "Company": { "type": "object", "properties": { "Branch": { "type": "object", "properties": { "ID": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int64" }, "Name": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "Code": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "LOCATION": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "Name": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NationalCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int64" }, "SARASARY": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "CompanyCommission": { "type": "number", "description": "فیلد قرارداد راهداری" }, "CompanyCommissionPercent": { "type": "number", "description": "فیلد قرارداد راهداری" }, "Cost": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int64" }, "CustomInfo": { "type": "object", "properties": { "Code": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "KootajDate": { "type": "string", "description": "فیلد قرارداد راهداری", "format": "date-time" }, "KootajNo": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "Description": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "DestinationCityCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "DestinationCityName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "DischargeCost": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "DriverCommission": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "FirstDriver": { "type": "object", "properties": { "BirthCityCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "BirthCityName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "CardNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "CardValidationDate": { "type": "object", "properties": { "Day": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "Month": { "type": "integer", "description": "فیلد قرارداد راهداری", "nullable": true }, "Year": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "CertifcateIssueCityCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "CertifcateIssueCityName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "CertifcateNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Driver_Type": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Family": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "FatherName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "IdentifierNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "InsuranceBranch": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "InsuranceId": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "IsActive": { "type": "boolean", "description": "فیلد قرارداد راهداری" }, "Mobile": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NOVE_GAVAHINAMEH": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Name": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NationalId": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "TARIKH_ETEBAR_KART_SALAMAT": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "Freighter": { "type": "object", "properties": { "BARGIR_ID": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int64" }, "CardNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "IsActive": { "type": "boolean", "description": "فیلد قرارداد راهداری" }, "LOADER_LINK_TYPE": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "LoadingTypeCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "LoadingTypeTitle": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "MadeYear": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "Mobile": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NOVE_GAVAHINAMEH": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NOVE_NAVGAN_BARI": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "PlaqueCityCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "PlaqueCityName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "PlaqueNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "PlaqueSerialNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "PlaqueType": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "TARIKH_ETEBAR_MOAYENE_FANI": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "VINCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "YearType": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "GoodInfoList": { "type": "array", "items": { "type": "object", "properties": { "GoodTitle": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "GoodTypeCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "HSCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "HSTarrifTitle": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "IranCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "MeghdareTabieiLitr": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "PackingTitle": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "PackingTypeCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "Value": { "type": "number", "description": "فیلد قرارداد راهداری" }, "VazneMakhsoos": { "type": "number", "description": "فیلد قرارداد راهداری" }, "Weight": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" } } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "InsuranceCompany": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "InsuranceCost": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int64" }, "InsuranceNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "IssuDate": { "type": "object", "properties": { "Day": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "Month": { "type": "integer", "description": "فیلد قرارداد راهداری", "nullable": true }, "Year": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "IssueTime": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "KalaDesc": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "LanderTitle": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "LanderTypeCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "LoadingCost": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "MasterBillofLadingTraceCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Number": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int64" }, "OriginCityCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "OriginCityName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "PayanehCost": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "Serial": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Status": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Tax": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "TotalCost": { "type": "number", "description": "فیلد قرارداد راهداری" }, "TransitTypeTitle": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Receiver": { "type": "object", "properties": { "Name": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NationalCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "PostalCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "LastName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "ReceiverAddress": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Robari": { "type": "boolean", "description": "فیلد قرارداد راهداری" }, "Sender": { "type": "object", "properties": { "Name": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NationalCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "PostalCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "LastName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "SenderAddress": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "ShomarehHavalehAnbarNaft": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int64" }, "TraceCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "TransitTypecode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "WeighbridgeCost": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "secondDriver": { "type": "object", "properties": { "BirthCityCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "BirthCityName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "CardNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "CardValidationDate": { "type": "object", "properties": { "Day": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "Month": { "type": "integer", "description": "فیلد قرارداد راهداری", "nullable": true }, "Year": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "CertifcateIssueCityCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "CertifcateIssueCityName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "CertifcateNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Driver_Type": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Family": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "FatherName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "IdentifierNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "InsuranceBranch": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "InsuranceId": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "IsActive": { "type": "boolean", "description": "فیلد قرارداد راهداری" }, "Mobile": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NOVE_GAVAHINAMEH": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Name": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NationalId": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "TARIKH_ETEBAR_KART_SALAMAT": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } }, "description": "فیلد قرارداد راهداری", "nullable": true } }, "nullable": true }, { "required": [ "sandbox" ], "type": "object", "properties": { "sandbox": { "type": "boolean" }, "service": { "type": "string" }, "message": { "type": "string" } } } ], "nullable": true }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } } } } } }, "401": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "402": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "403": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "409": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "422": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "429": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "502": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "503": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "504": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/rmto/bol/exists": { "get": { "tags": [ "ApiV1Rmto" ], "summary": "بررسی وجود بارنامه", "description": "استعلام از سرویس راهداری با کنترل دسترسی، ثبت مصرف و پاسخ استاندارد.\nRequired scope: waybills:read\nUpstream: CheckExistBillOfLadingBySerialAndNumber", "parameters": [ { "name": "serial", "in": "query", "description": "سریال بارنامه", "required": true, "schema": { "type": "string" }, "example": "123" }, { "name": "number", "in": "query", "description": "شماره بارنامه", "required": true, "schema": { "type": "integer" }, "example": 123456 }, { "name": "Idempotency-Key", "in": "header", "description": "Reuse for the same API key, endpoint and parameters. In-progress duplicates return 409; completed responses replay without billing.", "schema": { "maxLength": 100, "type": "string" } } ], "responses": { "200": { "description": "Completed inquiry. Usage follows the purchased metering policy. Sandbox data is explicitly marked.", "content": { "application/json": { "schema": { "required": [ "requestId", "found" ], "type": "object", "properties": { "requestId": { "type": "string" }, "found": { "type": "boolean" }, "sandbox": { "type": "boolean", "description": "True only for test keys; no live upstream inquiry. Quota consumption follows the purchased sandbox and metering policy." }, "data": { "anyOf": [ { "type": "object", "properties": { "exists": { "type": "boolean", "description": "مقدار پاسخ راهداری" } }, "nullable": true }, { "required": [ "sandbox" ], "type": "object", "properties": { "sandbox": { "type": "boolean" }, "service": { "type": "string" }, "message": { "type": "string" } } } ], "nullable": true }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } } } } } }, "401": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "402": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "403": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "409": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "422": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "429": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "502": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "503": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "504": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/rmto/trace": { "get": { "tags": [ "ApiV1Rmto" ], "summary": "کد رهگیری بارنامه", "description": "استعلام از سرویس راهداری با کنترل دسترسی، ثبت مصرف و پاسخ استاندارد.\nRequired scope: waybills:read\nUpstream: Inquiry_BarnamehTraceCode", "parameters": [ { "name": "barNumber", "in": "query", "description": "شماره بارنامه", "required": true, "schema": { "type": "integer" }, "example": 123456 }, { "name": "barSerial", "in": "query", "description": "سریال بارنامه", "required": true, "schema": { "type": "string" }, "example": "123" }, { "name": "Idempotency-Key", "in": "header", "description": "Reuse for the same API key, endpoint and parameters. In-progress duplicates return 409; completed responses replay without billing.", "schema": { "maxLength": 100, "type": "string" } } ], "responses": { "200": { "description": "Completed inquiry. Usage follows the purchased metering policy. Sandbox data is explicitly marked.", "content": { "application/json": { "schema": { "required": [ "requestId", "found" ], "type": "object", "properties": { "requestId": { "type": "string" }, "found": { "type": "boolean" }, "sandbox": { "type": "boolean", "description": "True only for test keys; no live upstream inquiry. Quota consumption follows the purchased sandbox and metering policy." }, "data": { "anyOf": [ { "type": "object", "properties": { "text": { "type": "string", "description": "اگر پاسخ راهداری JSON باشد ساختار آن حفظ می‌شود؛ در غیر این صورت متن در text برمی‌گردد.", "nullable": true } }, "nullable": true }, { "required": [ "sandbox" ], "type": "object", "properties": { "sandbox": { "type": "boolean" }, "service": { "type": "string" }, "message": { "type": "string" } } } ], "nullable": true }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } } } } } }, "401": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "402": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "403": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "409": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "422": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "429": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "502": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "503": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "504": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/rmto/insurance": { "get": { "tags": [ "ApiV1Rmto" ], "summary": "بیمه‌نامه بار", "description": "استعلام از سرویس راهداری با کنترل دسترسی، ثبت مصرف و پاسخ استاندارد.\nRequired scope: insurance:read\nUpstream: Inquiry_Insurance", "parameters": [ { "name": "company", "in": "query", "description": "کد شرکت بیمه مطابق InsuranceCompanyEnum؛ برای نمونه ۲ ایران، ۴ آسیا و ۵ دانا", "required": true, "schema": { "type": "integer" }, "example": 2 }, { "name": "insuranceNumber", "in": "query", "description": "شماره بیمه‌نامه", "required": true, "schema": { "type": "string" }, "example": "123456" }, { "name": "Idempotency-Key", "in": "header", "description": "Reuse for the same API key, endpoint and parameters. In-progress duplicates return 409; completed responses replay without billing.", "schema": { "maxLength": 100, "type": "string" } } ], "responses": { "200": { "description": "Completed inquiry. Usage follows the purchased metering policy. Sandbox data is explicitly marked.", "content": { "application/json": { "schema": { "required": [ "requestId", "found" ], "type": "object", "properties": { "requestId": { "type": "string" }, "found": { "type": "boolean" }, "sandbox": { "type": "boolean", "description": "True only for test keys; no live upstream inquiry. Quota consumption follows the purchased sandbox and metering policy." }, "data": { "anyOf": [ { "type": "object", "properties": { "CmpNam": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "EndDte": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Endorsments": { "type": "array", "items": { "type": "object", "properties": { "IssueDate": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Text": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "ErrorCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "ErrorDescription": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "FldNam": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "IsuDte": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "MIsuDte": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Nam": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NtlCod": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "PlcyDoc": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "SttDte": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "UnqCod": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } }, "nullable": true }, { "required": [ "sandbox" ], "type": "object", "properties": { "sandbox": { "type": "boolean" }, "service": { "type": "string" }, "message": { "type": "string" } } } ], "nullable": true }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } } } } } }, "401": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "402": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "403": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "409": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "422": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "429": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "502": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "503": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "504": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/rmto/person/real": { "get": { "tags": [ "ApiV1Rmto" ], "summary": "شخص حقیقی", "description": "استعلام از سرویس راهداری با کنترل دسترسی، ثبت مصرف و پاسخ استاندارد.\nRequired scope: persons:read\nUpstream: Inquiry_RealPerson", "parameters": [ { "name": "nationalCode", "in": "query", "description": "کد ملی ده رقمی", "required": true, "schema": { "type": "string" }, "example": "1234567890" }, { "name": "Idempotency-Key", "in": "header", "description": "Reuse for the same API key, endpoint and parameters. In-progress duplicates return 409; completed responses replay without billing.", "schema": { "maxLength": 100, "type": "string" } } ], "responses": { "200": { "description": "Completed inquiry. Usage follows the purchased metering policy. Sandbox data is explicitly marked.", "content": { "application/json": { "schema": { "required": [ "requestId", "found" ], "type": "object", "properties": { "requestId": { "type": "string" }, "found": { "type": "boolean" }, "sandbox": { "type": "boolean", "description": "True only for test keys; no live upstream inquiry. Quota consumption follows the purchased sandbox and metering policy." }, "data": { "anyOf": [ { "type": "object", "properties": { "ErrorDesc": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "FullAddress": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "IsSuccessful": { "type": "boolean", "description": "فیلد قرارداد راهداری" }, "LastName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Name": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "SuccessfulDesc": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "WarningDesc": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } }, "nullable": true }, { "required": [ "sandbox" ], "type": "object", "properties": { "sandbox": { "type": "boolean" }, "service": { "type": "string" }, "message": { "type": "string" } } } ], "nullable": true }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } } } } } }, "401": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "402": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "403": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "409": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "422": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "429": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "502": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "503": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "504": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/rmto/person/legal": { "get": { "tags": [ "ApiV1Rmto" ], "summary": "شخص حقوقی", "description": "استعلام از سرویس راهداری با کنترل دسترسی، ثبت مصرف و پاسخ استاندارد.\nRequired scope: persons:read\nUpstream: Inquiry_LegalPerson", "parameters": [ { "name": "nationalCode", "in": "query", "description": "شناسه ملی شخصیت حقوقی", "required": true, "schema": { "type": "string" }, "example": "14001234567" }, { "name": "Idempotency-Key", "in": "header", "description": "Reuse for the same API key, endpoint and parameters. In-progress duplicates return 409; completed responses replay without billing.", "schema": { "maxLength": 100, "type": "string" } } ], "responses": { "200": { "description": "Completed inquiry. Usage follows the purchased metering policy. Sandbox data is explicitly marked.", "content": { "application/json": { "schema": { "required": [ "requestId", "found" ], "type": "object", "properties": { "requestId": { "type": "string" }, "found": { "type": "boolean" }, "sandbox": { "type": "boolean", "description": "True only for test keys; no live upstream inquiry. Quota consumption follows the purchased sandbox and metering policy." }, "data": { "anyOf": [ { "type": "object", "properties": { "ErrorDesc": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "FullAddress": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "IsSuccessful": { "type": "boolean", "description": "فیلد قرارداد راهداری" }, "LastName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Name": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "SuccessfulDesc": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "WarningDesc": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } }, "nullable": true }, { "required": [ "sandbox" ], "type": "object", "properties": { "sandbox": { "type": "boolean" }, "service": { "type": "string" }, "message": { "type": "string" } } } ], "nullable": true }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } } } } } }, "401": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "402": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "403": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "409": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "422": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "429": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "502": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "503": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "504": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/rmto/company/status": { "get": { "tags": [ "ApiV1Rmto" ], "summary": "وضعیت شرکت در راهداری", "description": "استعلام از سرویس راهداری با کنترل دسترسی، ثبت مصرف و پاسخ استاندارد.\nRequired scope: system:read\nUpstream: GetCompanyStatus", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "Reuse for the same API key, endpoint and parameters. In-progress duplicates return 409; completed responses replay without billing.", "schema": { "maxLength": 100, "type": "string" } } ], "responses": { "200": { "description": "Completed inquiry. Usage follows the purchased metering policy. Sandbox data is explicitly marked.", "content": { "application/json": { "schema": { "required": [ "requestId", "found" ], "type": "object", "properties": { "requestId": { "type": "string" }, "found": { "type": "boolean" }, "sandbox": { "type": "boolean", "description": "True only for test keys; no live upstream inquiry. Quota consumption follows the purchased sandbox and metering policy." }, "data": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "integer", "description": "مقدار پاسخ راهداری" } }, "nullable": true }, { "required": [ "sandbox" ], "type": "object", "properties": { "sandbox": { "type": "boolean" }, "service": { "type": "string" }, "message": { "type": "string" } } } ], "nullable": true }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } } } } } }, "401": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "402": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "403": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "409": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "422": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "429": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "502": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "503": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "504": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/rmto/date": { "get": { "tags": [ "ApiV1Rmto" ], "summary": "تاریخ جاری راهداری", "description": "استعلام از سرویس راهداری با کنترل دسترسی، ثبت مصرف و پاسخ استاندارد.\nRequired scope: system:read\nUpstream: GetRmtoCurrentDate", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "Reuse for the same API key, endpoint and parameters. In-progress duplicates return 409; completed responses replay without billing.", "schema": { "maxLength": 100, "type": "string" } } ], "responses": { "200": { "description": "Completed inquiry. Usage follows the purchased metering policy. Sandbox data is explicitly marked.", "content": { "application/json": { "schema": { "required": [ "requestId", "found" ], "type": "object", "properties": { "requestId": { "type": "string" }, "found": { "type": "boolean" }, "sandbox": { "type": "boolean", "description": "True only for test keys; no live upstream inquiry. Quota consumption follows the purchased sandbox and metering policy." }, "data": { "anyOf": [ { "type": "object", "properties": { "date": { "type": "string", "description": "مقدار پاسخ راهداری", "format": "date-time" } }, "nullable": true }, { "required": [ "sandbox" ], "type": "object", "properties": { "sandbox": { "type": "boolean" }, "service": { "type": "string" }, "message": { "type": "string" } } } ], "nullable": true }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } } } } } }, "401": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "402": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "403": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "409": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "422": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "429": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "502": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "503": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "504": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/rmto/bol/approvals": { "get": { "tags": [ "ApiV1Rmto" ], "summary": "رد و تأیید بارنامه در بازه تاریخ", "description": "استعلام از سرویس راهداری با کنترل دسترسی، ثبت مصرف و پاسخ استاندارد.\nRequired scope: waybills:read\nUpstream: Inquiry_RadTaeid_Barnameh", "parameters": [ { "name": "fromDate", "in": "query", "description": "تاریخ شمسی شروع yyyy/MM/dd؛ حداکثر بازه ۳۱ روز", "required": true, "schema": { "type": "string" }, "example": "1405/07/01" }, { "name": "toDate", "in": "query", "description": "تاریخ شمسی پایان yyyy/MM/dd", "required": true, "schema": { "type": "string" }, "example": "1405/07/15" }, { "name": "Idempotency-Key", "in": "header", "description": "Reuse for the same API key, endpoint and parameters. In-progress duplicates return 409; completed responses replay without billing.", "schema": { "maxLength": 100, "type": "string" } } ], "responses": { "200": { "description": "Completed inquiry. Usage follows the purchased metering policy. Sandbox data is explicitly marked.", "content": { "application/json": { "schema": { "required": [ "requestId", "found" ], "type": "object", "properties": { "requestId": { "type": "string" }, "found": { "type": "boolean" }, "sandbox": { "type": "boolean", "description": "True only for test keys; no live upstream inquiry. Quota consumption follows the purchased sandbox and metering policy." }, "data": { "anyOf": [ { "type": "object", "properties": { "Count": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "Error_Code": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "Error_Message": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "data": { "type": "array", "items": { "type": "object", "properties": { "Alter_Status_Time": { "type": "array", "items": { "type": "object" }, "description": "فیلد قرارداد راهداری", "nullable": true }, "BarNumber": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "BarnameID": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "Carrier": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Carrier_ID": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Confirm_Time": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Confirmed": { "type": "boolean", "description": "فیلد قرارداد راهداری" }, "Driver_First_Name": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Driver_Last_Name": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "From_PostCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Goods": { "type": "array", "items": { "type": "object", "properties": { "Good_ID": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "Good_Name": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Weight": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" } } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "IssueDate": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "National_ID": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Receiver_National_ID": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Sender_National_ID": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Serial": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "To_PostCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "TraceCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Warehouse_ID": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } } }, "description": "فیلد قرارداد راهداری", "nullable": true } }, "nullable": true }, { "required": [ "sandbox" ], "type": "object", "properties": { "sandbox": { "type": "boolean" }, "service": { "type": "string" }, "message": { "type": "string" } } } ], "nullable": true }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } } } } } }, "401": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "402": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "403": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "409": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "422": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "429": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "502": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "503": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "504": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/rmto/postal-code": { "get": { "tags": [ "ApiV1Rmto" ], "summary": "نشانی با کدپستی", "description": "استعلام از سرویس راهداری با کنترل دسترسی، ثبت مصرف و پاسخ استاندارد.\nRequired scope: locations:read\nUpstream: Inquiry_PostalCode", "parameters": [ { "name": "postalCode", "in": "query", "description": "کدپستی ده رقمی", "required": true, "schema": { "type": "string" }, "example": "1234567890" }, { "name": "Idempotency-Key", "in": "header", "description": "Reuse for the same API key, endpoint and parameters. In-progress duplicates return 409; completed responses replay without billing.", "schema": { "maxLength": 100, "type": "string" } } ], "responses": { "200": { "description": "Completed inquiry. Usage follows the purchased metering policy. Sandbox data is explicitly marked.", "content": { "application/json": { "schema": { "required": [ "requestId", "found" ], "type": "object", "properties": { "requestId": { "type": "string" }, "found": { "type": "boolean" }, "sandbox": { "type": "boolean", "description": "True only for test keys; no live upstream inquiry. Quota consumption follows the purchased sandbox and metering policy." }, "data": { "anyOf": [ { "type": "object", "properties": { "ErrorDesc": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "FullAddress": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "IsSuccessful": { "type": "boolean", "description": "فیلد قرارداد راهداری" }, "LastName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Name": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "SuccessfulDesc": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "WarningDesc": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } }, "nullable": true }, { "required": [ "sandbox" ], "type": "object", "properties": { "sandbox": { "type": "boolean" }, "service": { "type": "string" }, "message": { "type": "string" } } } ], "nullable": true }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } } } } } }, "401": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "402": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "403": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "409": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "422": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "429": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "502": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "503": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "504": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/rmto/postal-code/gnaf": { "get": { "tags": [ "ApiV1Rmto" ], "summary": "مختصات جغرافیایی کدپستی", "description": "استعلام از سرویس راهداری با کنترل دسترسی، ثبت مصرف و پاسخ استاندارد.\nRequired scope: locations:read\nUpstream: Inquiry_GNAFPostalCode", "parameters": [ { "name": "postalCode", "in": "query", "description": "کدپستی ده رقمی", "required": true, "schema": { "type": "string" }, "example": "1234567890" }, { "name": "Idempotency-Key", "in": "header", "description": "Reuse for the same API key, endpoint and parameters. In-progress duplicates return 409; completed responses replay without billing.", "schema": { "maxLength": 100, "type": "string" } } ], "responses": { "200": { "description": "Completed inquiry. Usage follows the purchased metering policy. Sandbox data is explicitly marked.", "content": { "application/json": { "schema": { "required": [ "requestId", "found" ], "type": "object", "properties": { "requestId": { "type": "string" }, "found": { "type": "boolean" }, "sandbox": { "type": "boolean", "description": "True only for test keys; no live upstream inquiry. Quota consumption follows the purchased sandbox and metering policy." }, "data": { "anyOf": [ { "type": "object", "properties": { "ErrorCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "ErrorMessage": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "lat": { "type": "number", "description": "فیلد قرارداد راهداری" }, "lon": { "type": "number", "description": "فیلد قرارداد راهداری" } }, "nullable": true }, { "required": [ "sandbox" ], "type": "object", "properties": { "sandbox": { "type": "boolean" }, "service": { "type": "string" }, "message": { "type": "string" } } } ], "nullable": true }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } } } } } }, "401": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "402": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "403": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "409": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "422": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "429": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "502": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "503": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "504": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/rmto/trade-document": { "get": { "tags": [ "ApiV1Rmto" ], "summary": "اطلاعات سند تجاری", "description": "استعلام از سرویس راهداری با کنترل دسترسی، ثبت مصرف و پاسخ استاندارد.\nRequired scope: waybills:read\nUpstream: Inquiry_TradeDocInformation", "parameters": [ { "name": "referenceDocumentNumber", "in": "query", "description": "شماره سند مرجع", "required": true, "schema": { "type": "string" }, "example": "123456" }, { "name": "documentType", "in": "query", "description": "نوع سند مطابق مجوز راهداری", "required": true, "schema": { "type": "integer" }, "example": 1 }, { "name": "Idempotency-Key", "in": "header", "description": "Reuse for the same API key, endpoint and parameters. In-progress duplicates return 409; completed responses replay without billing.", "schema": { "maxLength": 100, "type": "string" } } ], "responses": { "200": { "description": "Completed inquiry. Usage follows the purchased metering policy. Sandbox data is explicitly marked.", "content": { "application/json": { "schema": { "required": [ "requestId", "found" ], "type": "object", "properties": { "requestId": { "type": "string" }, "found": { "type": "boolean" }, "sandbox": { "type": "boolean", "description": "True only for test keys; no live upstream inquiry. Quota consumption follows the purchased sandbox and metering policy." }, "data": { "anyOf": [ { "type": "object", "properties": { "ContainersCount": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "ContainersList": { "type": "array", "items": { "type": "object", "properties": { "AdditionalInformation": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "EmptyWeight": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "GoodsList": { "type": "array", "items": { "type": "object", "properties": { "AdditionalInformation": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Count": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "DangerousGoodsCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "GoodsCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "GoodsDescription": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "GrossWeight": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "HSCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "LogisticCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "TraceCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Volume": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "GrossWeight": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Humidity": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "ID": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "LoadVolume": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "MaxTemp": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "MinTemp": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "PackagCount": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "Seals": { "type": "array", "items": { "type": "object", "properties": { "Marks": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "SealingParty": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "Type": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "UnitTemp": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "DischargePostalCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "DriverName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "DriverNationalCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Error_Code": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "Error_Message": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "GoodsValue": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "GrossWeight": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "LoadingDateTime": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int64" }, "LoadingPostalCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NetWeight": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "PackageCount": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "ReceiverName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "ReceiverNationalCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "RegistrationDate": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int64" }, "SenderName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "SenderNationalCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "VesselRegistrationNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "listGoods": { "type": "array", "items": { "type": "object", "properties": { "AdditionalInformation": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Count": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "DangerousGoodsCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "GoodsCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "GoodsDescription": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "GrossWeight": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "HSCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "LogisticCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "TraceCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Volume": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } } }, "description": "فیلد قرارداد راهداری", "nullable": true } }, "nullable": true }, { "required": [ "sandbox" ], "type": "object", "properties": { "sandbox": { "type": "boolean" }, "service": { "type": "string" }, "message": { "type": "string" } } } ], "nullable": true }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } } } } } }, "401": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "402": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "403": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "409": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "422": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "429": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "502": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "503": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "504": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/rmto/waybill-assign": { "get": { "tags": [ "ApiV1Rmto" ], "summary": "بررسی تخصیص بارنامه", "description": "استعلام از سرویس راهداری با کنترل دسترسی، ثبت مصرف و پاسخ استاندارد.\nRequired scope: waybills:read\nUpstream: Inquiry_CheckWaybillAssign", "parameters": [ { "name": "traceCode", "in": "query", "description": "کد رهگیری حواله", "required": true, "schema": { "type": "integer" }, "example": 123456 }, { "name": "Idempotency-Key", "in": "header", "description": "Reuse for the same API key, endpoint and parameters. In-progress duplicates return 409; completed responses replay without billing.", "schema": { "maxLength": 100, "type": "string" } } ], "responses": { "200": { "description": "Completed inquiry. Usage follows the purchased metering policy. Sandbox data is explicitly marked.", "content": { "application/json": { "schema": { "required": [ "requestId", "found" ], "type": "object", "properties": { "requestId": { "type": "string" }, "found": { "type": "boolean" }, "sandbox": { "type": "boolean", "description": "True only for test keys; no live upstream inquiry. Quota consumption follows the purchased sandbox and metering policy." }, "data": { "anyOf": [ { "type": "object", "properties": { "CarrierCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "CreatedOn": { "type": "string", "description": "فیلد قرارداد راهداری", "format": "date-time" }, "DestinationCityCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "DriverNationalId": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "EndDate": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "FleetCardNo": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "FleetPlaque": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "GoodTypeCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int64" }, "LoaderTypeCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "LoadingDate": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "OriginCityCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "SecondDriverNationalId": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "StartDate": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "TrCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int64" }, "UpdatedOn": { "type": "string", "description": "فیلد قرارداد راهداری", "format": "date-time" }, "Weight": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int64" } }, "nullable": true }, { "required": [ "sandbox" ], "type": "object", "properties": { "sandbox": { "type": "boolean" }, "service": { "type": "string" }, "message": { "type": "string" } } } ], "nullable": true }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } } } } } }, "401": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "402": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "403": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "409": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "422": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "429": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "502": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "503": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "504": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/rmto/province-tariff": { "get": { "tags": [ "ApiV1Rmto" ], "summary": "نرخ عرف حمل استان", "description": "استعلام از سرویس راهداری با کنترل دسترسی، ثبت مصرف و پاسخ استاندارد.\nRequired scope: tariffs:read\nUpstream: Inquiry_OrfOstanPrice", "parameters": [ { "name": "originCode", "in": "query", "description": "کد شهر مبدأ", "required": true, "schema": { "type": "integer" }, "example": 11321000 }, { "name": "destCode", "in": "query", "description": "کد شهر مقصد", "required": true, "schema": { "type": "integer" }, "example": 11322000 }, { "name": "loaderCode", "in": "query", "description": "کد بارگیر", "required": true, "schema": { "type": "integer" }, "example": 1 }, { "name": "goodsCode", "in": "query", "description": "کد کالا", "required": true, "schema": { "type": "integer" }, "example": 1 }, { "name": "weight", "in": "query", "description": "وزن بار (تن)", "required": true, "schema": { "type": "number" }, "example": 20 }, { "name": "companyCommission", "in": "query", "description": "کمیسیون شرکت (درصد)", "required": true, "schema": { "type": "number" }, "example": 0 }, { "name": "isTrafficLoad", "in": "query", "description": "آیا بار ترافیکی است", "required": true, "schema": { "type": "boolean" }, "example": false }, { "name": "Idempotency-Key", "in": "header", "description": "Reuse for the same API key, endpoint and parameters. In-progress duplicates return 409; completed responses replay without billing.", "schema": { "maxLength": 100, "type": "string" } } ], "responses": { "200": { "description": "Completed inquiry. Usage follows the purchased metering policy. Sandbox data is explicitly marked.", "content": { "application/json": { "schema": { "required": [ "requestId", "found" ], "type": "object", "properties": { "requestId": { "type": "string" }, "found": { "type": "boolean" }, "sandbox": { "type": "boolean", "description": "True only for test keys; no live upstream inquiry. Quota consumption follows the purchased sandbox and metering policy." }, "data": { "anyOf": [ { "type": "object", "properties": { "Distance": { "type": "integer", "description": "مسافت مسیر به کیلومتر", "format": "int32" }, "Price": { "type": "integer", "description": "نرخ عرف حمل به ریال", "format": "int64" } }, "nullable": true }, { "required": [ "sandbox" ], "type": "object", "properties": { "sandbox": { "type": "boolean" }, "service": { "type": "string" }, "message": { "type": "string" } } } ], "nullable": true }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } } } } } }, "401": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "402": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "403": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "409": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "422": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "429": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "502": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "503": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "504": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/rmto/introduce/bijak": { "get": { "tags": [ "ApiV1Rmto" ], "summary": "کالاهای بیجک معرفی‌نامه", "description": "استعلام از سرویس راهداری با کنترل دسترسی، ثبت مصرف و پاسخ استاندارد.\nRequired scope: waybills:read\nUpstream: GetBijakInfo", "parameters": [ { "name": "traceCode", "in": "query", "description": "کد رهگیری معرفی‌نامه", "required": true, "schema": { "type": "string" }, "example": "123456" }, { "name": "Idempotency-Key", "in": "header", "description": "Reuse for the same API key, endpoint and parameters. In-progress duplicates return 409; completed responses replay without billing.", "schema": { "maxLength": 100, "type": "string" } } ], "responses": { "200": { "description": "Completed inquiry. Usage follows the purchased metering policy. Sandbox data is explicitly marked.", "content": { "application/json": { "schema": { "required": [ "requestId", "found" ], "type": "object", "properties": { "requestId": { "type": "string" }, "found": { "type": "boolean" }, "sandbox": { "type": "boolean", "description": "True only for test keys; no live upstream inquiry. Quota consumption follows the purchased sandbox and metering policy." }, "data": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "AndazeKantiner": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "ArzesheGhalameKala": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int64" }, "CodeBijak": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "CodeKala": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "CodeSanad": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "CodeVahedeShomaresh": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "NoeBastebandi": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "SharheKala": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "ShomareGhalam": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "ShomareKantinar": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "TarikhSanad": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Tedad": { "type": "number", "description": "فیلد قرارداد راهداری" }, "VahedeShomaresh": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "VazneKhales": { "type": "number", "description": "فیلد قرارداد راهداری" }, "VazneNaKhales": { "type": "number", "description": "فیلد قرارداد راهداری" }, "ZamaneSabt": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } } }, "nullable": true }, { "required": [ "sandbox" ], "type": "object", "properties": { "sandbox": { "type": "boolean" }, "service": { "type": "string" }, "message": { "type": "string" } } } ], "nullable": true }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } } } } } }, "401": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "402": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "403": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "409": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "422": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "429": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "502": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "503": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "504": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/rmto/introduce/state": { "get": { "tags": [ "ApiV1Rmto" ], "summary": "وضعیت جاری معرفی‌نامه", "description": "استعلام از سرویس راهداری با کنترل دسترسی، ثبت مصرف و پاسخ استاندارد.\nRequired scope: waybills:read\nUpstream: GetCurrentState", "parameters": [ { "name": "traceCode", "in": "query", "description": "کد رهگیری معرفی‌نامه", "required": true, "schema": { "type": "string" }, "example": "123456" }, { "name": "Idempotency-Key", "in": "header", "description": "Reuse for the same API key, endpoint and parameters. In-progress duplicates return 409; completed responses replay without billing.", "schema": { "maxLength": 100, "type": "string" } } ], "responses": { "200": { "description": "Completed inquiry. Usage follows the purchased metering policy. Sandbox data is explicitly marked.", "content": { "application/json": { "schema": { "required": [ "requestId", "found" ], "type": "object", "properties": { "requestId": { "type": "string" }, "found": { "type": "boolean" }, "sandbox": { "type": "boolean", "description": "True only for test keys; no live upstream inquiry. Quota consumption follows the purchased sandbox and metering policy." }, "data": { "anyOf": [ { "type": "object", "properties": { "state": { "type": "integer", "description": "کد وضعیت معرفی‌نامه مطابق صفحه‌های ۴۱ و ۴۲ مستند V03؛ کد ناشناخته بدون تغییر حفظ می‌شود.", "format": "int32" }, "stateName": { "type": "string", "description": "شرح وضعیت؛ برای کدهای ناشناخته خالی است.", "nullable": true } }, "nullable": true }, { "required": [ "sandbox" ], "type": "object", "properties": { "sandbox": { "type": "boolean" }, "service": { "type": "string" }, "message": { "type": "string" } } } ], "nullable": true }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } } } } } }, "401": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "402": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "403": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "409": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "422": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "429": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "502": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "503": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "504": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/rmto/source-place": { "get": { "tags": [ "ApiV1Rmto" ], "summary": "نام مبدأ بارگیری", "description": "استعلام از سرویس راهداری با کنترل دسترسی، ثبت مصرف و پاسخ استاندارد.\nRequired scope: locations:read\nUpstream: GetSourcePlaceName", "parameters": [ { "name": "postalCode", "in": "query", "description": "کدپستی ده رقمی مبدأ", "required": true, "schema": { "type": "string" }, "example": "1234567890" }, { "name": "cityCode", "in": "query", "description": "کد شهر مبدأ", "required": true, "schema": { "type": "integer" }, "example": 11321000 }, { "name": "Idempotency-Key", "in": "header", "description": "Reuse for the same API key, endpoint and parameters. In-progress duplicates return 409; completed responses replay without billing.", "schema": { "maxLength": 100, "type": "string" } } ], "responses": { "200": { "description": "Completed inquiry. Usage follows the purchased metering policy. Sandbox data is explicitly marked.", "content": { "application/json": { "schema": { "required": [ "requestId", "found" ], "type": "object", "properties": { "requestId": { "type": "string" }, "found": { "type": "boolean" }, "sandbox": { "type": "boolean", "description": "True only for test keys; no live upstream inquiry. Quota consumption follows the purchased sandbox and metering policy." }, "data": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string", "description": "نام مبدأ بارگیری؛ پاسخ خالی نتیجه‌ای ندارد." } }, "nullable": true }, { "required": [ "sandbox" ], "type": "object", "properties": { "sandbox": { "type": "boolean" }, "service": { "type": "string" }, "message": { "type": "string" } } } ], "nullable": true }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } } } } } }, "401": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "402": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "403": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "409": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "422": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "429": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "502": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "503": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "504": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/rmto/oil-loading-order": { "get": { "tags": [ "ApiV1Rmto" ], "summary": "حواله بارگیری نفت", "description": "استعلام از سرویس راهداری با کنترل دسترسی، ثبت مصرف و پاسخ استاندارد.\nRequired scope: waybills:read\nUpstream: Inquiry_NIOPDCHavalehBargiri", "parameters": [ { "name": "orderNumber", "in": "query", "description": "شماره حواله بارگیری نفت؛ قرارداد WSDL نسخه V03", "required": true, "schema": { "type": "integer" }, "example": 123456 }, { "name": "Idempotency-Key", "in": "header", "description": "Reuse for the same API key, endpoint and parameters. In-progress duplicates return 409; completed responses replay without billing.", "schema": { "maxLength": 100, "type": "string" } } ], "responses": { "200": { "description": "Completed inquiry. Usage follows the purchased metering policy. Sandbox data is explicitly marked.", "content": { "application/json": { "schema": { "required": [ "requestId", "found" ], "type": "object", "properties": { "requestId": { "type": "string" }, "found": { "type": "boolean" }, "sandbox": { "type": "boolean", "description": "True only for test keys; no live upstream inquiry. Quota consumption follows the purchased sandbox and metering policy." }, "data": { "anyOf": [ { "type": "object", "properties": { "destPostalCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "driverNationalID": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "loadLitre": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "loadWeight": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "oilGoodsCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "originPostalCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "pLAQUE_ID": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "pLAQUE_SN": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "receiverNationalID": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "senderNationalID": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "shomarehHavaleh": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int64" } }, "nullable": true }, { "required": [ "sandbox" ], "type": "object", "properties": { "sandbox": { "type": "boolean" }, "service": { "type": "string" }, "message": { "type": "string" } } } ], "nullable": true }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } } } } } }, "401": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "402": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "403": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "409": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "422": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "429": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "502": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "503": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "504": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/v1/waybills/by-plate": { "post": { "tags": [ "ApiV1Waybills" ], "summary": "بارنامه با پلاک", "description": "آخرین بارنامه قابل دریافت ناوگان در ۱۰ روز گذشته بر اساس اجزای پلاک ایرانی؛ طبق مستند V03 راهداری.\nRequired scope: waybills:read\nUpstream: GetBillOfLadingByPlaque", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "Reuse for the same API key, endpoint and parameters. In-progress duplicates return 409; completed responses replay without billing.", "schema": { "maxLength": 100, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BarBan.Api.Controllers.ApiV1WaybillsController.PlateLookupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BarBan.Api.Controllers.ApiV1WaybillsController.PlateLookupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BarBan.Api.Controllers.ApiV1WaybillsController.PlateLookupRequest" } } } }, "responses": { "200": { "description": "Completed inquiry. Usage follows the purchased metering policy. Sandbox data is explicitly marked.", "content": { "application/json": { "schema": { "required": [ "requestId", "found" ], "type": "object", "properties": { "requestId": { "type": "string" }, "found": { "type": "boolean" }, "sandbox": { "type": "boolean", "description": "True only for test keys; no live upstream inquiry. Quota consumption follows the purchased sandbox and metering policy." }, "data": { "anyOf": [ { "type": "object", "properties": { "ChangeStatusDate": { "type": "object", "properties": { "Day": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "Month": { "type": "integer", "description": "فیلد قرارداد راهداری", "nullable": true }, "Year": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "Company": { "type": "object", "properties": { "Branch": { "type": "object", "properties": { "ID": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int64" }, "Name": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "Code": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "LOCATION": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "Name": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NationalCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int64" }, "SARASARY": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "CompanyCommission": { "type": "number", "description": "فیلد قرارداد راهداری" }, "CompanyCommissionPercent": { "type": "number", "description": "فیلد قرارداد راهداری" }, "Cost": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int64" }, "CustomInfo": { "type": "object", "properties": { "Code": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "KootajDate": { "type": "string", "description": "فیلد قرارداد راهداری", "format": "date-time" }, "KootajNo": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "Description": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "DestinationCityCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "DestinationCityName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "DischargeCost": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "DriverCommission": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "FirstDriver": { "type": "object", "properties": { "BirthCityCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "BirthCityName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "CardNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "CardValidationDate": { "type": "object", "properties": { "Day": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "Month": { "type": "integer", "description": "فیلد قرارداد راهداری", "nullable": true }, "Year": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "CertifcateIssueCityCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "CertifcateIssueCityName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "CertifcateNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Driver_Type": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Family": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "FatherName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "IdentifierNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "InsuranceBranch": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "InsuranceId": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "IsActive": { "type": "boolean", "description": "فیلد قرارداد راهداری" }, "Mobile": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NOVE_GAVAHINAMEH": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Name": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NationalId": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "TARIKH_ETEBAR_KART_SALAMAT": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "FreighterFullInfo": { "type": "object", "properties": { "BARGIR_ID": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int64" }, "CardNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "IsActive": { "type": "boolean", "description": "فیلد قرارداد راهداری" }, "LOADER_LINK_TYPE": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "LoadingTypeCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "LoadingTypeTitle": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "MadeYear": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "Mobile": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NOVE_GAVAHINAMEH": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NOVE_NAVGAN_BARI": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "PlaqueCityCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "PlaqueCityName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "PlaqueNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "PlaqueSerialNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "PlaqueType": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "TARIKH_ETEBAR_MOAYENE_FANI": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "VINCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "YearType": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "GoodInfoList": { "type": "array", "items": { "type": "object", "properties": { "GoodTitle": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "GoodTypeCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "HSCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "HSTarrifTitle": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "IranCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "MeghdareTabieiLitr": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "PackingTitle": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "PackingTypeCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "Value": { "type": "number", "description": "فیلد قرارداد راهداری" }, "VazneMakhsoos": { "type": "number", "description": "فیلد قرارداد راهداری" }, "Weight": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" } } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "InsuranceCompany": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "InsuranceCost": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int64" }, "InsuranceNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "IssuDate": { "type": "object", "properties": { "Day": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "Month": { "type": "integer", "description": "فیلد قرارداد راهداری", "nullable": true }, "Year": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "IssueTime": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "KalaDesc": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "LanderTitle": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "LanderTypeCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "LoadingCost": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "MasterBillofLadingTraceCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Number": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int64" }, "OriginCityCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "OriginCityName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "PayanehCost": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "Serial": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Status": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Tax": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "TotalCost": { "type": "number", "description": "فیلد قرارداد راهداری" }, "TransitTypeTitle": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Receiver": { "type": "object", "properties": { "Name": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NationalCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "PostalCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "LastName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "ReceiverAddress": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Robari": { "type": "boolean", "description": "فیلد قرارداد راهداری" }, "Sender": { "type": "object", "properties": { "Name": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NationalCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "PostalCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "LastName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "SenderAddress": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "ShomarehHavalehAnbarNaft": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int64" }, "TraceCode": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "TransitTypecode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "WeighbridgeCost": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "secondDriver": { "type": "object", "properties": { "BirthCityCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "BirthCityName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "CardNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "CardValidationDate": { "type": "object", "properties": { "Day": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "Month": { "type": "integer", "description": "فیلد قرارداد راهداری", "nullable": true }, "Year": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" } }, "description": "فیلد قرارداد راهداری", "nullable": true }, "CertifcateIssueCityCode": { "type": "integer", "description": "فیلد قرارداد راهداری", "format": "int32" }, "CertifcateIssueCityName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "CertifcateNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Driver_Type": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Family": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "FatherName": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "IdentifierNumber": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "InsuranceBranch": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "InsuranceId": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "IsActive": { "type": "boolean", "description": "فیلد قرارداد راهداری" }, "Mobile": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NOVE_GAVAHINAMEH": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "Name": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "NationalId": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true }, "TARIKH_ETEBAR_KART_SALAMAT": { "type": "string", "description": "فیلد قرارداد راهداری", "nullable": true } }, "description": "فیلد قرارداد راهداری", "nullable": true } }, "nullable": true }, { "required": [ "sandbox" ], "type": "object", "properties": { "sandbox": { "type": "boolean" }, "service": { "type": "string" }, "message": { "type": "string" } } } ], "nullable": true }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } } } } } }, "401": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "402": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "403": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "409": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "422": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "429": { "description": "Authentication, authorization, subscription, idempotency, input or quota error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "502": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "503": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } }, "504": { "description": "Upstream failure, disabled service or abandoned request. Usage follows the purchased metering policy.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "upstreamCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Numeric codes from structured RMTO faults or business results; no raw provider text. Unknown codes retain a safe generic message." } }, "nullable": true } ] }, "code": { "type": "string" }, "requestId": { "type": "string" } } } } } } }, "security": [ { "ApiKey": [ ] } ] } }, "/api/enterprise/plans": { "get": { "tags": [ "Enterprise" ], "responses": { "200": { "description": "OK" } } } }, "/api/enterprise/payments/verify": { "post": { "tags": [ "Enterprise" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BarBan.Api.Controllers.EnterpriseController.VerifyPaymentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BarBan.Api.Controllers.EnterpriseController.VerifyPaymentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BarBan.Api.Controllers.EnterpriseController.VerifyPaymentRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/organizations/{id}/credit": { "get": { "tags": [ "OrganizationCredit" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/organizations/{id}/credit/payg": { "put": { "tags": [ "OrganizationCredit" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BarBan.Api.Controllers.OrganizationCreditController.PaygRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BarBan.Api.Controllers.OrganizationCreditController.PaygRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BarBan.Api.Controllers.OrganizationCreditController.PaygRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/organizations/{id}/credit/topups": { "post": { "tags": [ "OrganizationCredit" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BarBan.Api.Controllers.OrganizationCreditController.TopUpRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BarBan.Api.Controllers.OrganizationCreditController.TopUpRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BarBan.Api.Controllers.OrganizationCreditController.TopUpRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/organizations/{id}/credit/entries": { "get": { "tags": [ "OrganizationCredit" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 25 } }, { "name": "kind", "in": "query", "schema": { "type": "string" } }, { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "schema": { "type": "string", "default": "desc" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/organizations/{id}/credit/entries/export": { "get": { "tags": [ "OrganizationCredit" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "kind", "in": "query", "schema": { "type": "string" } }, { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "asJson", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK" } } } }, "/api/organizations": { "get": { "tags": [ "Organizations" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Organizations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BarBan.Api.Controllers.OrganizationsController.CreateOrganizationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BarBan.Api.Controllers.OrganizationsController.CreateOrganizationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BarBan.Api.Controllers.OrganizationsController.CreateOrganizationRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/organizations/{organizationId}": { "get": { "tags": [ "Organizations" ], "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "patch": { "tags": [ "Organizations" ], "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BarBan.Api.Controllers.OrganizationsController.RenameOrganizationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BarBan.Api.Controllers.OrganizationsController.RenameOrganizationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BarBan.Api.Controllers.OrganizationsController.RenameOrganizationRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/organizations/{organizationId}/legal-profile": { "put": { "tags": [ "Organizations" ], "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BarBan.Api.Controllers.OrganizationsController.UpdateLegalProfileRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BarBan.Api.Controllers.OrganizationsController.UpdateLegalProfileRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BarBan.Api.Controllers.OrganizationsController.UpdateLegalProfileRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/organizations/{organizationId}/members": { "get": { "tags": [ "Organizations" ], "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Organizations" ], "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BarBan.Api.Controllers.OrganizationsController.AddMemberRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BarBan.Api.Controllers.OrganizationsController.AddMemberRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BarBan.Api.Controllers.OrganizationsController.AddMemberRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/organizations/{organizationId}/members/{memberId}": { "patch": { "tags": [ "Organizations" ], "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "memberId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BarBan.Api.Controllers.OrganizationsController.UpdateMemberRoleRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BarBan.Api.Controllers.OrganizationsController.UpdateMemberRoleRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BarBan.Api.Controllers.OrganizationsController.UpdateMemberRoleRequest" } } } }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Organizations" ], "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "memberId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/organizations/{organizationId}/api-keys": { "get": { "tags": [ "Organizations" ], "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Organizations" ], "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BarBan.Api.Controllers.OrganizationsController.CreateApiKeyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BarBan.Api.Controllers.OrganizationsController.CreateApiKeyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BarBan.Api.Controllers.OrganizationsController.CreateApiKeyRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/organizations/{organizationId}/api-keys/{credentialId}": { "put": { "tags": [ "Organizations" ], "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "credentialId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BarBan.Api.Controllers.OrganizationsController.UpdateApiKeyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BarBan.Api.Controllers.OrganizationsController.UpdateApiKeyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BarBan.Api.Controllers.OrganizationsController.UpdateApiKeyRequest" } } } }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Organizations" ], "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "credentialId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/organizations/{organizationId}/api-keys/{credentialId}/network": { "put": { "tags": [ "Organizations" ], "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "credentialId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BarBan.Api.Controllers.OrganizationsController.KeyNetworkRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BarBan.Api.Controllers.OrganizationsController.KeyNetworkRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BarBan.Api.Controllers.OrganizationsController.KeyNetworkRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/organizations/{organizationId}/api-keys/{credentialId}/delete": { "post": { "tags": [ "Organizations" ], "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "credentialId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/organizations/{organizationId}/api-keys/{credentialId}/rotate": { "post": { "tags": [ "Organizations" ], "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "credentialId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/organizations/{organizationId}/subscriptions": { "post": { "tags": [ "Organizations" ], "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BarBan.Api.Controllers.OrganizationsController.SubscribeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BarBan.Api.Controllers.OrganizationsController.SubscribeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BarBan.Api.Controllers.OrganizationsController.SubscribeRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/organizations/{organizationId}/invoices": { "get": { "tags": [ "Organizations" ], "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/organizations/{organizationId}/invoices/{invoiceId}": { "get": { "tags": [ "Organizations" ], "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/organizations/{organizationId}/invoices/{invoiceId}/payment": { "post": { "tags": [ "Organizations" ], "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/organizations/{organizationId}/invoices/{invoiceId}/payment/recover": { "post": { "tags": [ "Organizations" ], "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/organizations/{organizationId}/invoices/{invoiceId}/print": { "get": { "tags": [ "Organizations" ], "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/organizations/{organizationId}/usage": { "get": { "tags": [ "OrganizationUsage" ], "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "keyId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "endpoint", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 25 } } ], "responses": { "200": { "description": "OK" } } } }, "/api/organizations/{organizationId}/usage/export": { "get": { "tags": [ "OrganizationUsage" ], "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "keyId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "endpoint", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/public/base-info": { "get": { "tags": [ "ReferenceData" ], "responses": { "200": { "description": "OK" } } } }, "/api/public/base-info/{kind}": { "get": { "tags": [ "ReferenceData" ], "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "q", "in": "query", "schema": { "maxLength": 100, "minLength": 0, "type": "string" } }, { "name": "page", "in": "query", "schema": { "maximum": 100000, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "maximum": 50, "minimum": 1, "type": "integer", "format": "int32", "default": 20 } }, { "name": "parentId", "in": "query", "schema": { "maxLength": 100, "minLength": 0, "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/public/base-info/{kind}/{code}": { "get": { "tags": [ "ReferenceData" ], "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "BarBan.Api.Controllers.AdminAgencyController.BankRequest": { "type": "object", "properties": { "Reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.AdminAgencyController.PolicyRequest": { "type": "object", "properties": { "Enabled": { "type": "boolean" }, "DefaultBasisPoints": { "type": "integer", "format": "int32" }, "HoldDays": { "type": "integer", "format": "int32" }, "MinimumPayoutRial": { "type": "string", "nullable": true }, "RelationshipDays": { "type": "integer", "format": "int32" }, "Coins": { "type": "boolean" }, "Subscriptions": { "type": "boolean" }, "WalletTopups": { "type": "boolean" }, "ManualPayments": { "type": "boolean" }, "Version": { "type": "string", "format": "date-time", "nullable": true }, "Reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.AdminAuthController.OtpRequest": { "type": "object", "properties": { "Phone": { "type": "string", "nullable": true }, "Code": { "type": "string", "nullable": true }, "RememberMe": { "type": "boolean" } }, "additionalProperties": false }, "BarBan.Api.Controllers.AdminBackupsController.DeleteRequest": { "type": "object", "properties": { "Reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.AdminController.ActiveRequest": { "type": "object", "properties": { "Active": { "type": "boolean" }, "Version": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.AdminController.KeyNetworkRequest": { "type": "object", "properties": { "AllowedIpRanges": { "type": "array", "items": { "type": "string" }, "nullable": true }, "Version": { "type": "integer", "format": "int64" }, "Reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.AdminController.KeyRequest": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "IsLive": { "type": "boolean" }, "ExpiresAtUtc": { "type": "string", "format": "date-time", "nullable": true }, "Scopes": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.AdminController.LeadRequest": { "type": "object", "properties": { "Status": { "type": "string", "nullable": true }, "Version": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.AdminController.LegalRequest": { "type": "object", "properties": { "Profile": { "$ref": "#/components/schemas/BarBan.Application.Enterprise.LegalProfileDto" }, "Version": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.AdminController.MemberRequest": { "type": "object", "properties": { "Phone": { "type": "string", "nullable": true }, "Role": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.AdminController.MemberRoleRequest": { "type": "object", "properties": { "Role": { "type": "string", "nullable": true }, "Version": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "BarBan.Api.Controllers.AdminController.OrganizationRequest": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "Slug": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.AdminController.PackageRequest": { "type": "object", "properties": { "Code": { "type": "string", "nullable": true }, "Title": { "type": "string", "nullable": true }, "Coins": { "type": "integer", "format": "int32" }, "PriceRial": { "type": "integer", "format": "int64" }, "DiscountPct": { "type": "integer", "format": "int32" }, "Badge": { "type": "string", "nullable": true }, "BazaarSku": { "type": "string", "nullable": true }, "MyketSku": { "type": "string", "nullable": true }, "Order": { "type": "integer", "format": "int32" }, "Active": { "type": "boolean" }, "Version": { "type": "string", "format": "date-time", "nullable": true }, "Catalog": { "$ref": "#/components/schemas/BarBan.Domain.Entities.CatalogUpdate" } }, "additionalProperties": false }, "BarBan.Api.Controllers.AdminController.PlanRequest": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "MonthlyRial": { "type": "integer", "format": "int64" }, "IncludedRequests": { "type": "integer", "format": "int32" }, "OverageRial": { "type": "integer", "format": "int64" }, "Rpm": { "type": "integer", "format": "int32" }, "MaxKeys": { "type": "integer", "format": "int32" }, "TrialDays": { "type": "integer", "format": "int32" }, "TaxBp": { "type": "integer", "format": "int32" }, "AllowOverage": { "type": "boolean" }, "Active": { "type": "boolean" }, "Version": { "type": "string", "format": "date-time", "nullable": true }, "Catalog": { "$ref": "#/components/schemas/BarBan.Domain.Entities.CatalogUpdate" } }, "additionalProperties": false }, "BarBan.Api.Controllers.AdminController.SubscriptionRequest": { "type": "object", "properties": { "PlanCode": { "type": "string", "nullable": true }, "BillingPeriod": { "type": "string", "nullable": true }, "ExpectedPriceRial": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.AdminController.VerifyRequest": { "type": "object", "properties": { "Authority": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.AdminController.VersionRequest": { "type": "object", "properties": { "Version": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "BarBan.Api.Controllers.AdminCouponsController.CouponRequest": { "type": "object", "properties": { "Code": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true }, "DiscountKind": { "type": "string", "nullable": true }, "Value": { "type": "integer", "format": "int64" }, "MaxDiscountRial": { "type": "integer", "format": "int64", "nullable": true }, "MinimumOrderRial": { "type": "integer", "format": "int64", "nullable": true }, "MaxRedemptions": { "type": "integer", "format": "int32", "nullable": true }, "MaxRedemptionsPerUser": { "type": "integer", "format": "int32", "nullable": true }, "Scope": { "type": "string", "nullable": true }, "PackageCode": { "type": "string", "nullable": true }, "StartsAtUtc": { "type": "string", "format": "date-time" }, "EndsAtUtc": { "type": "string", "format": "date-time", "nullable": true }, "IsActive": { "type": "boolean" }, "Version": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.AdminCouponsController.DeleteRequest": { "type": "object", "properties": { "Version": { "type": "string", "format": "date-time" }, "Reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.AdminEnterpriseWalletController.PolicyRequest": { "type": "object", "properties": { "Enabled": { "type": "boolean" }, "RateRial": { "type": "string", "nullable": true }, "RequestsPerMinute": { "type": "integer", "format": "int32" }, "MaxApiKeys": { "type": "integer", "format": "int32" }, "Version": { "type": "string", "format": "date-time", "nullable": true }, "Reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.AdminFollowUpsController.UpdateFollowUp": { "type": "object", "properties": { "Version": { "type": "integer", "format": "int32" }, "Owner": { "type": "string", "nullable": true }, "DueAt": { "type": "string", "format": "date-time", "nullable": true }, "State": { "type": "string", "nullable": true }, "Note": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.AdminNotificationCampaignsController.CampaignRequest": { "type": "object", "properties": { "IdempotencyKey": { "type": "string", "nullable": true }, "Code": { "type": "string", "nullable": true }, "AllUsers": { "type": "boolean" }, "UserIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "ExpectedRecipients": { "type": "integer", "format": "int32" }, "Title": { "type": "string", "nullable": true }, "ScheduledAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "BarBan.Api.Controllers.AdminNotificationWorkflowsController.CreateRequest": { "type": "object", "properties": { "Kind": { "type": "string", "nullable": true }, "UserId": { "type": "string", "format": "uuid" }, "OrganizationId": { "type": "string", "format": "uuid", "nullable": true }, "Title": { "type": "string", "nullable": true }, "Text": { "type": "string", "nullable": true }, "State": { "type": "string", "nullable": true }, "ExpiresAtUtc": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.AdminNotificationWorkflowsController.UpdateRequest": { "type": "object", "properties": { "Version": { "type": "integer", "format": "int32" }, "State": { "type": "string", "nullable": true }, "Text": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.AdminOperationsController.CreditRequest": { "type": "object", "properties": { "IdempotencyKey": { "type": "string", "nullable": true }, "Kind": { "type": "string", "nullable": true }, "UserId": { "type": "string", "format": "uuid", "nullable": true }, "OrganizationId": { "type": "string", "format": "uuid", "nullable": true }, "AmountRial": { "type": "integer", "format": "int64" }, "Coins": { "type": "integer", "format": "int32" }, "Requests": { "type": "integer", "format": "int32" }, "Reference": { "type": "string", "nullable": true }, "Reason": { "type": "string", "nullable": true }, "InvoiceId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.AdminOperationsController.CustomPlanRequest": { "type": "object", "properties": { "IdempotencyKey": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true }, "MonthlyRial": { "type": "integer", "format": "int64" }, "IncludedRequests": { "type": "integer", "format": "int32" }, "OverageRial": { "type": "integer", "format": "int64" }, "Rpm": { "type": "integer", "format": "int32" }, "MaxKeys": { "type": "integer", "format": "int32" }, "TaxBp": { "type": "integer", "format": "int32" }, "AllowOverage": { "type": "boolean" }, "DurationDays": { "type": "integer", "format": "int32" }, "ReplaceExisting": { "type": "boolean" }, "Reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.AdminRecordLifecycleController.ChangeRequest": { "type": "object", "properties": { "Version": { "type": "string", "format": "date-time" }, "Reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.AdminRecordLifecycleController.RenameRequest": { "type": "object", "properties": { "Version": { "type": "string", "format": "date-time" }, "Name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.AdminRecordManagementController.ActiveRequest": { "type": "object", "properties": { "Active": { "type": "boolean" }, "Version": { "type": "string", "format": "date-time" }, "Reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.AdminRecordManagementController.LeadUpdate": { "type": "object", "properties": { "Contact": { "$ref": "#/components/schemas/BarBan.Application.Services.AdminLeadInput" }, "Version": { "type": "string", "format": "date-time" }, "Reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.AdminSavedInquiriesController.DeleteInput": { "type": "object", "properties": { "Version": { "type": "integer", "format": "int64" }, "Reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.AdminSmsAlertsController.AcknowledgeRequest": { "type": "object", "properties": { "Version": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BarBan.Api.Controllers.AdminSmsAutomationController.RuleUpdate": { "type": "object", "properties": { "Enabled": { "type": "boolean" }, "Version": { "type": "integer", "format": "int32" }, "Settings": { "$ref": "#/components/schemas/BarBan.Application.Notifications.SmsAutomationSettings" } }, "additionalProperties": false }, "BarBan.Api.Controllers.AdminSmsController.ScheduleRequest": { "type": "object", "properties": { "IdempotencyKey": { "type": "string", "nullable": true }, "Title": { "type": "string", "nullable": true }, "Message": { "type": "string", "nullable": true }, "UserIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "ScheduledAt": { "type": "string", "format": "date-time" }, "AllUsers": { "type": "boolean" }, "ExpectedRecipients": { "type": "integer", "format": "int32", "nullable": true }, "SendNow": { "type": "boolean" }, "ProviderTemplate": { "$ref": "#/components/schemas/BarBan.Application.Notifications.SmsProviderTemplate" } }, "additionalProperties": false }, "BarBan.Api.Controllers.AdminUsersController.ActiveRequest": { "type": "object", "properties": { "Active": { "type": "boolean" }, "Version": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "BarBan.Api.Controllers.AdminUsersController.CreateRequest": { "type": "object", "properties": { "Phone": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.AgencyController.CodeRequest": { "type": "object", "properties": { "Code": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.AgencyController.TermsRequest": { "type": "object", "properties": { "Version": { "type": "integer", "format": "int64" }, "TermsVersion": { "type": "string", "nullable": true }, "Acknowledged": { "type": "boolean" } }, "additionalProperties": false }, "BarBan.Api.Controllers.AndroidAppController.DeleteRequest": { "type": "object", "properties": { "Reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.AndroidAppController.EditRequest": { "type": "object", "properties": { "ReleaseNotes": { "type": "string", "nullable": true }, "Reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.ApiV1WaybillsController.PlateLookupRequest": { "type": "object", "properties": { "PlateLeft": { "type": "string", "nullable": true }, "PlateLetter": { "type": "string", "nullable": true }, "PlateRight": { "type": "string", "nullable": true }, "PlateCity": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.AuthController.SendOtpRequest": { "type": "object", "properties": { "Phone": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.AuthController.VerifyOtpRequest": { "type": "object", "properties": { "Phone": { "type": "string", "nullable": true }, "Code": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.CouponsController.QuoteRequest": { "type": "object", "properties": { "Code": { "type": "string", "nullable": true }, "Scope": { "type": "string", "nullable": true }, "PackageCode": { "type": "string", "nullable": true }, "AmountRial": { "type": "integer", "format": "int64" }, "PlanCode": { "type": "string", "nullable": true }, "BillingPeriod": { "type": "string", "nullable": true }, "OrganizationId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.CustomerProofController.ProofRequest": { "type": "object", "properties": { "Kind": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true }, "Role": { "type": "string", "nullable": true }, "Organization": { "type": "string", "nullable": true }, "Quote": { "type": "string", "nullable": true }, "ImageUrl": { "type": "string", "nullable": true }, "WebsiteUrl": { "type": "string", "nullable": true }, "Published": { "type": "boolean" }, "ConsentConfirmed": { "type": "boolean" }, "SortOrder": { "type": "integer", "format": "int32" }, "Version": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.EnterpriseController.VerifyPaymentRequest": { "type": "object", "properties": { "Authority": { "type": "string", "nullable": true }, "Status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.FreightRouteImagesController.RouteImageRequest": { "type": "object", "properties": { "ImageUrl": { "type": "string", "nullable": true }, "AltText": { "type": "string", "nullable": true }, "Published": { "type": "boolean" }, "Version": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.LookupsController.CreateLookupRequest": { "type": "object", "properties": { "PlateLeft": { "type": "string", "nullable": true }, "PlateLetter": { "type": "string", "nullable": true }, "PlateRight": { "type": "string", "nullable": true }, "PlateCity": { "type": "string", "nullable": true }, "ExpectedCoinCost": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.NotificationsController.LinkRequest": { "type": "object", "properties": { "Kind": { "type": "string", "nullable": true }, "LookupId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.NotificationsController.PreferenceRequest": { "type": "object", "properties": { "MarketingAllowed": { "type": "boolean" }, "ServiceAllowed": { "type": "boolean" }, "ResultNotifications": { "type": "boolean" } }, "additionalProperties": false }, "BarBan.Api.Controllers.NotificationsController.ReferralRequest": { "type": "object", "properties": { "Code": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.NotificationsController.ReplyRequest": { "type": "object", "properties": { "Text": { "type": "string", "nullable": true }, "Version": { "type": "integer", "format": "int32" }, "Accepted": { "type": "boolean" } }, "additionalProperties": false }, "BarBan.Api.Controllers.NotificationsController.TicketRequest": { "type": "object", "properties": { "Title": { "type": "string", "nullable": true }, "Text": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.OrganizationCreditController.PaygRequest": { "type": "object", "properties": { "Enabled": { "type": "boolean" }, "ExpectedRateRial": { "type": "string", "nullable": true }, "Version": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "BarBan.Api.Controllers.OrganizationCreditController.TopUpRequest": { "type": "object", "properties": { "AmountRial": { "type": "string", "nullable": true }, "IdempotencyKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.OrganizationsController.AddMemberRequest": { "type": "object", "properties": { "Phone": { "type": "string", "nullable": true }, "Role": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.OrganizationsController.CreateApiKeyRequest": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "Scopes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "IsLive": { "type": "boolean" }, "ExpiresAtUtc": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.OrganizationsController.CreateOrganizationRequest": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "Slug": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.OrganizationsController.KeyNetworkRequest": { "type": "object", "properties": { "AllowedIpRanges": { "type": "array", "items": { "type": "string" }, "nullable": true }, "Version": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "BarBan.Api.Controllers.OrganizationsController.RenameOrganizationRequest": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.OrganizationsController.SubscribeRequest": { "type": "object", "properties": { "PlanCode": { "type": "string", "nullable": true }, "BillingPeriod": { "type": "string", "nullable": true }, "ExpectedPriceRial": { "type": "integer", "format": "int64", "nullable": true }, "CouponCode": { "type": "string", "nullable": true }, "ExpectedDiscountRial": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.OrganizationsController.UpdateApiKeyRequest": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "Scopes": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.OrganizationsController.UpdateLegalProfileRequest": { "type": "object", "properties": { "LegalName": { "type": "string", "nullable": true }, "NationalId": { "type": "string", "nullable": true }, "EconomicCode": { "type": "string", "nullable": true }, "RegistrationNumber": { "type": "string", "nullable": true }, "Province": { "type": "string", "nullable": true }, "City": { "type": "string", "nullable": true }, "Address": { "type": "string", "nullable": true }, "PostalCode": { "type": "string", "nullable": true }, "Phone": { "type": "string", "nullable": true }, "Email": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.OrganizationsController.UpdateMemberRoleRequest": { "type": "object", "properties": { "Role": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.PaymentsController.AckBazaarRequest": { "type": "object", "properties": { "OrderId": { "type": "string", "nullable": true }, "ProductId": { "type": "string", "nullable": true }, "PurchaseToken": { "type": "string", "nullable": true }, "OriginalJson": { "type": "string", "nullable": true }, "DataSignature": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.PaymentsController.AckMyketRequest": { "type": "object", "properties": { "OrderId": { "type": "string", "nullable": true }, "ProductId": { "type": "string", "nullable": true }, "PurchaseToken": { "type": "string", "nullable": true }, "OriginalJson": { "type": "string", "nullable": true }, "DataSignature": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.PaymentsController.CreatePaymentRequest": { "type": "object", "properties": { "PackageCode": { "type": "string", "nullable": true }, "ReturnTarget": { "type": "string", "nullable": true }, "ExpectedAmountRial": { "type": "integer", "format": "int64", "nullable": true }, "CouponCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.PaymentsController.InitBazaarRequest": { "type": "object", "properties": { "PackageCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.PaymentsController.InitMyketRequest": { "type": "object", "properties": { "PackageCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.PaymentsController.RestoreBazaarBody": { "type": "object", "properties": { "Receipts": { "type": "array", "items": { "$ref": "#/components/schemas/BarBan.Api.Controllers.PaymentsController.RestoreBazaarItem" }, "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.PaymentsController.RestoreBazaarItem": { "type": "object", "properties": { "OrderId": { "type": "string", "nullable": true }, "ProductId": { "type": "string", "nullable": true }, "PurchaseToken": { "type": "string", "nullable": true }, "OriginalJson": { "type": "string", "nullable": true }, "DataSignature": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.PaymentsController.RestoreMyketBody": { "type": "object", "properties": { "Receipts": { "type": "array", "items": { "$ref": "#/components/schemas/BarBan.Api.Controllers.PaymentsController.RestoreMyketItem" }, "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.PaymentsController.RestoreMyketItem": { "type": "object", "properties": { "OrderId": { "type": "string", "nullable": true }, "ProductId": { "type": "string", "nullable": true }, "PurchaseToken": { "type": "string", "nullable": true }, "OriginalJson": { "type": "string", "nullable": true }, "DataSignature": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.PaymentsController.StoreOutcomeBody": { "type": "object", "properties": { "Outcome": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.PaymentsController.VerifyPaymentRequest": { "type": "object", "properties": { "Authority": { "type": "string", "nullable": true }, "Status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.PublicLeadsController.CreateLeadRequest": { "type": "object", "properties": { "Type": { "type": "string", "nullable": true }, "FullName": { "type": "string", "nullable": true }, "Phone": { "type": "string", "nullable": true }, "Email": { "type": "string", "nullable": true }, "Organization": { "type": "string", "nullable": true }, "Subject": { "type": "string", "nullable": true }, "Message": { "type": "string", "nullable": true }, "Source": { "type": "string", "nullable": true }, "Details": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "Website": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.SavedInquiriesController.SelectionInput": { "type": "object", "properties": { "EventId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "BarBan.Api.Controllers.SupportTicketsController.CreateRequest": { "type": "object", "properties": { "Title": { "type": "string", "nullable": true }, "Text": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Api.Controllers.SupportTicketsController.ReplyRequest": { "type": "object", "properties": { "Text": { "type": "string", "nullable": true }, "Version": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BarBan.Application.Agency.AgencyAdminCreate": { "type": "object", "properties": { "UserId": { "type": "string", "format": "uuid" }, "Name": { "type": "string", "nullable": true }, "City": { "type": "string", "nullable": true }, "Note": { "type": "string", "nullable": true }, "Reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Application.Agency.AgencyAdminDelete": { "type": "object", "properties": { "Version": { "type": "integer", "format": "int64" }, "Reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Application.Agency.AgencyApplication": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "City": { "type": "string", "nullable": true }, "Note": { "type": "string", "nullable": true }, "Version": { "type": "integer", "format": "int64", "nullable": true }, "Acknowledged": { "type": "boolean" }, "TermsVersion": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Application.Agency.AgencyBank": { "type": "object", "properties": { "Holder": { "type": "string", "nullable": true }, "Iban": { "type": "string", "nullable": true }, "NationalId": { "type": "string", "nullable": true }, "Version": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "BarBan.Application.Agency.AgencyDecision": { "type": "object", "properties": { "Status": { "type": "string", "nullable": true }, "BasisPoints": { "type": "integer", "format": "int32", "nullable": true }, "VerifyBank": { "type": "boolean" }, "Version": { "type": "integer", "format": "int64" }, "Reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Application.Agency.AgencyPayoutDecision": { "type": "object", "properties": { "Status": { "type": "string", "nullable": true }, "Version": { "type": "integer", "format": "int64" }, "ExpectedAmountRial": { "type": "string", "nullable": true }, "Receipt": { "type": "string", "nullable": true }, "Reason": { "type": "string", "nullable": true }, "DefinitiveFailure": { "type": "boolean" }, "FailureReference": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Application.Agency.AgencyProfileUpdate": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "City": { "type": "string", "nullable": true }, "Note": { "type": "string", "nullable": true }, "Version": { "type": "integer", "format": "int64" }, "Reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Application.Agency.AgencyReversal": { "type": "object", "properties": { "IdempotencyKey": { "type": "string", "nullable": true }, "AmountRial": { "type": "string", "nullable": true }, "ExpectedRemainingRial": { "type": "string", "nullable": true }, "Reference": { "type": "string", "nullable": true }, "Reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Application.Agency.AgencyWithdrawal": { "type": "object", "properties": { "IdempotencyKey": { "type": "string", "nullable": true }, "ExpectedAmountRial": { "type": "string", "nullable": true }, "Version": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "BarBan.Application.Enterprise.DeleteOrganizationRequest": { "type": "object", "properties": { "Version": { "type": "string", "format": "date-time" }, "Snapshot": { "type": "string", "nullable": true }, "ConfirmSlug": { "type": "string", "nullable": true }, "Reason": { "type": "string", "nullable": true }, "Retention": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Application.Enterprise.LegalProfileDto": { "type": "object", "properties": { "LegalName": { "type": "string", "nullable": true }, "NationalId": { "type": "string", "nullable": true }, "EconomicCode": { "type": "string", "nullable": true }, "RegistrationNumber": { "type": "string", "nullable": true }, "Province": { "type": "string", "nullable": true }, "City": { "type": "string", "nullable": true }, "Address": { "type": "string", "nullable": true }, "PostalCode": { "type": "string", "nullable": true }, "Phone": { "type": "string", "nullable": true }, "Email": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Application.Notifications.SmsAutomationControl": { "type": "object", "properties": { "Enabled": { "type": "boolean" }, "MarketingDailyLimit": { "type": "integer", "format": "int32" }, "ServiceDailyLimit": { "type": "integer", "format": "int32" }, "Version": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BarBan.Application.Notifications.SmsAutomationSettings": { "type": "object", "properties": { "Template": { "type": "string", "nullable": true }, "DelayMinutes": { "type": "integer", "format": "int32" }, "CooldownHours": { "type": "integer", "format": "int32" }, "DailyLimit": { "type": "integer", "format": "int32" }, "SendFromHour": { "type": "integer", "format": "int32" }, "SendUntilHour": { "type": "integer", "format": "int32" }, "Threshold": { "type": "integer", "format": "int32" }, "Stages": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "DiscountRial": { "type": "integer", "format": "int64" }, "RewardCoins": { "type": "integer", "format": "int32" }, "MaximumRewards": { "type": "integer", "format": "int32" }, "OfferDays": { "type": "integer", "format": "int32" }, "OfferExpiresAtUtc": { "type": "string", "format": "date-time", "nullable": true }, "OfferPackageCode": { "type": "string", "nullable": true }, "OfferTerms": { "type": "string", "nullable": true }, "DestinationPath": { "type": "string", "nullable": true }, "StageTemplates": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "ProviderTemplate": { "$ref": "#/components/schemas/BarBan.Application.Notifications.SmsProviderTemplate" }, "StageProviderTemplates": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/BarBan.Application.Notifications.SmsProviderTemplate" }, "nullable": true }, "NamedProviderTemplate": { "$ref": "#/components/schemas/BarBan.Application.Notifications.SmsProviderTemplate" }, "StageNamedProviderTemplates": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/BarBan.Application.Notifications.SmsProviderTemplate" }, "nullable": true } }, "additionalProperties": false }, "BarBan.Application.Notifications.SmsProviderTemplate": { "type": "object", "properties": { "TemplateId": { "type": "integer", "format": "int32" }, "Parameters": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "BarBan.Application.Services.AdminLeadInput": { "type": "object", "properties": { "Type": { "type": "string", "nullable": true }, "FullName": { "type": "string", "nullable": true }, "Phone": { "type": "string", "nullable": true }, "Email": { "type": "string", "nullable": true }, "Organization": { "type": "string", "nullable": true }, "Subject": { "type": "string", "nullable": true }, "Message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Application.Services.AdminRecordChange": { "type": "object", "properties": { "Version": { "type": "string", "format": "date-time" }, "Reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Application.Users.AdminSavedInquiryChange": { "type": "object", "properties": { "Value": { "type": "string", "nullable": true }, "Title": { "type": "string", "nullable": true }, "Version": { "type": "integer", "format": "int64" }, "Reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Application.Users.ConsumerProfileInput": { "type": "object", "properties": { "FirstName": { "type": "string", "nullable": true }, "LastName": { "type": "string", "nullable": true }, "NationalId": { "type": "string", "nullable": true }, "BirthDate": { "type": "string", "nullable": true }, "AvatarDataUrl": { "type": "string", "nullable": true }, "Version": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BarBan.Application.Users.SaveInquiryInput": { "type": "object", "properties": { "Kind": { "type": "string", "nullable": true }, "Value": { "type": "string", "nullable": true }, "Title": { "type": "string", "nullable": true }, "Version": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "BarBan.Domain.Entities.CatalogFeature": { "type": "object", "properties": { "Title": { "type": "string", "nullable": true }, "Enabled": { "type": "boolean" }, "SortOrder": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BarBan.Domain.Entities.CatalogUpdate": { "type": "object", "properties": { "Slug": { "type": "string", "nullable": true }, "ShortDescription": { "type": "string", "nullable": true }, "BadgeText": { "type": "string", "nullable": true }, "BadgeType": { "type": "string", "nullable": true }, "IsFeatured": { "type": "boolean" }, "IsVisible": { "type": "boolean" }, "CtaText": { "type": "string", "nullable": true }, "CtaUrl": { "type": "string", "nullable": true }, "PricingMode": { "type": "string", "nullable": true }, "CampaignStartAt": { "type": "string", "format": "date-time", "nullable": true }, "CampaignEndAt": { "type": "string", "format": "date-time", "nullable": true }, "CampaignPrice": { "type": "integer", "format": "int64", "nullable": true }, "CampaignBadge": { "type": "string", "nullable": true }, "AnnualPrice": { "type": "integer", "format": "int64", "nullable": true }, "MonthlyEnabled": { "type": "boolean" }, "AnnualEnabled": { "type": "boolean" }, "AnnualBadge": { "type": "string", "nullable": true }, "MeteringMode": { "type": "string", "nullable": true }, "TrialRequestQuota": { "type": "integer", "format": "int32" }, "SandboxEnabled": { "type": "boolean" }, "SandboxUnlimited": { "type": "boolean" }, "OverageHardLimit": { "type": "integer", "format": "int32", "nullable": true }, "RequestsPerSecond": { "type": "integer", "format": "int32", "nullable": true }, "RequestsPerDay": { "type": "integer", "format": "int32", "nullable": true }, "IpWhitelistEnabled": { "type": "boolean" }, "SlaLevel": { "type": "string", "nullable": true }, "SupportLevel": { "type": "string", "nullable": true }, "MinimumCommitmentMonths": { "type": "integer", "format": "int32", "nullable": true }, "PriceLockMonths": { "type": "integer", "format": "int32", "nullable": true }, "TargetAudience": { "type": "string", "nullable": true }, "EnterpriseMinVolume": { "type": "integer", "format": "int32", "nullable": true }, "CompareAtPrice": { "type": "integer", "format": "int64", "nullable": true }, "DiscountLabel": { "type": "string", "nullable": true }, "SavingLabel": { "type": "string", "nullable": true }, "ImportantNote": { "type": "string", "nullable": true }, "BonusCoins": { "type": "integer", "format": "int32" }, "OriginalPrice": { "type": "integer", "format": "int64", "nullable": true }, "MaxPurchasePerUser": { "type": "integer", "format": "int32", "nullable": true }, "MaxPurchasePerMonth": { "type": "integer", "format": "int32", "nullable": true }, "ValidityDays": { "type": "integer", "format": "int32", "nullable": true }, "DisplayOrder": { "type": "integer", "format": "int32", "nullable": true }, "Features": { "type": "array", "items": { "$ref": "#/components/schemas/BarBan.Domain.Entities.CatalogFeature" }, "nullable": true } }, "additionalProperties": false }, "BarBan.Infrastructure.External.SmsIr.SmsTextSettingsStore.Settings": { "type": "object", "properties": { "Enabled": { "type": "boolean" }, "ServiceLineNumber": { "type": "string", "nullable": true }, "UpdatedAtUtc": { "type": "string", "format": "date-time", "nullable": true }, "OtpTemplateId": { "type": "string", "nullable": true }, "OtpText": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarBan.Infrastructure.Notifications.AdminSmsControl": { "type": "object", "properties": { "Enabled": { "type": "boolean" }, "RecipientUserIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "DailyLimit": { "type": "integer", "format": "int32" }, "Version": { "type": "integer", "format": "int32" }, "ScenarioRecipients": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "nullable": true }, "CriticalReserve": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BarBan.Infrastructure.Notifications.SmsScenarioTestRequest": { "type": "object", "properties": { "IdempotencyKey": { "type": "string", "nullable": true }, "Mode": { "type": "string", "nullable": true }, "Version": { "type": "integer", "format": "int32" }, "Stage": { "type": "integer", "format": "int32", "nullable": true }, "Variables": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "Personalized": { "type": "boolean" } }, "additionalProperties": false }, "BarBan.Infrastructure.Services.BackupManager.Schedule": { "type": "object", "properties": { "Frequency": { "type": "string", "nullable": true }, "Time": { "type": "string", "nullable": true }, "TimeZoneId": { "type": "string", "nullable": true }, "DaysOfWeek": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "Enabled": { "type": "boolean" }, "RetentionDays": { "type": "integer", "format": "int32" }, "RetentionCount": { "type": "integer", "format": "int32" }, "LastRunAtUtc": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "BarBan.Infrastructure.Services.SiteContentStore.CreditPolicyDto": { "type": "object", "properties": { "LookupCostCoins": { "type": "integer", "format": "int32" }, "WelcomeCoins": { "type": "integer", "format": "int32" }, "UpdatedAtUtc": { "type": "string", "format": "date-time", "nullable": true }, "ProfileCompletionRewardCoins": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "BarBan.Infrastructure.Services.SiteContentStore.ServiceSettingsDto": { "type": "object", "properties": { "UpdatedAtUtc": { "type": "string", "format": "date-time", "nullable": true }, "Enabled": { "type": "boolean", "nullable": true }, "PriceCoins": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "http", "description": "JWT Authorization header. Example: \"Bearer {token}\"", "scheme": "bearer", "bearerFormat": "JWT" }, "ApiKey": { "type": "apiKey", "description": "Organization secret API key; required scope is specified per inquiry.", "name": "X-API-Key", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }