1099Policy API documentation

Mar 7, 2024

1.8.0

Change #866783ef

Breaking

API structure has changed

Add support for step on Session
Add support for custom_metadata on Job

28 structure changes including:

Modifications

Modified

GET /api/v1/apply/sessions
- Response
  - 200 response
    - application/json content type
GET /api/v1/apply/sessions/{session_id}
- Response
  - 200 response
    - application/json content type
      - id property
        
        Created alternative
        
        string-2 alternative
      - step property
GET /api/v1/assignments/{assignment_id}
- Response
  - 200 response
    - application/json content type
      - created property
        
        Certificate alternative
        
        Created alternative
      - eligible property
        
        Certificate alternative
        
        Eligible alternative
      - id property
        
        Certificate alternative
        
        string-2 alternative
GET /api/v1/contractors/{contractor_id}
- Response
  - 200 response
    - application/json content type
      - created property
        
        Address alternative
        
        Created alternative
      - id property
        
        Address alternative
        
        string-2 alternative
GET /api/v1/entities/{entity_id}
- Response
  - 200 response
    - application/json content type
      - coverage_limit property
        
        Address alternative
        
        Limit alternative
      - created property
        
        Address alternative
        
        Created alternative
      - id property
        
        Address alternative
        
        string-2 alternative
GET /api/v1/events/{event_id}
- Response
  - 200 response
    - application/json content type
      - data property
        
        Created alternative
        
        object-2 alternative
      - id property
        
        Created alternative
        
        object-2 alternative
GET /api/v1/invoices/{invoice_id}
- Response
  - 200 response
    - application/json content type
      - id property
        
        Created alternative
        
        string-2 alternative
GET /api/v1/jobs
- Response
  - 200 response
    - application/json content type
GET /api/v1/jobs/{job_id}
- Response
  - 200 response
    - application/json content type
      - created property
        
        Address alternative
        
        Created alternative
      - id property
        
        Address alternative
        
        string-2 alternative
      - custom_metadata property
GET /api/v1/policies/{policy_id}
- Response
  - 200 response
    - application/json content type
      - created property
        
        Certificate alternative
        
        Created alternative
      - id property
        
        Certificate alternative
        
        string-2 alternative
GET /api/v1/quotes
- Response
  - 200 response
    - application/json content type
GET /api/v1/quotes/{quote_id}
- Response
  - 200 response
    - application/json content type
      - contractor property
      - coverage_type property
        
        Contractor alternative
        
        Coverage alternative
      - created property
        
        Contractor alternative
        
        Created alternative
      - id property
        
        Contractor alternative
        
        string-2 alternative
      - job property
        
        Contractor alternative
        
        Job alternative
POST /api/v1/apply/sessions
- Response
  - 201 response
    - application/json content type
      - id property
        
        Created alternative
        
        string-2 alternative
      - step property
POST /api/v1/apply/sessions/{session_id}/expire
- Response
  - 200 response
    - application/json content type
      - id property
        
        Created alternative
        
        string-2 alternative
      - step property
POST /api/v1/assignments
- Response
  - 201 response
    - application/json content type
      - created property
        
        Certificate alternative
        
        Created alternative
      - eligible property
        
        Certificate alternative
        
        Eligible alternative
      - id property
        
        Certificate alternative
        
        string-2 alternative
POST /api/v1/contractors
- Response
  - 201 response
    - application/json content type
      - created property
        
        Address alternative
        
        Created alternative
      - id property
        
        Address alternative
        
        string-2 alternative
POST /api/v1/entities
- Body
  - application/json content type
    - coverage_limit property
      - Address alternative
      - Limit alternative
    - required_coverage property
      - Address alternative
      - Coverage alternative
- Response
  - 201 response
    - application/json content type
      - coverage_limit property
        
        Address alternative
        
        Limit alternative
      - created property
        
        Address alternative
        
        Created alternative
      - id property
        
        Address alternative
        
        string-2 alternative
POST /api/v1/invoices
- Response
  - 201 response
    - application/json content type
      - id property
        
        Created alternative
        
        string-2 alternative
POST /api/v1/jobs
- Body
  - application/json content type
    - custom_metadata property
- Response
  - 201 response
    - application/json content type
      - created property
        
        Address alternative
        
        Created alternative
      - id property
        
        Address alternative
        
        string-2 alternative
      - custom_metadata property
POST /api/v1/policies
- Response
  - 201 response
    - application/json content type
      - created property
        
        Certificate alternative
        
        Created alternative
      - id property
        
        Certificate alternative
        
        string-2 alternative
POST /api/v1/quotes
- Response
  - 201 response
    - application/json content type
      - contractor property
      - coverage_type property
        
        Contractor alternative
        
        Coverage alternative
      - created property
        
        Contractor alternative
        
        Created alternative
      - id property
        
        Contractor alternative
        
        string-2 alternative
      - job property
        
        Contractor alternative
        
        Job alternative
PUT /api/v1/assignments/{assignment_id}
- Body
  - application/json content type
    - created property
      - Certificate alternative
      - Created alternative
    - eligible property
      - Certificate alternative
      - Eligible alternative
    - id property
      - Certificate alternative
      - string-2 alternative
- Response
  - 200 response
    - application/json content type
      - created property
        
        Certificate alternative
        
        Created alternative
      - eligible property
        
        Certificate alternative
        
        Eligible alternative
      - id property
        
        Certificate alternative
        
        string-2 alternative
PUT /api/v1/contractors/{contractor_id}
- Body
  - application/json content type
    - created property
      - Address alternative
      - Created alternative
    - id property
      - Address alternative
      - string-2 alternative
- Response
  - 200 response
    - application/json content type
      - created property
        
        Address alternative
        
        Created alternative
      - id property
        
        Address alternative
        
        string-2 alternative
PUT /api/v1/entities/{entity_id}
- Body
  - application/json content type
    - coverage_limit property
      - Address alternative
      - Limit alternative
    - created property
      - Address alternative
      - Created alternative
    - id property
      - Address alternative
      - string-2 alternative
- Response
  - 200 response
    - application/json content type
      - coverage_limit property
        
        Address alternative
        
        Limit alternative
      - created property
        
        Address alternative
        
        Created alternative
      - id property
        
        Address alternative
        
        string-2 alternative
PUT /api/v1/invoices/{invoice_id}
- Body
  - application/json content type
    - id property
      - Created alternative
      - string-2 alternative
- Response
  - 200 response
    - application/json content type
      - id property
        
        Created alternative
        
        string-2 alternative
PUT /api/v1/jobs/{job_id}
- Body
  - application/json content type
    - created property
      - Address alternative
      - Created alternative
    - id property
      - Address alternative
      - string-2 alternative
    - custom_metadata property
- Response
  - 200 response
    - application/json content type
      - created property
        
        Address alternative
        
        Created alternative
      - id property
        
        Address alternative
        
        string-2 alternative
      - custom_metadata property
PUT /api/v1/policies/{policy_id}
- Body
  - application/json content type
    - created property
      - Certificate alternative
      - Created alternative
    - id property
      - Certificate alternative
      - string-2 alternative
- Response
  - 200 response
    - application/json content type
      - created property
        
        Certificate alternative
        
        Created alternative
      - id property
        
        Certificate alternative
        
        string-2 alternative
PUT /api/v1/quotes/{quote_id}
- Body
  - application/json content type
    - contractor property
      - created property
        
        Address alternative
        
        Created alternative
      - id property
        
        Address alternative
        
        string-2 alternative
    - coverage_type property
      - Contractor alternative
      - Coverage alternative
    - created property
      - Contractor alternative
      - Created alternative
    - id property
      - Contractor alternative
      - string-2 alternative
    - job property
      - Contractor alternative
      - Job alternative
- Response
  - 200 response
    - application/json content type
      - contractor property
      - coverage_type property
        
        Contractor alternative
        
        Coverage alternative
      - created property
        
        Contractor alternative
        
        Created alternative
      - id property
        
        Contractor alternative
        
        string-2 alternative
      - job property
        
        Contractor alternative
        
        Job alternative