GET api/documents?ns={ns}&type={type}&isglobal={isglobal}&showunpublished={showunpublished}&force={force}
API call to retrieve National Society documents Has 2 optional parameters (ns, type) but also both can be used at the same time.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| ns |
Parameter is optional. If parameter is not set call will retrieve all National Societies data. Supports single and multiple NS codes. Examlples 'api/documents?ns=DAD001' or 'api/documents?ns=DAD001,DAL001,...' |
string |
Default value is |
| type |
Parameter is optional. If parameter is not set call will retrieve all type of documents. Supports single and multiple NS codes. Examlples 'api/documents?type=Our Annual Report' or 'api/documents?type=Our Annual Report,Other,...' |
string |
Default value is |
| isglobal |
Parameter is optional. If parameter is not set call will retrieve all not global documents. |
boolean |
Default value is False |
| showunpublished |
If shows unpublished documents |
boolean |
Default value is False |
| force | boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |