GET api/v1/addressbook/stoplog

This method returns a list of all addressbook phone numbers that have a stop log request against them or are invalid numbers. Note it will only give results for the loged in user and inherited contacts will not be included.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

ResponseOfAddressBookValidationResponse
NameDescriptionTypeAdditional information
Error

Error

None.

ResponseData

ResponseDataOfAddressBookValidationResponse

None.

Response Formats

application/json, text/json

Sample:
{
  "Error": {
    "ErrorCode": "sample string 1",
    "ErrorReason": "sample string 2"
  },
  "ResponseData": {
    "Identification": {
      "UserId": "sample string 1"
    },
    "Result": "sample string 1",
    "Detail": {
      "TotalNumbersChecked": 1,
      "TotalNumbersFound": 2,
      "Addressbookdetails": [
        {
          "PersonNo": "sample string 1",
          "FirstName": "sample string 2",
          "LastName": "sample string 3",
          "EmailAddress": "sample string 4",
          "MobileNumber": "sample string 5",
          "Result": {
            "ShortCode": "sample string 3",
            "Reason": "sample string 4",
            "DateSubmitted": "sample str"
          }
        },
        {
          "PersonNo": "sample string 1",
          "FirstName": "sample string 2",
          "LastName": "sample string 3",
          "EmailAddress": "sample string 4",
          "MobileNumber": "sample string 5",
          "Result": {
            "ShortCode": "sample string 3",
            "Reason": "sample string 4",
            "DateSubmitted": "sample str"
          }
        }
      ]
    }
  }
}

application/xml, text/xml

Sample:
<ResponseOfAddressBookValidationResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <ErrorCode>sample string 1</ErrorCode>
    <ErrorReason>sample string 2</ErrorReason>
  </Error>
  <ResponseData>
    <Result>sample string 1</Result>
    <Identification>
      <UserId>sample string 1</UserId>
    </Identification>
    <Detail>
      <TotalNumbersChecked>1</TotalNumbersChecked>
      <TotalNumbersFound>2</TotalNumbersFound>
      <Addressbookdetails>
        <AddressBookStopLogSearch>
          <PersonNo>sample string 1</PersonNo>
          <FirstName>sample string 2</FirstName>
          <LastName>sample string 3</LastName>
          <EmailAddress>sample string 4</EmailAddress>
          <MobileNumber>sample string 5</MobileNumber>
          <Result>
            <ToBeRemoved>true</ToBeRemoved>
            <OptOut>sample string 2</OptOut>
            <ShortCode>sample string 3</ShortCode>
            <Reason>sample string 4</Reason>
            <DateSubmitted>sample str</DateSubmitted>
          </Result>
        </AddressBookStopLogSearch>
        <AddressBookStopLogSearch>
          <PersonNo>sample string 1</PersonNo>
          <FirstName>sample string 2</FirstName>
          <LastName>sample string 3</LastName>
          <EmailAddress>sample string 4</EmailAddress>
          <MobileNumber>sample string 5</MobileNumber>
          <Result>
            <ToBeRemoved>true</ToBeRemoved>
            <OptOut>sample string 2</OptOut>
            <ShortCode>sample string 3</ShortCode>
            <Reason>sample string 4</Reason>
            <DateSubmitted>sample str</DateSubmitted>
          </Result>
        </AddressBookStopLogSearch>
      </Addressbookdetails>
    </Detail>
  </ResponseData>
</ResponseOfAddressBookValidationResponse>