Download OpenAPI specification:Download
Partly's platform for integrating with our services
Completes the integration installation and API key generation for a given install. The request must provide the client secret, client ID and the access code generated during the OAuth authorization process
| access_code required | string (std.string.String) This is the access code that came as part of the redirect in step 3, access_code is a short code with a 15 minute TTL |
| client_id required | string (std.string.String) This is the identifier for your integration Contact Partly to receive integration client credentials |
| client_secret required | string (std.string.String) This is the secret provided during integration client ID / secret provisioning. |
{- "access_code": "string",
- "client_id": "string",
- "client_secret": "string"
}{- "api_key": "string",
- "integration_id": "55d7337e-1d0a-49fc-9826-925ba40df035"
}Fetches a repair job
| authorization required | string (std.string.String) UTF-8 encoded string |
| partly-integration-id required | string <uuid> (uuid.Uuid) UUID value type |
required | id (object) or external (object) (integrations_server.service.jobs.v1.model.JobIdentityV1) | ||
One of
| |||
{- "identity": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}{- "claim_number": { },
- "external_id": { },
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "images": [
- "string"
], - "job_number": { },
- "site_id": "72771e6a-6f5e-4de4-a5b9-1266c4197811",
- "status": {
- "type": "draft"
}, - "vehicle": { },
- "work_provider_id": { }
}| authorization required | string (std.string.String) UTF-8 encoded string |
| partly-integration-id required | string <uuid> (uuid.Uuid) UUID value type |
required | object (integrations_server.service.jobs.v1.model.ExternalInsertV1) |
required | id (object) or external (object) (integrations_server.service.jobs.v1.model.JobIdentityV1) |
required | object (integrations_server.service.jobs.v1.model.IfConflictOnInsert<reflectapi_ex.types_actions.IfExistsUpdateOrReplace>) |
{- "data": {
- "claim_number": { },
- "job_number": { },
- "repairer_site_id": "8630c42f-ea6f-494e-beab-eee2973dc24e",
- "vehicle": { },
- "work_provider_id": { }
}, - "identity": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "if_": {
- "exists": "update"
}
}{- "claim_number": { },
- "external_id": { },
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "images": [
- "string"
], - "job_number": { },
- "site_id": "72771e6a-6f5e-4de4-a5b9-1266c4197811",
- "status": {
- "type": "draft"
}, - "vehicle": { },
- "work_provider_id": { }
}Queue up a given vehicle VIN for future use in other Partly services.
| authorization required | string (std.string.String) UTF-8 encoded string |
| partly-integration-id required | string <uuid> (uuid.Uuid) UUID value type |
required | Array of ChassisNumber (object) or integrations_server.service.tier1.v1.model.LocationV1 (object) (integrations_server.service.tier1.v1.model.VehicleIdentifierV1) An array of vehicle identifiers to preload. Each identifier object must conform to one of the two structures detailed below (Chassis Number or VRM). Must contain between 1 and 100 identifiers. VRM (License Plate) is recommended over Chassis Number as a VRM lookup often yields better data quality and allows us to disambiguate possible vehicle variants (e.g. trim or color options) more effectively. | ||
Array One of
| |||
{- "identifiers": [
- {
- "chassis_number": "string"
}
]
}{ }