Backend App Mobile
  1. OS
Backend App Mobile
  • Healthcheck
    • Simple Healthcheck
  • App Settings
    • Feedback Negative FAQ
    • Check Update Version
    • Update App Version
    • Generate OAuth Token
    • Force Password Update
    • Check Password Update
    • Enable Feedback
    • Heap Snapshot
    • List FAQs
    • FAQ Feedback
    • Event Firebase
    • Event Firebase - Session
    • File Upload - Block By Contract
  • OS
    • Create
    • Check Anomaly
    • Available Days
    • List
    • Reschedule
    • Cancel
    • Check Status
    • Confirmation
  • Finances
    • Negotiation Parcels
    • Check Trust
    • License Trust
    • List Calls Extract
    • List History Extract
    • Download PDF Extract
    • Generate Invoices
    • Check Negociations
  • Support
    • List Available Condominiuns
    • Check House Viability
    • Check Condominium Viability
    • Support Help
  • Customer
    • Auth
      • Auth
      • Auth Token Verify (Local JWT)
      • Refresh Token
      • Token Generate
      • Token Verify
    • Email
      • Add Email
      • List Emails
      • Email Update
      • Email Delete
    • Phones
      • Phone Add
      • Phone List
      • Phone Update
      • Phone Delete
    • Popup Notifications
      • Show User Popups
      • Read Popup
      • Create user popup
    • Quick Invoice
    • Contract Details
    • Connection Status Has Notices
    • List Contracts
    • Connection Status
    • Generate Login
    • Password Update
    • Password Recovery
    • Referral (Indique um amigo)
    • Enable Collect Calls
    • Tax Notes
    • Phone Details
    • Due Date Availables
    • Change Due date
    • Request Address Change
    • Service Protocol
    • User Verify
    • File Upload
    • Paid Invoices
    • Contract Term
  • Interface
    • Privacy Policy
    • Invoices
    • Banner Blocking
    • Promo
    • Home
    • License Trust
    • Menu
    • Onboardings
    • Profile
    • Payment Methods
    • Terms and Conditions
    • Store
    • Modify Address
    • Payment Flow
    • Phone List
  • Messages
    • List Messages
    • Read a Message
    • Delete a Message
  • Resources
    • Basic Reset
    • Equipments
    • Generate QR Code
  • SVAs
    • SVA Activation Link Provider
    • SVA Activate
    • List SVAS
    • SVA Activation Link
  • Wi-FI
    • Wifi Devices List
    • Update Wifi Configuration
    • Wifi Status (Can or Not)
    • Wifi Configuration (Mocado))
  • Sales Onboarding
    • Verify Pending
    • Confirm Pending
    • Generate Token
    • Verify Token
  • Push Notifications
    • Send Notifications
  • Crypto
    • Encrypt
  • Admin
    • Auth
  • Proxy Integration
    • OS
      • [OK][CD][XB] Anticipate Available Days
        GET
      • [OK][CD][XB] Anticipate Confirmation
        POST
      • [OK][CD] Request Address Change
        POST
      • [OK][CD] List OS
        GET
      • [OK][CD] OS Create
        POST
      • [OK][CD] Reschedule
        PUT
      • [OK][CD] Cancel OS
        PUT
      • [OK][CD] Confirmation OS
        PUT
      • [OK][CD] Check OS
        GET
    • Financials
      • [OK][CD] Billing Dispute (Contestation)
      • [OK][CD] Calls Extract
      • [OK][CD] Check Trust Eligibility
      • [OK][CD] Extract PDF Calls
      • [OK][CD] Fast Access Invoice
      • [OK][CD] Paid Invoice
      • [OK][CD] List Records
      • [OK][CD] Negotiation Parcels
      • [OK][CD] Generate Payment Link
      • [OK][CD] Negotiation Check Eligibility
      • [OK][CD] Confim Negotiation
      • [OK][CD] Tax Notes
    • Contacts
      • E-mails
        • [OK][CD] List E-mails
        • [OK][CD] Add E-mails
        • [OK][CD] Delete E-mails
      • Phones
        • [OK] List Phones
        • [OK][CD] Add Phone
        • [OK][CD] Update Phone
        • [OK][CD] Delete Phone
    • Contracts
      • [OK][CD] List Products (SVAs)
      • [OK][CD] Get Activation Link Product (SVA)
      • [OK][CD] List Contracts
      • [OK][CD] Contracts Details
      • [OK][CD] Call History
      • [OK][CD] Enable Collect Calls
      • [OK][CD] List Protocols
      • [OK][CD] Phone Details
      • [OK][CD] Contract Unlock
      • [OK][CD] Contract Term
      • [OK][CD] Connection Status
      • [OK][CD] Due Date Availables
      • [OK][CD] Change Due date
      • [OK][CD] Contract Plan
      • [OK][CD] List Devices Wifi
      • [OK][CD] Update Wifi
      • [OK][CD] File Upload Payment
      • Product Subscribe
    • Messages
      • [OK][CD] Contact Withdrawal
      • [OK][CD] List Messages
      • [CD][CD] Read a Message
      • [CD][CD] Delete a Message
    • Menus
      • [OK][CD] Menu Support
      • [OK][CD] Menu Plus
    • Customers
      • [OK][CD] Generate Coupon
      • [OK][CD] Check Customer
      • [OK][CD] Password Update
      • [OK][CD] Password Reset
    • Addresses
      • [OK][CD] List Available Condominiuns
      • [OK][CD] Check Condominium Viability
      • [OK][CD] Check House Viability
    • Bookings
      • [OK][CD] Get Booking Availability
    • FAQ
      • [OK][CD] List All FAQs
      • [OK][CD] Feedback FAQ
    • Login
      • [OK][CD] Login
    • Equipaments
      • [OK][CD] Equipments
    • Config
      • [OK][CD] Check App Version
      • [OK][CD] Token Generate
      • [OK][CD] Token Confirm
      • Token Generate Recovery Password
    • Cards
      • [OK][CD] List Cards (Atalhos)
    • Sales
      • [OK][CD] Verify Pending
      • [OK][CD] Confirm Pending
      • [OK][CD] Generate Token
      • [OK][CD] Confirm Token
    • Massive Warnings
      • [OK][CD] Massive Warnings
    • Parameter
      • [OK][CD] Get parameters (force-password-update)
    • Password Update
      • [OK][CD] Password Update (se deve alterar ou não a senha)
    • Banners
      • [OK][CD] List Banners Home
      • [OK] List Warning Banners
    • Products
      • Eligibility for Product Exchange
      • Products Recommendation
  1. OS

[OK][CD] Check OS

Developing
HML
HML
GET
{{BASE_ENDPOINT}}/app/v1/service-orders/check

Request

Query Params
serviceOrderType
string 
required
Example:
REPAIR
contractId
string 
required
Example:
899059
Header Params
apiKey
string 
required
Example:
{{apiKey}}
Authorization
string 
required
Example:
{{Authorization}}

Responses

🟢200OK
application/json
Body
type
string 
required
status
string 
required
technician
null 
required
unity
string 
required
os_id
string 
required
event_id
integer 
required
conclusion_reason
null 
required
expected_installation_date
string 
required
expected_installation_turn
string 
required
expected_attendance_period
string 
required
transmission_type
string 
required
confirmation_schedule_origin
null 
required
confirmation_schedule_date
null 
required
date_able_to_reschedule
boolean 
required
reason_able_to_reschedule
boolean 
required
tracking_url
null 
required
display_tracking_button
boolean 
required
can_cancel
boolean 
required
date_confirmation
null 
required
origin_confirmation
null 
required
customer_address
object 
required
street
string 
required
neighborhood
string 
required
number
string 
required
cep
string 
required
city
string 
required
uf
string 
required
complement
string 
required
regional
string 
required
cluster
string 
required
area_code
string 
required
Example
{"type":"AGUARDANDO VISITA DO TÉCNICO","status":"ST_OS_CRIADA","technician":null,"unity":"INF","os_id":"932652","event_id":7532160,"conclusion_reason":null,"expected_installation_date":"2025-05-16","expected_installation_turn":"Manhã","expected_attendance_period":"08h às 12h","transmission_type":"FTTH","confirmation_schedule_origin":null,"confirmation_schedule_date":null,"date_able_to_reschedule":true,"reason_able_to_reschedule":false,"tracking_url":null,"display_tracking_button":false,"can_cancel":true,"date_confirmation":null,"origin_confirmation":null,"customer_address":{"street":"RUA UBELART","neighborhood":"CENTRO","number":"100","cep":"CGT","city":"CARMO","uf":"RJ","complement":"","regional":"R4","cluster":"RS4.4","area_code":"CGT"}}
Previous
[OK][CD] Confirmation OS
Next
[OK][CD] Billing Dispute (Contestation)
Built with