api-dev.seamgroup.com
Open in
urlscan Pro
20.119.144.12
Public Scan
URL:
https://api-dev.seamgroup.com/
Submission: On March 27 via api from US — Scanned from US
Submission: On March 27 via api from US — Scanned from US
Form analysis
0 forms found in the DOMText Content
* Introduction * Getting Started * Getting Access to the API * API Features * Authentication * Problems * ProblemCompliance * get/ProblemCompliance * get/ProblemCompliance/{id} * ProblemElectrical * get/ProblemElectrical * get/ProblemElectrical/{id} * ProblemGenericThermal * get/ProblemGenericThermal * get/ProblemGenericThermal/{id} * Picture * Picture * get/Picture/{id} * Repair * Repair * put/Repair/{id} * get/Repair/{id} Documentation Powered by ReDoc VIEWPOINT API (2021.3.3.1) Download OpenAPI specification:Download API Support: api-help@seamgroup.com INTRODUCTION The ViewPoint API is a RESTful API that facilitates access to ViewPoint data for SEAM Group customers who wish to build integrations between ViewPoint and other applications. Requests are made via HTTP and responses are in JSON format. GETTING STARTED The ViewPoint API documentation includes instructions for working with the ProblemCompliance , ProblemElectrical, ProblemGenericThermal, Picture and Repair endpoints. These instructions include a listing of the operations that can be performed on each endpoint, sample requests and responses, explanations of the different ViewPoint objects and their properties, and explanations of the possible HTTP response codes that may result from these operations. This document can be downloaded in the OpenAPI specification via the download button at the top of this page. GETTING ACCESS TO THE API In order to use the ViewPoint API, an API-enabled ViewPoint account is required. If you would like to set up an account or need help with an existing account, please submit your request to api-help@seamgroup.com and we will be happy to assist you. API FEATURES Request Throttling Concurrent calls to the API by a single user are permitted, but are throttled at 100 operations per minute, per account. If you receive HTTP/429 Too Many Requests response, then your requests are being throttled. This response also includes a Retry-After HTTP header, which is the time at which you may resume making requests. Compression The API supports compression and it is recommended that the Accept-Encoding HTTP header be set to gzip, deflate for all operations to minimize bandwidth consumption. The header may be omitted for API clients that cannot support compression. Convenience Redirects The API may perform one or more HTTP redirects, depending on the request made. There are two types of convenience redirects in the ViewPoint API. For example, when requesting a problem object, you may make a GET request: GET /en-US/2020.12.8.1/problem/f0ac0d09-6b41-4b71-ad50-100071f1f3da HTTP/1.1 And the API will respond with HTTP/1.1 301 Moved Permanently Location: /en-US/2020.12.8.1/ProblemElectrical/f0ac0d09-6b41-4b71-ad50-100071f1f3da API clients should make a new request for the URI in the Location HTTP header. This may happen automatically, depending on the library being used to make HTTP requests. If you are making a PUT or POST request, ensure that the data you are posting in the request is preserved if your HTTP library is managing the redirected request. The second type of redirect allows you to make requests without specifying an API version number and/or culture. The default culture (US English) and version (the most current version) are automatically added if missing, using redirects. The culture value is a combination of an ISO 639 two-letter lowercase culture code associated with a language and an ISO 3166 two-letter uppercase subculture code associated with a country or region. For example, you may make the GET request: GET /ProblemElectrical/f0ac0d09-6b41-4b71-ad50-100071f1f3da HTTP/1.1 And the API will respond with two redirects. HTTP/1.1 302 Found Location: /en-US/ProblemElectrical/d0ad0d09-4b41-4b71-ad50-000071f1fbda HTTP/1.1 302 Found Location: /en-US/2020.12.8.1/ProblemElectrical/d0ad0d09-4b41-4b71-ad50-000071f1fbda API Versioning When a change is made to the ViewPoint API that has been determined to cause previously developed API clients to stop working, it is isolated from the previous versions of the API. When an API client is being developed, it is recommended that the current API version be recorded as a constant so that all interactions are subsequently made using that version. This offers you some insulation from breaking changes and gives you time to adjust. Old API versions have a limited support lifetime—SEAM Group will contact API users prior to retiring old API versions that are being actively used to ensure a safe transition to a newer API version. Ordering It is strongly recommended that all requests for lists include terms that describe how the result should be ordered. Without this, the result will be returned unordered. Multiple order by terms can be used. https://api.seamgroup.com/en-US/2019.8.14.1/ProblemCompliance/?orderby=Inspection.DateFieldWorkCompleted%20desc Paging By default, any requests for lists are paged. The paging feature allows an entire list of objects to be retrieved by requesting pages of objects. A page may have 1-20 objects and the default value is 20. By using the ordering and paging features together, you may retrieve a large list of objects. https://api.seamgroup.com/en-US/2019.8.14.1/ProblemCompliance/1/20 Additional pages can be requested by varying the URL as shown below https://api.seamgroup.com/en-US/2019.8.14.1/ProblemCompliance/2/20 The above URL request will provide 20 objects on page 2. Requests for paged data can be made in any order, sequentially or in parallel, up to the request throttling limit. Filtering The scope of the data available through the ViewPoint API is at the company level, and cannot be further restricted to a specific region or site. If your intended use for the ViewPoint API includes integrations with decentralized systems where only a portion of the available data should be used, you can limit the data returned by using the ViewPoint API’s filtering feature. Filtering works like a “where” clause, and only the data which matches will be returned. Multiple filtering terms may be used, and only the data which matches all of the terms will be returned. https://api.seamgroup.com/en-US/2019.8.14.1/ProblemCompliance/1/20/?where=Repair.RepairStatus.IsClosed;eq;false&where=Inspection.Approved;eq;True Property Selection Depending on the data you require for your integration, you may wish to shape the data you retrieve from the ViewPoint API such that only properties that you require are returned. You can control which properties are included by using the property selection feature. https://api.seamgroup.com/en-US/2019.8.14.1/ProblemCompliance/1/20/?_properties=ID This is also useful if you wish to include one or more properties from related objects, without retrieving the entire related object. https://api.seamgroup.com/en-US/2019.8.14.1/ProblemCompliance/1/20/?_properties=ID,ProblemNumber AUTHENTICATION BEARERAUTH The ViewPoint API utilizes bearer tokens for access when working with most endpoints. An API-enabled ViewPoint account is required in order to acquire a token. This token has a limited lifetime and any integrations built to interact with the ViewPoint API should expect to have to periodically acquire a new access tokens. Only one token may be held at a time for any account. If a new token is requested, any existing token is automatically revoked. EXAMPLE TOKEN REQUEST Token requests use HTTP Basic Authentication, and the credentials to be used when making this request are your API-enabled ViewPoint account’s username and password. POST https://api.seamgroup.com/GetToken HTTP/1.1 Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ= Accept: application/json Accept-Encoding: gzip, deflate, br Accept-Language: en-US,en;q=0.9 Content-Type: application/x-www-form-urlencoded grant_type=password EXAMPLE TOKEN RESPONSE HTTP/1.1 200 OK Date: Thu, 25 Feb 2021 14:55:19 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 529 { "access_token":"Cw9fvTH_clX21or8....czcHdF46ZlO8", "token_type":"bearer", "expires_in":86399, ".issued":"Thu, 25 Feb 2021 14:55:19 GMT", ".expires":"Fri, 26 Feb 2021 14:55:19 GMT" } After acquiring a token, it may be used to authenticate all subsequent operations, until it has expired. API clients should cache and re-use this token for the duration of any multi-operation event, such as fetching details for a large list of problems. Security Scheme Type HTTP HTTP Authorization Scheme bearer PROBLEMCOMPLIANCE Represents a NEC/OSHA compliance problem /PROBLEMCOMPLIANCE Gets a list of compliance problems. By default, the first 20 problems are retrieved, with no specific order. It is recommended that you use the list ordering feature and the paging feature in order to retrieve the entire problem list. AUTHORIZATIONS: bearerAuth PATH PARAMETERS culture required string Enum: "en-US" "zh-CN" "de-DE" "es-MX" "fr-CA" "pl-PL" Culture for the request version required string Version of the API page required integer The page number itemsperpage required integer The number of items per page QUERY PARAMETERS _properties Array of strings Example: _properties=ID, ProblemNumber, Cause.Name Object properties to returned. For complete list of properties see the object schema in example below where Array of strings Example: where=Repair.RepairStatus.IsClosed, Inspection.Approved Filter data with where clause orderby Array of strings Example: orderby=Inspection.DateFieldWorkCompleted%20desc Sort data with object properties RESPONSES 200 OK 400 Check the format of your message 404 The specified resource was not found get/{culture}/{version}/ProblemCompliance/{page}/{itemsperpage} Production server https://api.seamgroup.com/{culture}/{version}/ProblemCompliance/{page}/{itemsperpage} RESPONSE SAMPLES * 200 Content type application/json Copy Expand all Collapse all [ * { * "ComplianceIssueType": { * "Name": "string" }, * "ID": "string", * "Inspection": { * "DateFieldWorkCompleted": "string", * "Site": { * "Name": "string", * "Street": "string", * "Street2": "string", * "City": "string", * "StateAbbreviation": "string", * "ZipCode": "string", * "Country": "string" } }, * "Notes": "string", * "Pictures": [ * { * "Address": "string", * "ID": "string" }, * { * "Address": "string", * "ID": "string" }, * { * "Address": "string", * "ID": "string" }, * { * "Address": "string", * "ID": "string" } ], * "ProblemNumber": "string", * "Recommendation": { * "Name": "string" }, * "Repair": { * "RepairStatus": { * "Name": "string" } }, * "Severity": { * "Name": "string" }, * "Train": { * "AssetTag": "string", * "EquipmentType": { * "Name": "string" }, * "Location": { * "Name": "string", * "Path": "string" }, * "Name": "string", * "QrCode": { * "QrCodeValue": "integer" } } } ] /PROBLEMCOMPLIANCE/{ID} Get a single compliance problem AUTHORIZATIONS: bearerAuth PATH PARAMETERS id required string Example: 19b90057-3f49-4a49-a3f8-dfa9c81db79b Problem ID culture required string Enum: "en-US" "zh-CN" "de-DE" "es-MX" "fr-CA" "pl-PL" Culture for the request version required string Version of the API QUERY PARAMETERS _properties Array of strings Example: _properties=ID, ProblemNumber, Cause.Name Object properties to returned. For complete list of properties see the object schema in example below RESPONSES 200 OK 400 Check the format of your message 404 The specified resource was not found get/{culture}/{version}/ProblemCompliance/{id} Production server https://api.seamgroup.com/{culture}/{version}/ProblemCompliance/{id} RESPONSE SAMPLES * 200 Content type application/json Copy Expand all Collapse all { * "ComplianceIssueType": { * "Name": "string" }, * "ID": "string", * "Inspection": { * "DateFieldWorkCompleted": "string", * "Site": { * "Name": "string", * "Street": "string", * "Street2": "string", * "City": "string", * "StateAbbreviation": "string", * "ZipCode": "string", * "Country": "string" } }, * "Notes": "string", * "Pictures": [ * { * "Address": "string", * "ID": "string" }, * { * "Address": "string", * "ID": "string" }, * { * "Address": "string", * "ID": "string" }, * { * "Address": "string", * "ID": "string" } ], * "ProblemNumber": "string", * "Recommendation": { * "Name": "string" }, * "Repair": { * "RepairStatus": { * "Name": "string" } }, * "Severity": { * "Name": "string" }, * "Train": { * "AssetTag": "string", * "EquipmentType": { * "Name": "string" }, * "Location": { * "Name": "string", * "Path": "string" }, * "Name": "string", * "QrCode": { * "QrCodeValue": "integer" } } } PROBLEMELECTRICAL Represents a thermal electrical problem /PROBLEMELECTRICAL List thermal electrical problems AUTHORIZATIONS: bearerAuth PATH PARAMETERS culture required string Enum: "en-US" "zh-CN" "de-DE" "es-MX" "fr-CA" "pl-PL" Culture for the request version required string Version of the API page required integer The page number itemsperpage required integer The number of items per page QUERY PARAMETERS _properties Array of strings Example: _properties=ID, ProblemNumber, Cause.Name Object properties to returned. For complete list of properties see the object schema in example below where Array of strings Example: where=Repair.RepairStatus.IsClosed, Inspection.Approved Filter data with where clause orderby Array of strings Example: orderby=Inspection.DateFieldWorkCompleted%20desc Sort data with object properties RESPONSES 200 OK 400 Check the format of your message 404 The specified resource was not found get/{culture}/{version}/ProblemElectrical/{page}/{itemsperpage} Production server https://api.seamgroup.com/{culture}/{version}/ProblemElectrical/{page}/{itemsperpage} RESPONSE SAMPLES * 200 Content type application/json Copy Expand all Collapse all [ * { * "AmbientTempFahrenheit": "integer", * "Cause": { * "Name": "string" }, * "ComponentTempFahrenheit": "integer", * "ID": "string", * "Inspection": { * "DateFieldWorkCompleted": "string", * "Site": { * "Name": "string", * "Street": "string", * "Street2": "string", * "City": "string", * "StateAbbreviation": "string", * "ZipCode": "string", * "Country": "string" } }, * "Notes": "string", * "Pictures": [ * { * "Address": "string", * "ID": "string" }, * { * "Address": "string", * "ID": "string" } ], * "ProblemNumber": "string", * "Recommendation": { * "Name": "string" }, * "Repair": { * "RepairStatus": { * "Name": "string" } }, * "Severity": { * "Name": "string" }, * "Train": { * "AssetTag": "string", * "EquipmentType": { * "Name": "string" }, * "Location": { * "Name": "string", * "Path": "string" }, * "Name": "string", * "QrCode": { * "QrCodeValue": "integer" } } } ] /PROBLEMELECTRICAL/{ID} Get a single thermal electrical problem AUTHORIZATIONS: bearerAuth PATH PARAMETERS id required string Example: 19b90057-3f49-4a49-a3f8-dfa9c81db79b Problem ID culture required string Enum: "en-US" "zh-CN" "de-DE" "es-MX" "fr-CA" "pl-PL" Culture for the request version required string Version of the API QUERY PARAMETERS _properties Array of strings Example: _properties=ID, ProblemNumber, Cause.Name Object properties to returned. For complete list of properties see the object schema in example below RESPONSES 200 OK 400 Check the format of your message 404 The specified resource was not found get/{culture}/{version}/ProblemElectrical/{id} Production server https://api.seamgroup.com/{culture}/{version}/ProblemElectrical/{id} RESPONSE SAMPLES * 200 Content type application/json Copy Expand all Collapse all { * "AmbientTempFahrenheit": "integer", * "Cause": { * "Name": "string" }, * "ComponentTempFahrenheit": "integer", * "ID": "string", * "Inspection": { * "DateFieldWorkCompleted": "string", * "Site": { * "Name": "string", * "Street": "string", * "Street2": "string", * "City": "string", * "StateAbbreviation": "string", * "ZipCode": "string", * "Country": "string" } }, * "Notes": "string", * "Pictures": [ * { * "Address": "string", * "ID": "string" }, * { * "Address": "string", * "ID": "string" } ], * "ProblemNumber": "string", * "Recommendation": { * "Name": "string" }, * "Repair": { * "RepairStatus": { * "Name": "string" } }, * "Severity": { * "Name": "string" }, * "Train": { * "AssetTag": "string", * "EquipmentType": { * "Name": "string" }, * "Location": { * "Name": "string", * "Path": "string" }, * "Name": "string", * "QrCode": { * "QrCodeValue": "integer" } } } PROBLEMGENERICTHERMAL Represents a Generic Thermal problem /PROBLEMGENERICTHERMAL Gets a list of generic thermal problems AUTHORIZATIONS: bearerAuth PATH PARAMETERS culture required string Enum: "en-US" "zh-CN" "de-DE" "es-MX" "fr-CA" "pl-PL" Culture for the request version required string Version of the API page required integer The page number itemsperpage required integer The number of items per page QUERY PARAMETERS _properties Array of strings Example: _properties=ID, ProblemNumber, Cause.Name Object properties to returned. For complete list of properties see the object schema in example below where Array of strings Example: where=Repair.RepairStatus.IsClosed, Inspection.Approved Filter data with where clause orderby Array of strings Example: orderby=Inspection.DateFieldWorkCompleted%20desc Sort data with object properties RESPONSES 200 OK 400 Check the format of your message 404 The specified resource was not found get/{culture}/{version}/ProblemGenericThermal/{page}/{itemsperpage} Production server https://api.seamgroup.com/{culture}/{version}/ProblemGenericThermal/{page}/{itemsperpage} RESPONSE SAMPLES * 200 Content type application/json Copy Expand all Collapse all [ * { * "Cause": { * "Name": "string" }, * "ID": "string", * "Inspection": { * "DateFieldWorkCompleted": "string", * "Site": { * "Name": "string", * "Street": "string", * "Street2": "string", * "City": "string", * "StateAbbreviation": "string", * "ZipCode": "string", * "Country": "string" } }, * "Notes": "string", * "Pictures": [ * { * "Address": "string", * "ID": "string" }, * { * "Address": "string", * "ID": "string" } ], * "ProblemNumber": "string", * "Recommendation": { * "Name": "string" }, * "Repair": { * "RepairStatus": { * "Name": "string" } }, * "Severity": { * "Name": "string" }, * "Train": { * "AssetTag": "string", * "EquipmentType": { * "Name": "string" }, * "Location": { * "Name": "string", * "Path": "string" }, * "Name": "string", * "QrCode": { * "QrCodeValue": "integer" } } } ] /PROBLEMGENERICTHERMAL/{ID} Gets a single generic thermal problem AUTHORIZATIONS: bearerAuth PATH PARAMETERS id required string Example: 19b90057-3f49-4a49-a3f8-dfa9c81db79b Problem ID culture required string Enum: "en-US" "zh-CN" "de-DE" "es-MX" "fr-CA" "pl-PL" Culture for the request version required string Version of the API QUERY PARAMETERS _properties Array of strings Example: _properties=ID, ProblemNumber, Cause.Name Object properties to returned. For complete list of properties see the object schema in example below RESPONSES 200 OK 400 Check the format of your message 404 The specified resource was not found get/{culture}/{version}/ProblemGenericThermal/{id} Production server https://api.seamgroup.com/{culture}/{version}/ProblemGenericThermal/{id} RESPONSE SAMPLES * 200 Content type application/json Copy Expand all Collapse all { * "Cause": { * "Name": "string" }, * "ID": "string", * "Inspection": { * "DateFieldWorkCompleted": "string", * "Site": { * "Name": "string", * "Street": "string", * "Street2": "string", * "City": "string", * "StateAbbreviation": "string", * "ZipCode": "string", * "Country": "string" } }, * "Notes": "string", * "Pictures": [ * { * "Address": "string", * "ID": "string" }, * { * "Address": "string", * "ID": "string" } ], * "ProblemNumber": "string", * "Recommendation": { * "Name": "string" }, * "Repair": { * "RepairStatus": { * "Name": "string" } }, * "Severity": { * "Name": "string" }, * "Train": { * "AssetTag": "string", * "EquipmentType": { * "Name": "string" }, * "Location": { * "Name": "string", * "Path": "string" }, * "Name": "string", * "QrCode": { * "QrCodeValue": "integer" } } } PICTURE Represents an inspection picture. /PICTURE/{ID} Gets a single inspection picture. To retrieve binary data, specify the type image/jpeg in your request's Accept HTTP header. AUTHORIZATIONS: bearerAuth PATH PARAMETERS id required string Example: 19b90057-3f49-4a49-a3f8-dfa9c81db79b Problem ID culture required string Enum: "en-US" "zh-CN" "de-DE" "es-MX" "fr-CA" "pl-PL" Culture for the request version required string Version of the API RESPONSES 200 OK 400 Check the format of your message 404 The specified resource was not found get/{culture}/{version}/Picture/{id} Production server https://api.seamgroup.com/{culture}/{version}/Picture/{id} REPAIR The repair record for a problem. This is created in conjunction with the problem and shares the same ID as the problem. The repair record contains the problem’s condition (e.g. Open, Repaired, etc.) /REPAIR/{ID} Gets the repair record for a problem AUTHORIZATIONS: bearerAuth PATH PARAMETERS id required string Example: 19b90057-3f49-4a49-a3f8-dfa9c81db79b Problem ID culture required string Enum: "en-US" "zh-CN" "de-DE" "es-MX" "fr-CA" "pl-PL" Culture for the request version required string Version of the API REQUEST BODY SCHEMA: APPLICATION/JSON RepairDate string <date-time> The date when the problem was repaired. RepairNotes string A description of the repair. Include a work order number or similar reference if available. RepairStatus object The state of the problem/repair. IsClosed is true if the repair is in a state that is considered to be closed; false otherwise. The values are Open, Scheduled, Deferred (these are considered open), Repaired, Out of Service and Closed (these are considered closed). When setting this value, only the ID is required. Repair Status: * ED5D4411-D45F-4931-B757-029E3483783B - Closed * 8D7B1374-F62B-41FC-834A-2DBC3CFB904A - Repaired, use this to repair a problem * 9B8C5C19-3428-401A-B551-597F976E034A- Scheduled * 31103A61-9015-4C2E-B312-5AE7ED0BA4CB- Deferred * 6FD2B743-EE84-4A68-9BEB-84B49EDF94B2- Open * BC067ECD-0368-400B-950E-CC3E121EC1FF- Out of service RepairedBy string <= 100 characters The name of the person who performed the repair. RESPONSES 200 OK 400 Check the format of your message 404 The specified resource was not found 405 Unsupported HTTP verb put/{culture}/{version}/Repair/{id} Production server https://api.seamgroup.com/{culture}/{version}/Repair/{id} REQUEST SAMPLES * Payload Content type application/json Copy Expand all Collapse all { * "RepairDate": "2019-08-24T14:15:22Z", * "RepairNotes": "string", * "RepairStatus": { * "Address": "string", * "ID": "string", * "Name": "string" }, * "RepairedBy": "string" } /REPAIR/{ID} Repair a problem AUTHORIZATIONS: bearerAuth PATH PARAMETERS id required string Example: 19b90057-3f49-4a49-a3f8-dfa9c81db79b Problem ID culture required string Enum: "en-US" "zh-CN" "de-DE" "es-MX" "fr-CA" "pl-PL" Culture for the request version required string Version of the API RESPONSES 200 OK 400 Check the format of your message 404 The specified resource was not found get/{culture}/{version}/Repair/{id} Production server https://api.seamgroup.com/{culture}/{version}/Repair/{id} RESPONSE SAMPLES * 200 Content type application/json Copy Expand all Collapse all { * "ID": "string", * "RepairDate": "string", * "RepairNotes": "string", * "RepairStatus": { * "Name": { * "type": "string" } }, * "RepairedBy": "string", * "Problem": { * "ID": "string", * "Name": "string" }, * "EnteredBy": "string" }