See below for a list of Resources and Actions you can perform with this API.
There is a simple test interface available.
All resources can be accessed at /api/uwapi/(resourcename)
For example, if you are dealing with a resource named Person, you could retrieve a list of Person by submitting a GET to /api/uwapi/person or the Person with ID 173 by submitting a GET to /api/uwapi/person/173
Additional parameters such as search terms for GET requests must be passed through the querystring. i.e. /api/uwapi/person?SearchTerm=fred
This API supports XML and JSON. It will return data in the format specified by the request's Content-Type HTTP header. The default is JSON.
For PUT and POST requests, the request's data must match the request's Content-Type.
| Action | Verb to Use | ID Required in URL? |
|---|---|---|
| Read | GET | Yes |
| Read All / Search | GET | No |
| Insert / Create | PUT | No |
| Update | POST | Yes |
| Delete | DELETE | Yes |
Parameters marked as Required [not null] must be provided and cannot be null or empty.
Parameters marked as Required must be provided but can be null or empty.
Parameters marked as [not null] are optional but cannot be null or empty.
When you create a new record, the ID (or primary key) for the new record will be available in the Status Text of the response (generally a HTTP 201).
You can also look at the Location header in the HTTP Response. though the GetByID may not be implemented for all resources, the ID will be correct at the end of the URL. (i.e. /api/uwapi/member/20280 )
Unless otherwise specified in the Resource or Action documentation, dates are in UTC.
Generally this means about the only exception is Event Start/End Dates, which are the client's local time.
Most date formats should work. We recommend dd-mmm-yyyy, yyyy-mm-dd hh:mm:ss, or some other unambiguous format for best results. See below for some examples.
| String | Resulting Date |
|---|---|
| 2013-03-05 | March 5, 2013 |
| Jan 06, 2017 | January 6, 2017 |
| 04/05/07 | April 5, 2007 |
| 04/05/07 07:03 | April 5, 2007 7:03 AM |
| 04/05/07 07:03 PM | April 5, 2007 7:03 PM |
| 04/05/07 19:03 | April 5, 2007 7:03 PM |
When saving data, any value not passed in will be ignored (left as is) in the database.
If you want to set a value to NULL in the database, you need to pass an empty string for that value.
Booleans can not be saved as NULL.
You may pass uwReasonInBody=true in the querystring to have the HTTP Reason Phrase included as a field within the Response Body.
For GET, POST and DELETE requests, this only applies to HTTP Status Codes indicating errors ( <200 or >=300 ).
For PUT requests, it applies to all HTTP Status Codes so that the new ID is accessible when applicable.
You may pass uwReturnEmpty=true in the querystring to any GET request. If provided, and your request would otherwise return no data, the API will return a single object with all fields set to NULL. The default is false.
This may be useful when using the API to populate a dropdown or grid where you wish to always have data returned.
All Documents/Files parameters in Requests must be Base64-encoded strings. All Documents/Files provided as fields in Responses will be returned as Base64-encoded strings.
You can click on each resource name to see what methods and parameters are provided.
Any action (GET ONE, GET MANY, INSERT, UPDATE, DELETE) not explicitly listed below is not permitted for the Affiliate resource.
Parameters must be passed in the querystring for this action.
Parameters (other than the primary key / ID: AffiliateID) must be passed in the querystring for this action.
Parameters (other than the primary key / ID: AffiliateID) must be passed in the body of the request for this action.
Any action (GET ONE, GET MANY, INSERT, UPDATE, DELETE) not explicitly listed below is not permitted for the AvailableEvents resource.
The app passes PersonID to the API and the API will return a list of events that are available for that member, as well as events that are registered by that member. The events returned will be the same events listed in memberlink for that member.
Parameters must be passed in the querystring for this action.
Any action (GET ONE, GET MANY, INSERT, UPDATE, DELETE) not explicitly listed below is not permitted for the AvailableForms resource.
The app passes PersonID to the API and the API will return a list of forms that are available for that member, as well as events that are registered by that member.
Members with a current job in Affiliate 52 can see the UPSC Staffing Objection form.
Members with a current job in any other Affiliate can see the UNAC Staffing Objection form.
Parameters must be passed in the querystring for this action.
Any action (GET ONE, GET MANY, INSERT, UPDATE, DELETE) not explicitly listed below is not permitted for the CheckResetPasswordCode resource.
If the User Name matches a Member's MemberLink Account in UnionWare, and the Reset Code matches a code generated for that account within the last two hours, returns a success code.
Parameters must be passed in the body of the request for this action.
Any action (GET ONE, GET MANY, INSERT, UPDATE, DELETE) not explicitly listed below is not permitted for the Classification resource.
Parameters must be passed in the querystring for this action.
Parameters (other than the primary key / ID: ClassificationID) must be passed in the querystring for this action.
Parameters (other than the primary key / ID: ClassificationID) must be passed in the body of the request for this action.
Any action (GET ONE, GET MANY, INSERT, UPDATE, DELETE) not explicitly listed below is not permitted for the Department resource.
Parameters must be passed in the querystring for this action.
Parameters (other than the primary key / ID: DepartmentID) must be passed in the querystring for this action.
Parameters (other than the primary key / ID: DepartmentID) must be passed in the body of the request for this action.
Any action (GET ONE, GET MANY, INSERT, UPDATE, DELETE) not explicitly listed below is not permitted for the Event resource.
Parameters must be passed in the querystring for this action.
Any action (GET ONE, GET MANY, INSERT, UPDATE, DELETE) not explicitly listed below is not permitted for the EventRegistrationLink resource.
The app tells the API which event the member wants to register for. The app is also forced here to pass the user name and password to authenticate the member’s credentials. The API will generate a URL containing a Token parameter that will automatically login the user and redirect them to the Event Registration page of the passed in event. The token expires after ten minutes.
Parameters must be passed in the querystring for this action.
Any action (GET ONE, GET MANY, INSERT, UPDATE, DELETE) not explicitly listed below is not permitted for the EventRegistrationStaff resource.
Parameters must be passed in the querystring for this action.
Any action (GET ONE, GET MANY, INSERT, UPDATE, DELETE) not explicitly listed below is not permitted for the EventRegistrationWaitingList resource.
Parameters must be passed in the querystring for this action.
Any action (GET ONE, GET MANY, INSERT, UPDATE, DELETE) not explicitly listed below is not permitted for the EventSession resource.
Parameters must be passed in the querystring for this action.
Parameters (other than the primary key / ID: EventSessionID) must be passed in the body of the request for this action.
Any action (GET ONE, GET MANY, INSERT, UPDATE, DELETE) not explicitly listed below is not permitted for the EventSessionRegistration resource.
Parameters must be passed in the querystring for this action.
Any action (GET ONE, GET MANY, INSERT, UPDATE, DELETE) not explicitly listed below is not permitted for the EventSessionRegistrationStaff resource.
Parameters must be passed in the querystring for this action.
Any action (GET ONE, GET MANY, INSERT, UPDATE, DELETE) not explicitly listed below is not permitted for the EventSessionRegistrationWaitingList resource.
Parameters must be passed in the querystring for this action.
Any action (GET ONE, GET MANY, INSERT, UPDATE, DELETE) not explicitly listed below is not permitted for the ForgotPassword resource.
If these values match a user account in UnionWare an email is sent to the specified email with a six digit code for resetting the password.
Parameters must be passed in the body of the request for this action.
Any action (GET ONE, GET MANY, INSERT, UPDATE, DELETE) not explicitly listed below is not permitted for the ForgotUsername resource.
If these values match an existing member in UnionWare an email is sent to the specified email address with the Username of the account included.
Parameters must be passed in the body of the request for this action.
Any action (GET ONE, GET MANY, INSERT, UPDATE, DELETE) not explicitly listed below is not permitted for the FormLink resource.
The app passes to the API a Form ID, Username, and password to authenticate the member’s credentials. The API will generate a URL for passed in Form ID. The API will generate a URL containing a Token parameter that will automatically login the user and redirect them to the Form page. The token expires after ten minutes.
Parameters must be passed in the querystring for this action.
Any action (GET ONE, GET MANY, INSERT, UPDATE, DELETE) not explicitly listed below is not permitted for the Login resource.
Parameters must be passed in the querystring for this action.
Any action (GET ONE, GET MANY, INSERT, UPDATE, DELETE) not explicitly listed below is not permitted for the Member resource.
Parameters must be passed in the querystring for this action.
Parameters (other than the primary key / ID: PersonID) must be passed in the querystring for this action.
Parameters (other than the primary key / ID: PersonID) must be passed in the body of the request for this action.
Any action (GET ONE, GET MANY, INSERT, UPDATE, DELETE) not explicitly listed below is not permitted for the MemberAddress resource.
Parameters must be passed in the querystring for this action.
Parameters must be passed in the body of the request for this action.
Parameters (other than the primary key / ID: AddressID) must be passed in the body of the request for this action.
Any action (GET ONE, GET MANY, INSERT, UPDATE, DELETE) not explicitly listed below is not permitted for the MemberJob resource.
Parameters must be passed in the querystring for this action.
Parameters (other than the primary key / ID: JobID) must be passed in the body of the request for this action.
Any action (GET ONE, GET MANY, INSERT, UPDATE, DELETE) not explicitly listed below is not permitted for the MemberNote resource.
Parameters must be passed in the querystring for this action.
Parameters must be passed in the body of the request for this action.
Parameters (other than the primary key / ID: NoteID) must be passed in the body of the request for this action.
Any action (GET ONE, GET MANY, INSERT, UPDATE, DELETE) not explicitly listed below is not permitted for the MemberPhoneEmail resource.
Parameters must be passed in the querystring for this action.
Parameters must be passed in the body of the request for this action.
Parameters (other than the primary key / ID: PhoneEmailID) must be passed in the body of the request for this action.
Any action (GET ONE, GET MANY, INSERT, UPDATE, DELETE) not explicitly listed below is not permitted for the Register resource.
Register for Memberlink
Parameters must be passed in the body of the request for this action.
Any action (GET ONE, GET MANY, INSERT, UPDATE, DELETE) not explicitly listed below is not permitted for the ResetPassword resource.
If the username matches a Member’s account and the reset code matches a code generated for that account in the last two hours, sets the Member’s password to the New Password parameter.
Parameters must be passed in the body of the request for this action.
Any action (GET ONE, GET MANY, INSERT, UPDATE, DELETE) not explicitly listed below is not permitted for the Unit resource.
Parameters must be passed in the querystring for this action.
Parameters (other than the primary key / ID: UnitID) must be passed in the querystring for this action.
Parameters (other than the primary key / ID: UnitID) must be passed in the body of the request for this action.
Any action (GET ONE, GET MANY, INSERT, UPDATE, DELETE) not explicitly listed below is not permitted for the WorkLocation resource.
Parameters must be passed in the querystring for this action.
Parameters (other than the primary key / ID: WorkLocationID) must be passed in the querystring for this action.
Parameters (other than the primary key / ID: WorkLocationID) must be passed in the body of the request for this action.
Below is a list of the various HTTP Status Codes and Reason Phrases that this API will return and what it means. Status codes and descriptions unique to your implementation may not be listed below.
The terms in italics below (i.e. ResourceName or ID) refer to the values provided in the request.
With GET, obviously some status codes below only apply when passing (or not passing) an ID.
If you consistently get 403 errors, check that you are authenticating correctly.
If you consistently get 404 errors, refer to the URL Structure section of this document to make sure you are using the right URLs.
| Verb | Status Code | Reason Phrase | Explanation |
|---|---|---|---|
| GET, DELETE | 200 | OK | The action was successfully completed. |
| PUT | 201 | Created | Resource was successfully created. The response, if set, will generally contain the ID of the new resource. |
| POST, DELETE | 204 | nocontent | The action was successfully completed. |
| GET, POST, DELETE | 404 | No 'ResourceName' found for ID ID. - Details: ResourceName is not a valid resource. | The resource by that name does not exist. |
| GET, POST, DELETE | 404 | 'Action' is not a valid request for Resource ResourceName | The specified action is not permitted for the specified resource. |
| POST | 404 | No HTTP resource was found that matches the request URI '(url)' | For POST, the ID (primary key) needs to be passed as part of the URL itself, not as part of the request body or querystring. |
| GET, POST, DELETE | 400 | No 'ResourceName' found for ID ID | The resource name is correct, but there is no resource at that ID. You can configure this behavior for GET requests. See the Returning Empty Sets section of this document. |
| GET | 400 | No 'ResourceName' found. | The resource name is correct, but your query returned no resources. You can configure this behavior. See the Returning Empty Sets section of this document. |
| GET, POST, DELETE | 400 | The ID ID is not numeric. | When specifying an ID as part of the URL, it must be an integer. |
| GET | 400 | ### 'ResourceName' results found for ID: ID | The specified ID did not uniquely identify a record. The Reason Phrase will detail how many records were found. |
| PUT,POST | 400 | Request content was NULL and must be provided for PUT and POST operations. | The Request submitted contained no content - PUT and POST operations require XML or JSON data to be submitted within the request body. |
| PUT,POST | 400 | Could not parse the provided XML content. Details: (exception details) | The XML provided in the request content is not valid. If you intended JSON, make sure you set the Content-Type appropriately. |
| PUT,POST | 400 | Could not parse the provided JSON content. Details: (exception details) | The JSON provided in the request content is not valid. If you intended XML, make sure you set the Content-Type appropriately. |
| (all) | 400 | ParameterName must be provided and have a value specified. | The specified parameter is required and cannot be null or empty. The ID must be in the URL. For GET requests, additional parameters must be provided through the querystring. For all other requests, additional parameters must be provided through the request content. |
| (all) | 400 | ParameterName must be provided. | The specified parameter is required. The ID must be in the URL. For GET requests, additional parameters must be provided through the querystring. For all other requests, additional parameters must be provided through the request content. |
| (all) | 400 | ParameterName must have a value specified when provided. | The specified parameter is NOT required but cannot be null or empty if provided. The ID must be in the URL. For GET requests, additional parameters must be provided through the querystring. For all other requests, additional parameters must be provided through the request content. |
| (all) | 400 | ParameterName is not a valid DataType. | The specified parameter contains invalid data. |
| (all) | 500 | An unhandled error occurred. Exception was (exception details) | An error occurred on the server. If the exception details are not helpful, check your request and try again in a few minutes. If the issue persists you may need to contact us. |
| (all) | 500 | UnionWare Database Failure | A significant error occurred on the server. Check your request and try again in a few minutes. If the issue persists you should contact us. |