| POST | /api/partners/{PartnerGuid}/collectionaccess/{CollectionGuid} | Add a new partner collection relationship for the entities identified by the PartnerGuid and the CollectionGuid parameters. | Creating an access record that already exists will result in an error. If the record is the first one created for a Partner on a Site, IsDefaultCollectionForSite will default to true. If IsDefaultCollectionForSite is set to true, it will reset any other Collections that were previously set as Default for the Site. This parameter is not valid for DELETE operations. |
|---|---|---|---|
| PUT | /api/partners/{PartnerGuid}/collectionaccess/{CollectionGuid} | Update partner collection relationship for the entities identified by the PartnerGuid and the CollectionGuid parameters. | If the specified access record does not exist an error will be thrown. |
| DELETE | /api/partners/{PartnerGuid}/collectionaccess/{CollectionGuid} | Remove the partner collection relationship for the entities identified by the PartnerGuid and the CollectionGuid parameters. | If the specified access record does not exist an error will be thrown. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PartnerGuid | path | Guid | Yes | |
| CollectionGuid | path | Guid | Yes | |
| IsDefaultCollectionForSite | body | Boolean | No | Not valid on DELETE. Allowable Values
|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/partners/{PartnerGuid}/collectionaccess/{CollectionGuid} HTTP/1.1
Host: api.secure-messaging.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{
"partnerGuid": "00000000000000000000000000000000",
"collectionGuid": "00000000000000000000000000000000",
"isDefaultCollectionForSite": false
}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{
"responseStatus": {
"errorCode": "String",
"message": "String",
"stackTrace": "String",
"errors": [
{
"errorCode": "String",
"fieldName": "String",
"message": "String",
"meta": {
"String": "String"
}
}
],
"meta": {
"String": "String"
}
}
}