Getting started
Once you have installed the package, you're able to use the API client in any .NET Core or .NET Framework application.
Conventions
All methods exposed by the API client make asynchronous calls to the API. Typically any query method will simply return the object that is returned by the API. This may be null if the object requested either doesn't exist or isn't allowed to be accessed by the currently configured API Client.
Any method that makes a command will be structured as a Request/Response pattern. The request object will be passed to
the
method and the response object will be returned. The response object will
implement IApiResponse and will contain an IsSuccess property to
determine whether the operation was successful or not. If the operation was not successful, the response object will
also contain an ErrorResponse object that will contain
further details about what went wrong. This will typically be a validation or authentication issue, and you should
handle it appropriately.
Depending on the method, the response object may also contain the object that was created or updated by the command. For
example the CreateCustomerResponse
contains a CustomerId property when the customer is created successfully.
High level workflows
Refer a property
You will need to do the following to refer a property:
- Register the customer (i.e. the vendor) with Pattinson - Guide
- Ensure the referring user exists in the Pattinson system - Guide
- Refer the property with reference to the customer and the referring user - Guide
Manage property images
Using the property id returned from the refer property call, you can manage the images for the property. This includes: