Last Updated: 1/9/2016 5:35:33 PM

/address

GET ListAddresses
1/9/2016 5:35:35 PM

Query Parameters

  • commaSeparatedIds List`1
[
  • {
    • "addressId": "Int32",
    • "addressLine1": "String",
    • "addressLine2" : "String",
    • "addressName": "String",
    • "city": "String",
    • "countryCode": "String",
    • "postalCode": "String",
    • "state" : "String"
    }
]

/address/{addressid}

GET GetAddress Returns the address for the given addressId
Returns the address for the given addressId
1/9/2016 5:35:35 PM

Query Parameters

  • addressId Int32
Address information
{
  • "addressId": "Int32",
  • "addressLine1": "String",
  • "addressLine2" : "String",
  • "addressName": "String",
  • "city": "String",
  • "countryCode": "String",
  • "postalCode": "String",
  • "state" : "String"
}
User does not have access to this address
"String"
Address with the given id does not exist
"String"

/address/find

GET FindAddresses
1/9/2016 5:35:34 PM

Query Parameters

[
  • {
    • "addressId": "Int32",
    • "addressLine1": "String",
    • "addressLine2" : "String",
    • "addressName": "String",
    • "city": "String",
    • "countryCode": "String",
    • "postalCode": "String",
    • "state" : "String"
    }
]

/car

POST AddCar
1/9/2016 5:35:36 PM

Request Body

{}
No response specified

/car/{carid}

GET GetCar Gets the car with the given Id
Gets the car with the given Id
1/9/2016 5:35:35 PM

Route Parameters

Car information
{}

/custom/route

??? EndpointWithCustomRoute This should have a route of "/custom/route"
This should have a route of "/custom/route"
1/9/2016 5:35:38 PM

Request Body

No request body
No response specified

/metadata

GET EndpointWithMetadata
1/9/2016 5:35:35 PM
No response specified

/person

GET ListPersons Lists all persons, optionally filtered by startsWith
Lists all persons, optionally filtered by startsWith
1/9/2016 5:35:34 PM

Query Parameters

[
  • {
    • "addresses": [
      • {
        • "addressId": "Int32",
        • "addressLine1": "String",
        • "addressLine2" : "String",
        • "addressName": "String",
        • "city": "String",
        • "countryCode": "String",
        • "postalCode": "String",
        • "state" : "String"
        }
      ],
    • "addresses2": [
      • {
        • "addressId": "Int32",
        • "addressLine1": "String",
        • "addressLine2" : "String",
        • "addressName": "String",
        • "city": "String",
        • "countryCode": "String",
        • "postalCode": "String",
        • "state" : "String"
        }
      ],
    • "addresses3": [
      • {
        • "addressId": "Int32",
        • "addressLine1": "String",
        • "addressLine2" : "String",
        • "addressName": "String",
        • "city": "String",
        • "countryCode": "String",
        • "postalCode": "String",
        • "state" : "String"
        }
      ],
    • "addresses4": [
      • {
        • "addressId": "Int32",
        • "addressLine1": "String",
        • "addressLine2" : "String",
        • "addressName": "String",
        • "city": "String",
        • "countryCode": "String",
        • "postalCode": "String",
        • "state" : "String"
        }
      ],
    • "emailAddress" : "String",
    • "firstName": "String",
    • "lastName": "String",
    • "nickName" : "String"
    }
]

/person/{emailaddress}

GET GetPerson Returns the person with the given email address
Returns the person with the given email address
1/9/2016 5:35:34 PM

Route Parameters

Person information
{
  • "addresses": [
    • {
      • "addressId": "Int32",
      • "addressLine1": "String",
      • "addressLine2" : "String",
      • "addressName": "String",
      • "city": "String",
      • "countryCode": "String",
      • "postalCode": "String",
      • "state" : "String"
      }
    ],
  • "addresses2": [
    • {
      • "addressId": "Int32",
      • "addressLine1": "String",
      • "addressLine2" : "String",
      • "addressName": "String",
      • "city": "String",
      • "countryCode": "String",
      • "postalCode": "String",
      • "state" : "String"
      }
    ],
  • "addresses3": [
    • {
      • "addressId": "Int32",
      • "addressLine1": "String",
      • "addressLine2" : "String",
      • "addressName": "String",
      • "city": "String",
      • "countryCode": "String",
      • "postalCode": "String",
      • "state" : "String"
      }
    ],
  • "addresses4": [
    • {
      • "addressId": "Int32",
      • "addressLine1": "String",
      • "addressLine2" : "String",
      • "addressName": "String",
      • "city": "String",
      • "countryCode": "String",
      • "postalCode": "String",
      • "state" : "String"
      }
    ],
  • "emailAddress" : "String",
  • "firstName": "String",
  • "lastName": "String",
  • "nickName" : "String"
}
Validation errors
[
  • "String"
]
User could not be found
"String"

/standardattributes/customresponsetype

GET CustomResponseType Response type should be an int
Response type should be an int
1/9/2016 5:35:36 PM
"Int32"
No response specified

/standardattributes/dontignoreendpoint

??? DontIgnoreEndpoint This should not be ignored
This should not be ignored
1/9/2016 5:35:36 PM

Request Body

No request body
No response specified
No response specified

/xmldocreturns/returnsendpoint

??? ReturnsEndpoint This returns an int
This returns an int
1/9/2016 5:35:40 PM

Request Body

No request body
Integer representing the blah blah
"Int32"

/xmldocreturns/voidendpoint

??? VoidEndpoint This should be 204 response
This should be 204 response
1/9/2016 5:35:39 PM

Request Body

No request body
No response specified

/xmldocumentationdescription/endpointdescription

GET EndpointDescription This is the XML description for an endpoint
This is the XML description for an endpoint
1/9/2016 5:35:37 PM
No response specified

/xmldocumentationdescription/parameterdescriptions

GET ParameterDescriptions
1/9/2016 5:35:37 PM

Query Parameters

No response specified

/xmldocumentationdescription/requestdescriptions

POST RequestDescriptions
1/9/2016 5:35:37 PM

Request Body

{
}
No response specified

/xmldocumentationdescription/responsedescriptions

GET ResponseDescriptions
1/9/2016 5:35:37 PM
{
}

/xmldocumentationexamples/endpointwithparameterexamples

??? EndpointWithParameterExamples
1/9/2016 5:35:39 PM

Request Body

"Int32"
No response specified

/xmldocumentationexclude/excludeparameter

GET ExcludeParameter Only param1 should be displayed
Only param1 should be displayed
1/9/2016 5:35:38 PM

Query Parameters

  • param1 Int32
No response specified

/xmldocumentationexclude/excluderequest

POST ExcludeRequest
1/9/2016 5:35:38 PM

Request Body

{
}
No response specified

/xmldocumentationexclude/excluderesponse

GET ExcludeResponse
1/9/2016 5:35:38 PM
{
}

/xmldocumentationoptional/endpointwithoptionalparameter

GET EndpointWithOptionalParameter Only isOptional should be optional
Only isOptional should be optional
1/9/2016 5:35:39 PM

Query Parameters

No response specified

/xmldocumentationoptional/endpointwithoptionalrequest

POST EndpointWithOptionalRequest
1/9/2016 5:35:39 PM

Request Body

{
}
No response specified