GET | /countries | Get all valid countries | Get all valid countries. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | query | string | No | Id of the country |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | query | int | No | Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging. Example: ?skip=10&orderBy=Id |
Take | query | int | No | Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging. Example: ?take=20 |
OrderBy | query | string | No | Comma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field. Example: ?orderBy=Id,-Age,FirstName |
OrderByDesc | query | string | No | Comma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field. Example: ?orderByDesc=Id,-Age,FirstName |
Include | query | string | No | Include any of the aggregates AVG, COUNT, FIRST, LAST, MAX, MIN, SUM in your result set. The results will be returned in the meta field.Example: ?include=COUNT(*) as Total or multiple fields with ?include=Count(*) Total, Min(Age), AVG(Age) AverageAge or unique with ?include=COUNT(DISTINCT LivingStatus) as UniqueStatus |
Fields | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CurrencyId | form | string | No | |
CurrencyInfo | form | Currency | No | |
Name | form | string | Yes | |
Culture | form | string | No | |
TimeZone | form | string | No | |
ModifiedDate | form | DateTimeOffset? | No | |
Id | form | string | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | Yes | |
CurrencySign | form | string | Yes | |
Active | form | bool | Yes | |
ModifiedDate | form | DateTimeOffset? | No | |
Id | form | string | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Name | form | string | No | |
Description | form | string | No | |
ResponseStatus | form | ResponseStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<AccessKeyTypeResponse> | No | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
KeyType | form | string | No | |
Description | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /countries HTTP/1.1 Host: api.bokamera.se Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <QueryResponseOfCountryQueryResponseWg5EthtI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types"> <Offset>0</Offset> <Total>0</Total> <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos"> <d2p1:CountryQueryResponse> <d2p1:Description>String</d2p1:Description> <d2p1:Id>String</d2p1:Id> <d2p1:Name>String</d2p1:Name> <d2p1:ResponseStatus> <ErrorCode>String</ErrorCode> <Message>String</Message> <StackTrace>String</StackTrace> <Errors> <ResponseError> <ErrorCode>String</ErrorCode> <FieldName>String</FieldName> <Message>String</Message> <Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d7p1:KeyValueOfstringstring> <d7p1:Key>String</d7p1:Key> <d7p1:Value>String</d7p1:Value> </d7p1:KeyValueOfstringstring> </Meta> </ResponseError> </Errors> <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </Meta> </d2p1:ResponseStatus> </d2p1:CountryQueryResponse> </Results> <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfstringstring> <d2p1:Key>String</d2p1:Key> <d2p1:Value>String</d2p1:Value> </d2p1:KeyValueOfstringstring> </Meta> <ResponseStatus> <ErrorCode>String</ErrorCode> <Message>String</Message> <StackTrace>String</StackTrace> <Errors> <ResponseError> <ErrorCode>String</ErrorCode> <FieldName>String</FieldName> <Message>String</Message> <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </Meta> </ResponseError> </Errors> <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </Meta> </ResponseStatus> </QueryResponseOfCountryQueryResponseWg5EthtI>