Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Yardi Service Requests API

Operations for creating and managing maintenance work orders and service requests. Accessed via the ItfServiceRequests web service interface.

Yardi Service Requests API is one of 12 APIs that Yardi publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Service Requests. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a getting-started guide, and an API reference.

This API exposes 2 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 20.0.

Requests are made against a single base URL, https://{server}.yardi.com/{clientUrl}/webservices.

2 operations 2 paths 4 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
20.0
Base URL
https://api.yardi.com
Authentication
HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 1

Yardi Service Requests API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (soapAuth). By default, every request must be authenticated.

  • soapAuth — SOAP authentication using UserName, Password, and ServerName parameters passed within the SOAP request body. Credentials are provided by the Yardi Standard Int…

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.

Service Requests 2

Operations for creating and managing maintenance work orders and service requests. Accessed via the ItfServiceRequests web service interface.

POST
/ItfServiceRequests.asmx/GetServiceRequests_Login
Yardi Get service requests
getServiceRequestsLogin body → 200401500
POST
/ItfServiceRequests.asmx/ImportServiceRequests_Login
Yardi Import service requests
importServiceRequestsLogin body → 200401500

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are GetServiceRequestsRequest (10 properties), ImportServiceRequestsRequest (9 properties), ImportResponse (2 properties), ServiceRequestsResponse (1 property). Each schema is shown below with its type and property counts.

GetServiceRequestsRequest
object
SOAP request for retrieving service requests and work orders.
10 properties 8 required
ServiceRequestsResponse
object
SOAP response containing service request and work order data.
1 property
ImportResponse
object
SOAP response confirming successful import of data.
2 properties
ImportServiceRequestsRequest
object
SOAP request for creating or updating service requests in Voyager.
9 properties 9 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yardi-service-requests-api-openapi.yml Raw ↑

Other APIs Yardi publishes across the network.

Yardi Voyager Commercial Data API
Yardi RENTCafe API
Yardi Maintenance IQ API
Yardi Investment Manager API
Yardi Store Web Services API
Yardi Kube API
Yardi Senior Living EHR API
Yardi Billing and Payments API
Yardi Common Data API
Yardi Job Cost API
Yardi Vendor Invoicing API