The addDocument service allows you to create documents for members whose agreements are currently in a queue.
Documents added with the addDocument service can be accessed in DataTrak via the Employee Agreement links for agreements listed on the Agreements page.
For the document to be uploaded, the following must be true:
| service type | SOAP |
| service name | Agreements |
| operation | addDocument |
| required request parameters |
|
The request has the following parameter hierarchy:
| Parameter Name | Required? | Format | Parent Parameter | Description |
|---|---|---|---|---|
| club | Y | club number | The ABC-provided club number. | |
| agreementNumber | Y | nine-digit agreement number | The agreement number for the membership agreement, beginning with the four-digit club number. | |
| documentType | Y | string | The documentType value must be "PDF" (all capitals). | |
| document | Y | base64 | The document value must be a base64-encoded PDF file between 1000 and 1000000 bytes. |
The return data is included inside return parameters in the body of the response.
The data has the following parameter hierarchy:
| Parameter Name | Contents | Parent Parameter | Description |
|---|---|---|---|
| club | club number | The number for the club that has the new agreement. | |
| agreementNumber | agreement number | The agreement number for the membership agreement, beginning with the four-digit club number. | |
| documentId | document id number | The id number for the newly created document. | |
| message |