AttachmentEndpoint
The following resources are applicable:
- /attachment/allow/msisdns
- /attachment/create
- /attachment/part/add
- /attachment/part/uploaded
- /attachment/parts/get
/attachment/allow/msisdns
Mount Point: /rest/attachment/allow/msisdns
POST
Adds allowed msisdn's who has read access to the attachment
Error Codes
| 2 | A required parameter was not given |
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 100 | The auth token is invalid |
| 600 | The api key is invalid |
| 800 | The attachment key is invalid |
Request Body
| element: | attachmentAllowMsisdnsRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | attachmentAllowMsisdnsResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/attachment/create
Mount Point: /rest/attachment/create
POST
Create an attachment key
Error Codes
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 100 | The auth token is invalid |
| 600 | The api key is invalid |
Request Body
| element: | attachmentCreateRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | attachmentCreateResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/attachment/part/add
Mount Point: /rest/attachment/part/add
POST
Adds an attachment part.
The response will include the necessary information to upload the files to amazon s3.
Example html snippet for a file upload to amazon s3:
<form action="https://{s3.bucketName}.s3.amazonaws.com/" method="post" enctype="multipart/form-data">
<input type="hidden" name="AWSAccessKeyId" value="{s3.awsAccessKeyId}" />
<input type="hidden" name="key" value="{s3.key}" />
<input type="hidden" name="acl" value="{s3.acl}" />
<input type="hidden" name="policy" value="{s3.policy}" />
<input type="hidden" name="signature" value="{s3.signature}" />
<input type="hidden" name="Content-Type" value="{s3.contentType}" />
<input type="hidden" name="Content-Disposition" value="{s3.contentDiposition}" />
<input type="hidden" name="x-amz-storage-class" value="{s3.storageClass}" />
<input name="file" type="file" />
<input type="submit" value="Upload File to S3" />
</form>
After successful upload the part have to be marked uploaded.
Error Codes
| 2 | A required parameter was not given |
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 100 | The auth token is invalid |
| 600 | The api key is invalid |
| 800 | The attachment key is invalid |
| 802 | The attachment type id don't support previews |
| 803 | The attachment type id is invalid |
Request Body
| element: | attachmentAddPartRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | attachmentAddPartResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/attachment/part/uploaded
Mount Point: /rest/attachment/part/uploaded
POST
Marks a attachment part uploaded.
Error Codes
| 2 | A required parameter was not given |
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 100 | The auth token is invalid |
| 600 | The api key is invalid |
Request Body
| element: | attachmentUploadedPartRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | attachmentUploadedPartResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/attachment/parts/get
Mount Point: /rest/attachment/parts/get
POST
Get all attachment parts.
Error Codes
| 2 | A required parameter was not given |
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 100 | The auth token is invalid |
| 600 | The api key is invalid |
| 800 | The attachment key is invalid |
| 801 | The access to attachment was blocked because of wrong credentials or disabled anonymous access |
Request Body
| element: | attachmentGetPartsRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | attachmentGetPartsResponse |
| media types: | */* application/xml application/json |
(no documentation provided)